Skip to main content

KeyRequest

kindstringrequired

Possible values: [live, test, admin]

namestring

Possible values: <= 64 characters

scopes object

A preset (full, read-only, admin) or a list of scopes. Admin keys hold only admin scopes; live and test keys hold none of them.

oneOf
string

Possible values: [full, read-only, admin]

expires_in_daysinteger

Possible values: [1, 7, 30, 90]

expires_atstring<date-time>
never_expiresboolean
Default value: false
limits object
monthly_usdnumber

Possible values: >= 0

requests_per_minuteinteger

Possible values: >= 1

KeyRequest
{
  "kind": "live",
  "name": "string",
  "scopes": "full",
  "expires_in_days": 1,
  "expires_at": "2024-07-29T15:51:28.071Z",
  "never_expires": false,
  "limits": {
    "monthly_usd": 0,
    "requests_per_minute": 0
  }
}