Get the environments available to a project
GET <your-unleash-url>/api/admin/environments/project/:projectId
Authorization
name: Authorizationtype: apiKeyin: header
Gets the environments that are available for this project. An environment is available for a project if enabled in the project configuration
Request
Path Parameters
- projectId string required
- 200
- 401
- 403
- 404
environmentsProjectSchema
- application/json
- Schema
- Example (from schema)
Schema
- version integer required
Version of the environments schema
environments object[]required
{
"version": 1,
"environments": [
{
"name": "development",
"type": "production",
"enabled": true,
"protected": false,
"sortOrder": 1,
"projectApiTokenCount": 5,
"projectEnabledToggleCount": 7,
"defaultStrategy": {
"name": "flexibleRollout",
"title": "Gradual Rollout 25-Prod",
"disabled": false,
"sortOrder": 9999,
"constraints": [
{
"values": [
"1",
"2"
],
"inverted": false,
"operator": "IN",
"contextName": "appName",
"caseInsensitive": false
}
],
"variants": [
{
"name": "blue_group",
"weight": 0,
"weightType": "fix",
"stickiness": "custom.context.field",
"payload": {
"type": "json",
"value": "{\"color\": \"red\"}"
}
}
],
"parameters": {
"groupId": "some_new",
"rollout": "25",
"stickiness": "sessionId"
},
"segments": [
1,
2
]
}
}
]
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from 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.
{
"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
- Example (from 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.
{
"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
- Example (from 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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
Authorization
name: Authorizationtype: apiKeyin: header
Request
Request
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
curl -L -X GET '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'