Get the environment with name | Unleash Documentation

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

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

namestringRequired

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.

1	import requests
2
3	url = "https://app.unleash-instance.example.com/api/admin/environments/name"
4
5	headers = {"Authorization": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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	}

Get the environment with `name`

Authentication

Path parameters

Response

Errors