Environments

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

put/api/admin/environments/update/{name}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/environments/update/{name}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

namestring required

Request body

typestring

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

sortOrderinteger

Changes the sort order of this environment.

requiredApprovalsinteger nullable

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

Example request

{
  "requiredApprovals": 3
}

Response

environmentSchema

namestring required

The name of the environment

typestring required

The type of environment.

enabledboolean required

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

protectedboolean required

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

sortOrderinteger required

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 nullable

The number of projects with this environment

apiTokenCountinteger nullable

The number of API tokens for the project environment

enabledToggleCountinteger nullable

The number of enabled toggles for the project environment

requiredApprovalsinteger nullable

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

Example response

{
  "name": "my-dev-env",
  "type": "development",
  "enabled": true,
  "protected": true,
  "sortOrder": 3,
  "projectCount": 10,
  "apiTokenCount": 6,
  "enabledToggleCount": 10,
  "requiredApprovals": 3
}

Changes

No recorded changes to this operation across all 7 revisions of this API.