Add an environment to a project.

POST 
https://us.app.unleash-hosted.com/ushosted/api/admin/projects/:projectId/environments

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

Request

Responses

200

This response has no body.

401

Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

403

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

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

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 'https://us.app.unleash-hosted.com/ushosted/api/admin/projects/:projectId/environments' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "environment": "development",
  "changeRequestsEnabled": true,
  "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
    ]
  }
}'

Request Collapse all

Base URL

https://us.app.unleash-hosted.com/ushosted

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

Body required

{
  "environment": "development",
  "changeRequestsEnabled": true,
  "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
    ]
  }
}

ResponseClear

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