Get the environment with `name`

GET /api/admin/environments/:name

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

Request

Path Parameters

• name string required

Responses

• 200
• 401
• 403
• 404

---

environmentSchema

application/json

Schema

Schema

• name string required

  The name of the environment

• type string required

  The type of environment.

• 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

Example (from schema)

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

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

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "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."
}

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

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

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

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...