Skip to content
AIDE
Sign up
post/v1/api-keys/{key_id}/rotate

Rotate an API key (24h grace on the previous secret)

Parameters

ParametersTypeRequiredDescription
key_id(path)string✓—
User-Agent(header)string——
authorization(header)———

Responses

  • 200Successful 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/{key_id}/rotate | AIDE