Skip to main content
POST
/
api-keys
Create a new API key.
curl --request POST \
  --url https://api.sandbox.goteal.co/api-keys \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "Backend service key"
}'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Backend service key",
  "secret": "a1b2c3d4e5f6g7h8i9j0",
  "createdAt": "2019-05-17T00:00:00.000Z"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required

Human-readable name for the API key

Example:

"Backend service key"

Response

Created

​
id
string<uuid>
required

Unique identifier for the API key

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string
required

Human-readable name for the API key

Example:

"Backend service key"

​
secret
string
required

The API key secret. Only shown once at creation time.

Example:

"a1b2c3d4e5f6g7h8i9j0"

​
createdAt
string<date-time>
required

When the API key was created

Example:

"2019-05-17T00:00:00.000Z"

⌘I