API Keys

Rotate/Regenerate an API Key

Changed on

Generates and returns a new secure raw key string for an existing API Key while keeping metadata, scopes, and association unchanged.

post/v1/api-keys/{id}/regenerate

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/v1/api-keys/{id}/regenerate
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The unique UUID of the API Key to regenerate.

Response

API key regenerated successfully

idstring uuid required

Unique API Key identifier.

namestring required

Human-readable name of the key.

keystring required

The fully generated secure raw API Key string. This is returned ONLY ONCE.

operationstring required
created_atstring date-time required

Timestamp of creation.

Example response

{
  "key": "ak_7f9ba3271cf881309d9be8c9c0fcae47a95b8d29c3f0b2da8e89cf21e5c3df01"
}

Changes