Rotate a Check API key.

POST

/api/admin/check-api-keys/{id}/rotate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/check-api-keys/example/rotate \
  --header 'Authorization: Bearer <token>'

Creates a replacement Check API key with the same policy as the existing active key, then revokes the old key. The new plaintext api_key is returned only once.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Active Check API key identifier to rotate.

Responses

201

Created or rotated Check API key response. The plaintext key is returned only once.

Media type application/json

object

id

required

string

api_key

required

Plaintext API key returned only once.

string

key_prefix

required

string

name

required

string

client_id

required

string

allowed_operations

required

Array<string>

Allowed values: check batch subscribe

rate_limit_tier

required

string

Allowed values: strict moderate lenient

expires_at

integer format: int64

created_at

required

integer format: int64

key

additional properties

Example

{
  "id": "018f3f7c-85b0-7c5d-a6b6-1c3a6e6b9e01",
  "api_key": "ar_chk_live_example",
  "key_prefix": "ar_chk",
  "name": "Policy Check API key",
  "client_id": "client_123",
  "allowed_operations": [
    "check"
  ],
  "rate_limit_tier": "moderate",
  "created_at": 1770000000
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}