Create project

POST <your-unleash-url>/api/admin/projects

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Create a new Unleash project.

Request

application/json

Body

required

createProjectSchema

• 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.

• 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. 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. This is a beta feature and is not yet generally available.

• 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. this is a beta feature is not yet generally available.

  ]

Responses

• 201
• 400
• 401
• 403
• 415

---

The resource was successfully created.

Response Headers

• location string

  The location of the newly created resource.

application/json

Schema

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. This is a beta feature and may be subject to change.

• changeRequestEnvironments object[]

  The list of environments that have change requests enabled. This is a beta feature and may be subject to change.

  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.

  ]

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

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

Body required

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

curl / cURL

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

python / requests

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

go / native

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

nodejs / axios

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

csharp / RestSharp

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

php / cURL

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

java / OkHttp

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'

powershell / RestMethod

curl -L -X POST '<your-unleash-url>/api/admin/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "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
    }
  ]
}'