Skip to main content
POST
/
v1
/
identity
/
api-keys
Create an API key. The plain-text key is returned exactly once.
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/identity/api-keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key_prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "is_active": true,
  "last_used_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "plain_text_key": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
scopes
string[]
​
expires_at
string<date-time> | null

Response

Successful Response

Returned exactly once on creation. plain_text_key is never persisted and never returned again — the caller must store it immediately.

​
id
string<uuid>
required
​
name
string
required
​
key_prefix
string
required
​
scopes
string[]
required
​
is_active
boolean
required
​
last_used_at
string<date-time> | null
required
​
expires_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
plain_text_key
string
required