v1

latestOpenAPI 3.1.02026-08-04272636.0 KB

api-keys

Create Api Key

Create a new API key.

post/v1/api-keys

authorizationstring nullable

customer_idstring required

Customer ID the key is scoped to

namestring required

Friendly name for the API key

descriptionstring nullable

Optional description

scope'read_only'

API key access scope - ALL KEYS ARE READ-ONLY

expires_daysinteger nullable

Number of days until expiration (None = no expiration)

Successful Response

idstring required

customer_idstring required

namestring required

descriptionstring nullable required

scopestring required

statusstring required

created_atstring date-time required

expires_atstring date-time nullable required

last_used_atstring date-time nullable required

api_keystring nullable