v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

api-keys

Create API key

Creates an API key for the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.

post/api-keys

Headers

X-API-Versionstring required

Management API version.

Request body

type'public' | 'secret' | 'proxy' required

Type of an API key.

namestring required

Name of an API key.

descriptionstring

Description for an API key.

environmentstring

Environment in which to create an API key. If omitted for proxy or secret API keys, the key will be scoped to the workspace. If omitted for other types of keys, the API key will be created in the default environment.

Response

Created API key object.

Example response

{
  "data": {
    "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
    "name": "My Public Key",
    "description": "Description for my public key",
    "status": "enabled",
    "type": "public",
    "token": "eWDrrpGGLjDQW0LBA0Wj",
    "rate_limit": 5,
    "created_at": "2024-05-31T01:24:39.506Z"
  }
}