Get all environments

GET 
<your-unleash-url>/api/admin/environments

Retrieves all environments that exist in this Unleash instance.

Responses

200

environmentsSchema

application/json

Schema

Schema

versionintegerrequired
Version of the environments schema
Example: 1
environments object[]required
List of environments
Array [
namestringrequired
The name of the environment
Example: my-dev-env
typestringrequired
The type of environment.
Example: development
enabledbooleanrequired
true if the environment is enabled for the project, otherwise false.
Example: true
protectedbooleanrequired
true if the environment is protected, otherwise false. A protected environment can not be deleted.
Example: true
sortOrderintegerrequired
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
Example: 3
projectCountintegernullable
The number of projects with this environment
Example: 10
apiTokenCountintegernullable
The number of API tokens for the project environment
Example: 6
enabledToggleCountintegernullable
The number of enabled toggles for the project environment
Example: 10
]

Example (auto)

{
  "version": 1,
  "environments": [
    {
      "name": "my-dev-env",
      "type": "development",
      "enabled": true,
      "protected": true,
      "sortOrder": 3,
      "projectCount": 10,
      "apiTokenCount": 6,
      "enabledToggleCount": 10
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

ResponseClear

Click the Send API Request button above and see the response here!