v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

Environments

Get the environment with `name`

Retrieves the environment with name if it exists in this Unleash instance

get/api/admin/environments/{name}

Path parameters

namestring required

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
}