Create project
POST<your-unleash-url>/api/admin/projects
Create a new Unleash project.
Request
- application/json
Bodyrequired
createProjectSchema
The project's identifier. If this property is not present or is an empty string, Unleash will generate the project id automatically. This property is deprecated.
Possible values: Value must match regular expression [A-Za-z0-9_~.-]*
pet-shop
The project's name. The name must contain at least one non-whitespace character.
Possible values: Value must match regular expression ^(?!\s*$).+
Pet shop
The project's description.
This project contains features related to the new pet shop.
A mode of the project affecting what actions are possible in this project
Possible values: [open
, protected
, private
]
open
open
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
default
userId
A list of environments that should be enabled for this project. When provided, the list must contain at least one environment. If this property is missing, Unleash will default to enabling all non-deprecated environments for the project.
Possible values: >= 1
["production","development"]
changeRequestEnvironments object[]
Responses
- 201
- 400
- 401
- 403
- 415
The resource was successfully created.
Response Headers
- application/json
- Schema
- Example (auto)
Schema
The project's identifier.
Possible values: Value must match regular expression [A-Za-z0-9_~.-]+
pet-shop
The project's name.
Possible values: non-empty
Pet shop
The project's description.
This project contains features related to the new pet shop.
A limit on the number of features allowed in the project. null
if no limit.
100
A mode of the project affecting what actions are possible in this project
Possible values: [open
, protected
, private
]
open
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
userId
The environments enabled for the project.
Possible values: >= 1
["production","staging"]
changeRequestEnvironments object[]
{
"id": "pet-shop",
"name": "Pet shop",
"description": "This project contains features related to the new pet shop.",
"featureLimit": 100,
"mode": "open",
"defaultStickiness": "userId",
"environments": [
"production",
"staging"
],
"changeRequestEnvironments": [
{
"name": "production",
"requiredApprovals": 3
}
]
}
The request data does not match what we expect.
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ValidationError
A description of what went wrong.
The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ValidationError",
"message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}
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
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
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 operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.
- application/json
- Schema
- Example (auto)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
ContentTypeerror
A description of what went wrong.
We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "ContentTypeerror",
"message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}
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' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
"name": "Pet shop",
"description": "This project contains features related to the new pet shop.",
"mode": "open",
"defaultStickiness": "userId",
"environments": [
"production",
"development"
],
"changeRequestEnvironments": [
{
"name": "production",
"requiredApprovals": 3
}
]
}'