Admin APIProjects

Create project

Enterprise feature

Create a new Unleash project.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

createProjectSchema
namestringRequiredformat: "^(?!\s*$).+"

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

descriptionstring or nullOptional
The project's description.
modeenumOptionalDefaults to open
A mode of the project affecting what actions are possible in this project
Allowed values:
defaultStickinessstringOptionalDefaults to default
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
environmentslist of stringsOptional

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.

changeRequestEnvironmentslist of objectsOptional

A list of environments that should have change requests enabled. If the list includes environments not in the environments list, they will still have change requests enabled.

idstringOptionalformat: "[A-Za-z0-9_~.-]*"Deprecated
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.

Response headers

locationstring or null
The location of the newly created resource.

Response

The resource was successfully created.
idstringformat: "[A-Za-z0-9_~.-]+"
The project's identifier.
namestring>=1 character
The project's name.
descriptionstring or null
The project's description.
featureLimitinteger or null

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

modeenum or null
A mode of the project affecting what actions are possible in this project
Allowed values:
defaultStickinessstring or null
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
environmentslist of strings or null
The environments enabled for the project.
changeRequestEnvironmentslist of objects or null
The list of environments that have change requests enabled.

Errors