Projects

Add an environment to a project.

Changed on

This endpoint adds the provided environment to the specified project, with optional support for enabling and disabling change requests for the environment and project.

post/api/admin/projects/{projectId}/environments

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}/environments
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required

Request body

environmentstring required

The environment to add to the project

changeRequestsEnabledboolean

Whether change requests should be enabled or for this environment on the project or not

Example request

{
  "environment": "development",
  "changeRequestsEnabled": true,
  "defaultStrategy": {
    "name": "flexibleRollout",
    "title": "Gradual Rollout 25-Prod",
    "sortOrder": 9999,
    "constraints": [
      {
        "values": [
          "1",
          "2"
        ],
        "inverted": false,
        "operator": "IN",
        "contextName": "appName",
        "caseInsensitive": false
      }
    ],
    "variants": [
      {
        "name": "blue_group",
        "weightType": "fix",
        "stickiness": "custom.context.field",
        "payload": {
          "type": "json",
          "value": "{\"color\": \"red\"}"
        }
      }
    ],
    "segments": [
      1,
      2
    ]
  }
}

Response

This response has no body.

Changes

  • b2c3116e633eRevision changes
    • breaking

      the /// request property's minLength was increased from 0 to 1

    • info

      added the new SEMVER_GTE enum value to the request property ///

    • info

      added the new SEMVER_LTE enum value to the request property ///

  • 774670258f04Revision changes
    • info

      added the new REGEX enum value to the request property ///