Projects

Create, update, and delete Unleash projects.

📄️ Get a list of all projects.

This endpoint returns an list of all the projects in the Unleash instance.

📄️ Create project

Create a new [Unleash project](https://docs.getunleash.io/reference/projects).

📄️ Validate project ID

Validate a project ID against Unleash's rules

📄️ Update project

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

📄️ Delete project

Permanently delete the provided project. All feature flags in the project must be archived before you can delete it. This permanently deletes the project and its archived flags. It can not be undone.

📄️ Get an overview of a project. (deprecated)

This endpoint returns an overview of the specified projects stats, project health, number of members, which environments are configured, and the features in the project.

📄️ Update project enterprise settings

Update project enterprise settings with new values. Any fields not provided are ignored.

📄️ Get users in project

Get users belonging to a project together with their roles as well as a list of roles available to the project. This endpoint is deprecated. Use `/:projectId/access` instead.

📄️ Get users and groups in project

Get all groups, users and their roles, and available roles for the given project.

📄️ Set users and groups to roles in the current project

Sets all groups, users and their roles for the given project, overriding any existing configuration.

📄️ Configure project access

Configure project access for groups and single users. The provided users and groups will be given the roles specified in the payload.

📄️ Get project-role mappings

For the provided role, retrieves a list of projects that use this role. For each project it also contains information about how the role used in that project, such as how many users, groups, or service accounts that use the role.

📄️ Add user to project

Adds the specified user to a project with the provided role. This endpoint is deprecated. Use `/:projectId/access` instead.

📄️ Removes role from user

Remove the specified project role from the specified user. This endpoint is deprecated. Use `/:projectId/users/:userId/roles` instead.

📄️ Update user's project role

Replaces the given user's project role with the provided role. The user must already be a memeber of the project. This endpoint is deprecated. Use `/:projectId/users/:userId/roles` instead.

📄️ Sets roles for user

Sets the roles a user has in the project.

📄️ Remove project access for a user

Removes project access for a user by removing all of its roles for the project.

📄️ Sets roles for group

Sets the roles a group has in the project.

📄️ Remove project access for a group

Removes project access for a group by removing all of its roles for the project.

📄️ Update group's project role

Updates the permissions that the group has within the given project. This endpoint is deprecated. Use `/:projectId/users/:userId/roles` instead.

📄️ Remove project group role

Removes a project role from a group. This endpoint is deprecated. Use `/:projectId/groups/:groupId/roles` instead.

📄️ Configure project role access

Configure project access for groups and single users. The provided users and groups will be given the role specified in the URL parameters. This endpoint is deprecated. Use `/:projectId/access` instead.

📄️ Get an overview of a project.

This endpoint returns an overview of the specified projects stats, project health, number of members, which environments are configured, and the features types in the project.

📄️ Get an overview project dora metrics.

This endpoint returns an overview of the specified dora metrics

📄️ Add an environment to a project.

This endpoint adds the provided environment to the specified project, with optional support for enabling and disabling change requests for the environment and project.

📄️ Remove an environment from a project.

This endpoint removes the specified environment from the project.

📄️ Set environment-default strategy

Sets a default strategy for this environment. Unleash will use this strategy by default when enabling a toggle. Use the wild card '*' for `:environment` to add to all environments.

📄️ Get a health report for a project.

This endpoint returns a health report for the specified project. This data is used for [the technical debt dashboard](https://docs.getunleash.io/reference/technical-debt#the-technical-debt-dashboard)

📄️ Get api tokens for project.

Returns the [project API tokens](https://docs.getunleash.io/how-to/how-to-create-project-api-tokens) that have been created for this project.

📄️ Create a project API token.

Endpoint that allows creation of [project API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys#api-token-visibility) for the specified project.

📄️ Delete a project API token.

This operation deletes the API token specified in the request URL. If the token doesn't exist, returns an OK response (status code 200).