Sign in

v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
api-keys

Update API key

Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.

patch/api-keys/{id}

Path parameters

idstring required

Headers

X-API-Versionstring required

Management API version.

Request body

namestring

Name of an API key.

descriptionstring

Description for an API key.

status'enabled' | 'disabled'

Set API key status. Use to enable or disable an API key.

rate_limitnumber

Set rate limit for an API key. Value is in request-per-second.

Response

Updated API key object.

Example response

{
  "data": {
    "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
    "name": "My Public Key",
    "description": "Description for my public key",
    "status": "enabled",
    "type": "public",
    "token": "eWDrrpGGLjDQW0LBA0Wj",
    "rate_limit": 5,
    "created_at": "2024-05-31T01:24:39.506Z"
  }
}