Skip to main content
POST
/
user
/
api-keys
Create API Key
curl --request POST \
  --url https://relytone.data.cloud/api/v1/user/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "id": "<string>",
  "key": "<string>",
  "fullKey": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "consumerId": "<string>",
  "consumerUsername": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

API key name

description
string

API key description

Response

API key created successfully

id
string

API key unique identifier

key
string

API key (partially hidden)

fullKey
string

Full API key (only returned when creating)

name
string

API key name

description
string

API key description

createdAt
string<date-time>

Creation time

consumerId
string

Consumer ID

consumerUsername
string

Consumer username

I