Rotate API key

POST

/v1/organizations/current/api_keys/{api_key_id}/rotate

Rotate an API key: revoke the old key and create a new one with the same config.

Parameters

Path Parameters

api_key_id

required

Api Key Id

string format: uuid

Responses

200

Successful Response

ApiKeyCreateResponse

Returned only on creation — includes the raw API key.

object

id

required

Id

string format: uuid

organization_id

required

Organization Id

string format: uuid

key_prefix

required

Key Prefix

string

name

required

Any of:

string

string

null

null

last_used_at

required

Any of:

string

string format: date-time

null

null

expires_at

required

Any of:

string

string format: date-time

null

null

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

raw_key

required

Raw Key

string

401

Unauthorized

404

API key not found or not active

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object