Skip to main content

Create project

POST /api/admin/projects

Create a new Unleash project.

Request

Body

required

createProjectSchema

  • id string deprecated

    Possible values: Value must match regular expression [A-Za-z0-9_~.-]*

    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.

  • name string required

    Possible values: Value must match regular expression ^(?!\s*$).+

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

  • description string nullable

    The project's description.

  • mode string

    Possible values: [open, protected, private]

    Default value: open

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

  • defaultStickiness string

    Default value: default

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

  • environments string[]

    Possible values: >= 1

    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.

  • changeRequestEnvironments object[]

    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.

  • Array [
  • name string required

    The name of the environment to configure change requests for.

  • requiredApprovals integer

    Default value: 1

    The number of approvals required for a change request to be fully approved and ready to applied in this environment. If no value is provided, it will be set to the default number, which is 1. Values will be clamped to between 1 and 10 inclusive.

  • ]
Responses

The resource was successfully created.

Response Headers
  • location string

    The location of the newly created resource.

Schema
  • id string required

    Possible values: Value must match regular expression [A-Za-z0-9_~.-]+

    The project's identifier.

  • name string required

    Possible values: non-empty

    The project's name.

  • description string nullable

    The project's description.

  • featureLimit integer nullable

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

  • mode string

    Possible values: [open, protected, private]

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

  • defaultStickiness string

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

  • environments string[]

    Possible values: >= 1

    The environments enabled for the project.

  • changeRequestEnvironments object[]

    The list of environments that have change requests enabled.

  • Array [
  • name string required

    The name of the environment this change request configuration applies to.

  • requiredApprovals integer required

    Possible values: >= 1

    Default value: 1

    The number of approvals required for a change request to be fully approved and ready to applied in this environment. If no value is provided, it will be set to the default number, which is 1. The value must be greater than or equal to 1.

  • ]
Loading...