Skip to main content

APIKeyResponse

idstringrequired

Unique API key identifier.

namestringrequired

Human-readable name for this key.

environmentstringrequired

Key environment, live or test.

Possible values: [live, test]

permissionsPermissionGrant[]required

Permission scopes granted to this key.

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

token_hintstringrequired

Masked token display, e.g. tix_live_...abcd1234

whitelist_ipsstring[]

Allowed IP addresses in CIDR notation.

created_atstring<date-time>required

When the key was created.

expires_atstring<date-time>nullable

When the key expires.

last_used_atstring<date-time>nullable

When the key was last used.

last_used_ipstringnullable

IP address of the last request using this key.

request_countinteger<int64>

Total number of requests made with this key.

APIKeyResponse
{
"id": "string",
"name": "string",
"environment": "live",
"permissions": [
"string"
],
"token_hint": "string",
"whitelist_ips": [
"string"
],
"created_at": "2024-07-29T15:51:28.071Z",
"expires_at": "2024-07-29T15:51:28.071Z",
"last_used_at": "2024-07-29T15:51:28.071Z",
"last_used_ip": "string",
"request_count": 0
}