Skip to main content

Get the environment with `name`

GET 

<your-unleash-url>/api/admin/environments/:name

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

Request

Path Parameters

    name stringrequired

Responses

environmentSchema

Schema
    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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
curl -L '<your-unleash-url>/api/admin/environments/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'
Request Collapse all
Base URL
<your-unleash-url>
Auth
Parameters
— pathrequired
ResponseClear

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