Environments

Creates a new environment

Enterprise feature

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

post/api/admin/environments

Request

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

Request body

namestring required

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

typestring required

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.

enabledboolean

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

sortOrderinteger

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 nullable

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

Example request

{
  "requiredApprovals": 3
}

Response

The resource was successfully created.

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.