Skip to content
post/v1/api-keys

Create a new API key (secret returned exactly once)

Parameters

ParametersTypeRequiredDescription
User-Agent(header)string
authorization(header)

Request body

  • namestringRequired
  • scopesarrayOptional
  • environmentenum (2)Optional
  • expires_in_daysanyOfOptional
  • ip_allow_listarrayOptional

Responses

  • 201Successful Response
    • summaryobjectRequired

      Public-safe shape — never includes the raw secret.

      Description
      • idstringRequired
      • namestringRequired
      • prefixstringRequired
      • scopesarrayRequired
      • environmentenum (2)Optional
      • ip_allow_listarrayRequired
      • expires_atanyOfRequired
      • last_used_atanyOfRequired
      • created_atstring <date-time>Required
      • rotated_old_expires_atanyOfOptional
      • previewanyOfOptional
    • secretstringRequired
  • 422Validation Error
    • detailarrayOptional
POST /v1/api-keys | AIDE