Skip to main content

APIKeyCreateResponse

idstringrequired
namestringrequired
environmentstringrequired

Possible values: [live, test]

permissionsPermissionGrant[]required

Possible values: Value must match regular expression ^(\*|[a-z][a-z-]*(:[a-z-]+)?(:domain:[A-Za-z0-9.-]{1,253})?)$

tokenstringrequired

The full API key token. It is shown only once, so store it securely.

token_hintstringrequired

Last 8 characters for future identification.

whitelist_ipsstring[]
created_atstring<date-time>required
expires_atstring<date-time>nullable
APIKeyCreateResponse
{
"id": "string",
"name": "string",
"environment": "live",
"permissions": [
"string"
],
"token": "string",
"token_hint": "string",
"whitelist_ips": [
"string"
],
"created_at": "2024-07-29T15:51:28.071Z",
"expires_at": "2024-07-29T15:51:28.071Z"
}