Create project

POST 
/api/admin/projects

Create a new Unleash project.

Request

application/json

Body

required

createProjectSchema

id stringdeprecated
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_~.-]*
Example: pet-shop
name stringrequired
The project's name. The name must contain at least one non-whitespace character.
Possible values: Value must match regular expression ^(?!\s*$).+
Example: Pet shop
description stringnullable
The project's description.
Example: This project contains features related to the new pet shop.
mode string
A mode of the project affecting what actions are possible in this project
Possible values: [open, protected, private]
Default value: open
Example: open
defaultStickiness string
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
Default value: default
Example: userId
environments string[]
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
Example: ["production","development"]

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 stringrequired

The name of the environment to configure change requests for.

Example: production

requiredApprovals integer

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.

Default value: 1

Example: 3

]

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

id stringrequired
The project's identifier.
Possible values: Value must match regular expression [A-Za-z0-9_~.-]+
Example: pet-shop
name stringrequired
The project's name.
Possible values: non-empty
Example: Pet shop
description stringnullable
The project's description.
Example: This project contains features related to the new pet shop.
featureLimit integernullable
A limit on the number of features allowed in the project. null if no limit.
Example: 100
mode string
A mode of the project affecting what actions are possible in this project
Possible values: [open, protected, private]
Example: open
defaultStickiness string
A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy
Example: userId
environments string[]
The environments enabled for the project.
Possible values: >= 1
Example: ["production","staging"]

changeRequestEnvironments

object[]

The list of environments that have change requests enabled.

Array [

name stringrequired

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

Example: production

requiredApprovals integerrequired

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.

Possible values: >= 1

Default value: 1

Example: 3

]

Example (from schema)

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

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

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

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

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.

Example (from schema)

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

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

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.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

415

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

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
A description of what went wrong.
Example: 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.

Example (from schema)

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

Loading...