Updates an environment by name | Unleash Documentation

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

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

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

400

Bad Request Error

401

Unauthorized Error

API key needed to access this API

API key needed to access this API, in Bearer token format

updateEnvironmentSchema

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

Changes the sort order of this environment.

Experimental field. The number of approvals required before a change request can be applied in this environment.

The name of the environment

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

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

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

The number of projects with this environment

The number of API tokens for the project environment

The number of enabled toggles for the project environment

Experimental field. The number of approvals required before a change request can be applied in this environment.

$	curl -X PUT https://app.unleash-instance.example.com/api/admin/environments/update/name \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"name": "my-dev-env",
3	"type": "development",
4	"enabled": true,
5	"protected": true,
6	"sortOrder": 3,
7	"projectCount": 10,
8	"apiTokenCount": 6,
9	"enabledToggleCount": 10,
10	"requiredApprovals": 3
11	}

$	curl -X PUT https://app.unleash-instance.example.com/api/admin/environments/update/name \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"name": "my-dev-env",
3	"type": "development",
4	"enabled": true,
5	"protected": true,
6	"sortOrder": 3,
7	"projectCount": 10,
8	"apiTokenCount": 6,
9	"enabledToggleCount": 10,
10	"requiredApprovals": 3
11	}