Skip to main content
PATCH
/
api
/
api-keys
/
{key_id}
Update API key
curl --request PATCH \
  --url https://api.example.com/api/api-keys/{key_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "name": "<string>",
  "last_used_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
key_id
string
required

Body

application/json
​
name
string
required

Response

Successful Response

Represents an API key for authentication (without exposing the actual key).

​
id
string
required

Unique API key identifier with 'apikey_' prefix

​
created_at
string<date-time>
required

When this API key was created

​
is_active
boolean
required

Whether this API key is currently valid and can be used

​
name
string | null

Optional descriptive name for this API key

​
last_used_at
string<date-time> | null

When this API key was last used for authentication