Skip to main content
POST
Create an environment API key
Requires an Account API key with the account:environments:api_keys:create scope. Create one from Account API keys in the dashboard.
Creates an Environment API key with custom scopes. Not specifying any scopes defaults to full environment access. environmentUuid is the UUID 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.

Path Parameters

environmentUuid
string<uuid>
required

Environment UUID that will own the key.

Body

application/json
display_name
string
required

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

Required string length: 1 - 255
Example:

"provisioned-ci"

scopes
string[]

Environment scopes to grant the key, such as environment:deploy or environment:*. Defaults to environment:* (full access).

Minimum array length: 1
Example:

Response

Successfully created an Environment API key

data
object
required