Unleash Projects API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
27 operations
across 20 paths,
and defines 51 schemas.
It is described by OpenAPI 3.0.3, at version 7.4.1.
Requests are made against a single base URL, https://app.unleash-instance.example.com.
The identity and technical contract details declared by the specification.
projectAddAccessSchema
object
An object containing a collection of roles, a collection of groups and a collection of users.
3 properties
3 required
constraintSchema
object
A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategi…
6 properties
2 required
featureSchema
object
A feature flag definition
22 properties
1 required
projectEnvironmentSchema
object
Add an environment to a project, optionally also sets if change requests are enabled for this environment on the project
3 properties
1 required
projectAccessConfigurationSchema
object
An object describing roles for a project and what users and groups are part of that role.
1 property
1 required
featureStrategySchema
object
A single activation strategy configuration schema for a feature
10 properties
1 required
projectApplicationSdkSchema
object
A project application instance SDK.
2 properties
2 required
projectsSchema
object
An overview of all the projects in the Unleash instance
2 properties
2 required
outdatedSdksSchema
object
Data about outdated SDKs that should be upgraded.
1 property
1 required
projectInsightsSchema
object
A high-level overview of a project insights. It contains information such as project statistics, overall health, types of flags, members overview, change reque…
6 properties
6 required
projectSchema
object
A definition of the project used for projects listing purposes
19 properties
2 required
projectRoleSchema
object
An overview of how many users and groups are mapped to the specified project with the specified role.
5 properties
1 required
userSchema
object
An Unleash user
17 properties
1 required
variantSchema
object
A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/concepts/feature-flag-variantswhat…
6 properties
2 required
projectFlagCreatorsSchema
array
A list of project flag creators
releasePlanMilestoneStrategySchema
object
Schema representing the creation of a release plan milestone strategy.
9 properties
4 required
overrideSchema
object
An override for deciding which variant should be assigned to a user based on the context name
2 properties
2 required
groupWithProjectRoleSchema
object
Data about a group including their project role
12 properties
1 required
groupUserModelSchema
object
Details for a single user belonging to a group
3 properties
1 required
projectApplicationsSchema
object
A list of project applications
2 properties
2 required
createProjectApiTokenSchema
object
The schema for creating a project API token. This schema is used to create a new project API token.
4 properties
2 required
projectAccessSchema
object
An object describing access permissions for a given project.
3 properties
3 required
createProjectSchema
object
Data used to create a new [project](https://docs.getunleash.io/concepts/projects).
7 properties
1 required
releasePlanMilestoneSchema
object
Schema representing the creation of a release plan milestone.
9 properties
4 required
releasePlanSchema
object
Schema representing the creation of a release plan.
12 properties
9 required
projectCreatedSchema
object
Details about the newly created project.
8 properties
2 required
projectApplicationSchema
object
A project application instance.
4 properties
4 required
healthReportSchema
object
A report of the current health of the requested project, with datapoints like counters of currently active, stale, and potentially stale feature flags.
19 properties
12 required
projectStatsSchema
object
Statistics for a project, including the average time to production, number of features created, the project activity and more. Stats are divided into current a…
8 properties
8 required
safeguardSchema
object
A safeguard configuration for a release plan.
4 properties
4 required
createFeatureNamingPatternSchema
object
Create a feature naming pattern
3 properties
1 required
updateProjectSchema
object
Data used to update a [project](https://docs.getunleash.io/concepts/projects)
4 properties
1 required
projectLinkTemplateSchema
object
A template for a link that can be automatically added to new feature flags.
2 properties
1 required
featureEnvironmentSchema
object
A detailed description of the feature environment
19 properties
2 required
createFeatureStrategySchema
object
Create a strategy configuration in a feature
8 properties
1 required
projectRoleUsageSchema
object
A collection of projects with counts of users and groups mapped to them with specified roles.
1 property
updateProjectEnterpriseSettingsSchema
object
Data used to update a [project](https://docs.getunleash.io/concepts/projects) settings
3 properties
roleSchema
object
A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform
5 properties
3 required
doraFeaturesSchema
object
The representation of a dora time to production feature metric
2 properties
2 required
userWithProjectRoleSchema
object
Data about a user including their project role
8 properties
1 required
tagSchema
object
Representation of a [tag](https://docs.getunleash.io/concepts/feature-flagstags)
3 properties
2 required
featureTypeCountSchema
object
A count of feature flags of a specific type
2 properties
2 required
apiTokenSchema
object
An overview of an [Unleash API token](https://docs.getunleash.io/concepts/api-tokens-and-client-keys).
10 properties
5 required
parametersSchema
object
A list of parameters for a strategy
safeguardTriggerConditionSchema
object
The condition that triggers the safeguard.
2 properties
2 required
strategyVariantSchema
object
This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data…
5 properties
4 required
projectDoraMetricsSchema
object
A projects dora metrics
2 properties
1 required
projectOverviewSchema
object
A high-level overview of a project. It contains information such as project statistics, the name of the project, what members and what features it contains, et…
19 properties
3 required
apiTokensSchema
object
An object with [Unleash API tokens](https://docs.getunleash.io/concepts/api-tokens-and-client-keys)
1 property
1 required
validateProjectSchema
object
Data used to validate a project ID
1 property
1 required
createStrategyVariantSchema
object
This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data…
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Unleash publishes across the network.
