Projects

Update project

Enterprise feature

Update a project with new configuration. Any fields not provided are ignored.

put/api/admin/projects/{projectId}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required

Request body

namestring required

The new name of the project. The name must contain at least one non-whitespace character.

descriptionstring

A new description for the project

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

Example request

{
  "name": "my-renamed-project",
  "description": "Anything related to the new UI",
  "mode": "open",
  "defaultStickiness": "userId"
}

Response

This response has no body.

Changes

No recorded changes to this operation across all 7 revisions of this API.