Creates a new environment | Unleash Documentation

Enterprise feature

Uses the details provided in the payload to create a new environment

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Request

createEnvironmentSchema

namestringRequiredformat: "^[a-zA-Z0-9~_.-]+$"

The name of the environment. Must be a URL-friendly string according to RFC 3968, section 2.3

The name of the environment. Must be a URL-friendly string according to [RFC 3968, section 2.3](https://www.rfc-editor.org/rfc/rfc3986#section-2.3)

typestringRequired>=1 character

The type of environment you would like to create. Unleash officially recognizes the following values:

development
test
preproduction
production

If you pass a string that is not one of the recognized values, Unleash will accept it, but it will carry no special semantics.

The [type of environment](https://docs.getunleash.io/concepts/environments#environment-types) you would like to create. Unleash officially recognizes the following values: - `development` - `test` - `preproduction` - `production` If you pass a string that is not one of the recognized values, Unleash will accept it, but it will carry no special semantics.

enabledbooleanOptional

Newly created environments are enabled by default. Set this property to false to create the environment in a disabled state.

sortOrderintegerOptional

Defines where in the list of environments to place this environment. The list uses an ascending sort, so lower numbers are shown first. You can change this value later.

requiredApprovalsinteger or nullOptional>=1

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

Response headers

locationstring or null

The location of the newly created resource.

Response

The resource was successfully created.

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"
4
5	payload = {
6	"name": "staging-environment",
7	"type": "preproduction"
8	}
9	headers = {
10	"Authorization": "<apiKey>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())

1	{
2	"name": "staging-environment",
3	"type": "preproduction",
4	"enabled": true,
5	"protected": false,
6	"sortOrder": 2,
7	"projectCount": 5,
8	"apiTokenCount": 3,
9	"enabledToggleCount": 7,
10	"requiredApprovals": 2
11	}

Authentication

Request

Response headers

Response

Errors