Get the environments available to a project

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

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 stringrequired

Responses

200

environmentsProjectSchema

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: development
typestringrequired
The type of environment.
Example: production
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: false
sortOrderintegerrequired
Priority of the environment in a list of environments, the lower the value, the higher up in the list the environment will appear
Example: 1
projectApiTokenCountinteger
The number of client and front-end API tokens that have access to this project
Example: 5
projectEnabledToggleCountinteger
The number of features enabled in this environment for this project
Example: 7
defaultStrategy object
The strategy configuration to add when enabling a feature environment by default
namestringrequired
The name of the strategy type
Example: flexibleRollout
titlestringnullable
A descriptive title for the strategy
Example: Gradual Rollout 25-Prod
disabledbooleannullable
A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs
Example: false
sortOrdernumber
The order of the strategy in the list
Example: 9999
constraints object[]
A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints
Array [
contextNamestringrequired
The name of the context field that this constraint should apply to.
Example: appName
operatorstringrequired
The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.
Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]
Example: IN
caseInsensitiveboolean
Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).
Default value: false
invertedboolean
Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.
Default value: false
valuesstring[]
The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.
Example: ["my-app","my-other-app"]
valuestring
The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.
Example: my-app
]
variants object[]
Strategy level variants
Array [
namestringrequired
The variant name. Must be unique for this feature flag
Example: blue_group
weightintegerrequired
The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on variant weights for more information
Possible values: <= 1000
weightTypestringrequired
Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the variant weight documentation.
Possible values: [variable, fix]
Example: fix
stickinessstringrequired
The stickiness to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time
Example: custom.context.field
payload object
Extra data configured for this variant
typestringrequired
The type of the value. Commonly used types are string, number, json and csv.
Possible values: [json, csv, string, number]
valuestringrequired
The actual value of payload
]
parameters object
A list of parameters for a strategy
property name*string
segmentsnumber[]
Ids of segments to use for this strategy
Example: [1,2]
visibleboolean
Indicates whether the environment can be enabled for feature flags in the project
Example: true
]

Example (auto)

{
  "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
        ]
      },
      "visible": true
    }
  ]
}

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

404

The requested resource was not found.

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: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

Authorization: Authorization

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

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

• CURL

curl -L '<your-unleash-url>/api/admin/environments/project/:projectId' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

ResponseClear

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