Admin APIEnvironments

Updates an environment by name

Enterprise feature

Given an environment by name updates the environment with the given payload. Note that name, enabled and protected cannot be changed by this API

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

namestringRequired

Request

updateEnvironmentSchema
typestringOptional

Updates the type of environment (i.e. development or production).

sortOrderintegerOptional
Changes the sort order of this environment.
requiredApprovalsinteger or nullOptional>=1
Experimental field. The number of approvals required before a change request can be applied in this environment.

Response

environmentSchema
namestring
The name of the environment
typestring

The type of environment.

enabledboolean

true if the environment is enabled for the project, otherwise false.

protectedboolean

true if the environment is protected, otherwise false. A protected environment can not be deleted.

sortOrderinteger
Priority of the environment in a list of environments, the lower the value, the higher up in the list the environment will appear. Needs to be an integer
projectCountinteger or null>=0
The number of projects with this environment
apiTokenCountinteger or null>=0
The number of API tokens for the project environment
enabledToggleCountinteger or null>=0
The number of enabled toggles for the project environment
requiredApprovalsinteger or null>=1
Experimental field. The number of approvals required before a change request can be applied in this environment.

Errors