Skip to main content
POST
Create an environment API key
Requires an Account API key. Create one from Account API keys in the dashboard.
Creates an Environment API key. Keys created by this endpoint always have full environment access (environment:*). This endpoint does not accept custom scopes. Create keys with custom scopes under Environment Settings > API Keys. environment_id is the numeric ID returned when the environment was created.

Authorizations

Authorization
string
header
required

An Environment API key from your Nango environment, or an Account API key for account-level endpoints.

Body

application/json
environment_id
integer
required

Numeric environment ID returned when the environment was created.

Required range: x >= 1
Example:

123

display_name
string
required

Display name for the key. Must be unique within the environment.

Required string length: 1 - 255
Example:

"provisioned-ci"

Response

Successfully created an Environment API key

data
object
required