Skip to main content
POST
/
api
/
credentials
/
keys
Create a new API key
curl --request POST \
  --url https://app.herondata.io/api/credentials/keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "created": "2023-11-07T05:31:56Z",
  "heron_id": "<string>",
  "is_active": true,
  "name": "<string>",
  "token": "<string>",
  "token_prefix": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required

A descriptive name for the key

Required string length: 1 - 128

Response

API key created. The full token is only returned in this response.

created
string<date-time>
heron_id
string
is_active
boolean
name
string
token
string

Full token - shown only once

token_prefix
string