Skip to main content
← All schemas

CreateApiKeyInput

object

namerequired
string
scopesrequired
array of string
expires_at
DateTime or null

When the key stops working (within two years); unset → 90 days from now.

never_expires
boolean

A key that never expires — allowed, but flagged in the audit log. Not with expires_at.

Example
{
  "name": "string",
  "scopes": [
    "string"
  ],
  "expires_at": "2026-10-06T05:30:00.000Z",
  "never_expires": true
}