Skip to main content
PATCH
Update an environment API key
Requires an Account API key with the account:environments:api_keys:update scope. Create one from Account API keys in the dashboard.
Updates an Environment API key. Changes the display name and/or scopes of an Environment API key. scopes replaces the key’s current scopes. The secret does not change, but removing a scope makes requests that need it fail with 403. keyUuid is the UUID returned when the key 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 owns the key.

keyUuid
string<uuid>
required

API-key UUID.

Body

application/json
display_name
string

New display name for the key. Must be unique within the environment.

Required string length: 1 - 255
Example:

"provisioned-ci"

scopes
string[]

Environment scopes that replace the key's current scopes, such as environment:deploy or environment:*.

Minimum array length: 1
Example:

Response

Successfully updated the Environment API key

data
object
required