Skip to main content
POST
/
admin
/
api-keys
Create API Key
curl --request POST \
  --url https://api.headlesscommerce.io/v1/admin/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "secret"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "secret",
  "mode": "live",
  "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

Body

application/json
​
name
string
required

Name for key identification

​
type
enum<string>
required
Available options:
secret,
publishable

Response

201 - application/json

Created

​
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

Original key (returned once)