Sign in

v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB
Projects

Create project

Enterprise feature

Create a new Unleash project.

post/api/admin/projects

Request body

idstring

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.

namestring required

The project's name. The name must contain at least one non-whitespace character.

descriptionstring nullable

The project's description.

mode'open' | 'protected' | 'private'

A mode of the project affecting what actions are possible in this project

defaultStickinessstring

A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

environmentsstring[]

A list of environments that should be enabled for this project. If this property is missing, Unleash will default to enabling all non-deprecated environments for the project. An empty list will result in no environment enabled for the project.

Example request

{
  "id": "pet-shop",
  "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
    }
  ]
}

Response

The resource was successfully created.

idstring required

The project's identifier.

namestring required

The project's name.

descriptionstring nullable

The project's description.

featureLimitinteger nullable

A limit on the number of features allowed in the project. null if no limit.

mode'open' | 'protected' | 'private'

A mode of the project affecting what actions are possible in this project

defaultStickinessstring

A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

environmentsstring[]

The environments enabled for the project.

Example response

{
  "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
    }
  ]
}