Skip to main content
POST
/
api
/
v1
/
api-keys
{
  "secretKey": "<string>"
}

Body

application/json
​
name
string
required

The name of the API key. This should be a short, descriptive name that identifies the purpose of the API key. It is recommended to include the name of the application or service that will be using the API key.

Example:

"Development Environment API Key"

​
scope
object
required

The scope of the API key. This defines the resources that the API key can access. If no scope is provided, the API key won't be valid for ANY resources. If multiple scopes are provided, say accountId and environmentId where environmentId is part of the account, the key will still be valid for everything in the account. It is recommended to use the narrowest scope possible to limit the API key's access.

​
description
string

A description of the API key. This should be a short description of what the API key is used for. It is recommended to include the name of the application or service that will be using the API key.

Example:

"API key for the Development Environment"

Response

​
secretKey
string
required