Add an environment to a project.
POST<your-unleash-url>/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
Path Parameters
projectId stringrequired
- application/json
Bodyrequired
projectEnvironmentSchema
environment stringrequired
The environment to add to the project
Example:
development
changeRequestsEnabled boolean
Whether change requests should be enabled or for this environment on the project or not
Example:
true
defaultStrategy object
Responses
- 200
- 401
- 403
- 409
This response has no body.
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 (auto)
Schema
id string
The ID of the error instance
Example:
9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example:
AuthenticationRequired
message string
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.
{
"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 (auto)
Schema
id string
The ID of the error instance
Example:
9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example:
NoAccessError
message string
A description of what went wrong.
Example:
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
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.
- application/json
- Schema
- Example (auto)
Schema
id string
The ID of the error instance
Example:
9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example:
NameExistsError
message string
A description of what went wrong.
Example:
There is already a feature called "my-awesome-feature".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NameExistsError",
"message": "There is already a feature called \"my-awesome-feature\"."
}
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/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
]
}
}'
ResponseClear