Skip to main content
PATCH
/
v1
/
api-keys
/
{key_name}
Update a specific API key
curl --request PATCH \
  --url https://api.example.com/v1/api-keys/{key_name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "prefix": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
key_name
string
required

Body

application/json
​
name
string

The new name for the API key

​
expires_at
string<date-time>

The new expiration date and time for the API key

Response

API key updated successfully

​
id
string<uuid>
​
created_at
string<date-time>
​
last_used_at
string<date-time>
​
expires_at
string<date-time>
​
status
enum<string>
Available options:
ACTIVE,
EXPIRED,
REVOKED
​
name
string
​
prefix
string