Skip to main content

Get the environment with `name`

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

Authorization

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

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

Request

Path Parameters

  • name string required
Responses

environmentSchema

Schema
  • name string required

    The name of the environment

  • type string required
  • enabled boolean required

    true if the environment is enabled for the project, otherwise false.

  • protected boolean required

    true if the environment is protected, otherwise false. A protected environment can not be deleted.

  • sortOrder integer 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

  • projectCount integer nullable

    The number of projects with this environment

  • apiTokenCount integer nullable

    The number of API tokens for the project environment

  • enabledToggleCount integer nullable

    The number of enabled toggles for the project environment

Authorization

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

Request

Base URL
<your-unleash-url>
Security Scheme
apiKey
name — path required
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/environments/:name' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'