Skip to main content
POST
/
admin
/
api-keys
/
{id}
/
rotate
Rotate API Key (Revoke Old + Issue New)
curl --request POST \
  --url https://api.headlesscommerce.io/v1/admin/api-keys/{id}/rotate \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "key_hint": "<string>",
  "is_active": true,
  "last_used_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "key": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key. Example: sk_live_xxxxx or pk_live_xxxxx

Path Parameters

​
id
string
required

Resource ID

Response

200 - application/json

Success

​
id
string
​
name
string
​
type
enum<string>
Available options:
secret,
publishable
​
mode
enum<string>
Available options:
live,
test
​
key_hint
string

Masked key (sk_live_...abc)

​
is_active
boolean
​
last_used_at
string<date-time> | null
​
created_at
string<date-time>
​
key
string

New original key (returned once)