Skip to main content

APIKeyCreateRequest

namestringrequired

Human-readable name for this key.

environmentstring

Key environment.

Possible values: [live, test]

Default value: live
expires_atstring<date-time>required

When the key should expire.

whitelist_ipsstring[]

Allowed IP addresses in CIDR notation.

permissionsPermissionGrant[]

Permission scopes. Defaults to ["*"] (full access) if omitted.

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

APIKeyCreateRequest
{
"name": "string",
"environment": "live",
"expires_at": "2024-07-29T15:51:28.071Z",
"whitelist_ips": [
"string"
],
"permissions": [
"string"
]
}