Unleash Change Requests API
API for managing [change requests](https://docs.getunleash.io/concepts/change-requests).
Unleash Change Requests API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Change Requests. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 20 operations across 17 paths, and defines 36 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.
20 operations
17 paths
36 schemas
2 DELETE11 GET2 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Unleash Change Requests API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKey).
It accepts HTTP bearer tokens (bearerToken).
By default, every request must be authenticated.
apiKey— API key needed to access this APIbearerToken— API key needed to access this API, in Bearer token format
Paths & Operations 20
Across 17 paths, the API surfaces 20 operations — 2 DELETE, 11 GET, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Change Requests 20
API for managing [change requests](https://docs.getunleash.io/concepts/change-requests).
GET
/api/admin/projects/{projectId}/change-requests/config
Retrieves Change Request Configuration for a Project
PUT
/api/admin/projects/{projectId}/environments/{environment}/change-requests/config
Updates Change Request Configuration for an Environment in the Project
GET
/api/admin/projects/{projectId}/change-requests/scheduled
Get Scheduled Change Requests Matching a Query.
POST
/api/admin/projects/{projectId}/environments/{environment}/change-requests
Create/add Change to a Change Request
GET
/api/admin/projects/{projectId}/change-requests/count
Retrieves Number of Project Change Requests in Each State
GET
/api/admin/projects/{projectId}/change-requests/opendeprecated
Retrieves Pending Change Requests in Configured Environments
GET
/api/admin/projects/{projectId}/change-requests/pending
Retrieves Pending Change Requests in Configured Environments
GET
/api/admin/projects/{projectId}/change-requests
Retrieves All Change Requests for a Project
GET
/api/admin/projects/{projectId}/change-requests/pending/{featureName}
Retrieves All Pending Change Requests Referencing a Feature in the Project
GET
/api/admin/projects/{projectId}/change-requests/{id}
Retrieves One Change Request by ID
DELETE
/api/admin/projects/{projectId}/change-requests/{id}
Deletes a Change Request by ID
DELETE
/api/admin/projects/{projectId}/change-requests/{changeRequestId}/changes/{changeId}
Discards a Change From a Change Request by Change ID
PUT
/api/admin/projects/{projectId}/change-requests/{changeRequestId}/changes/{changeId}
Edits a Single Change in a Change Request
PUT
/api/admin/projects/{projectId}/change-requests/{id}/state
This Endpoint Will Update the State of a Change Request
PUT
/api/admin/projects/{projectId}/change-requests/{id}/title
This Endpoint Will Update the Custom Title of a Change Request
PUT
/api/admin/projects/{projectId}/change-requests/{id}/approvers
This Endpoint Will Update the Reviewers of a Change Request
GET
/api/admin/projects/{projectId}/change-requests/{id}/approvers
This Endpoint Fetches the Requested Approvers of a Change Request
POST
/api/admin/projects/{projectId}/change-requests/{id}/comments
This Endpoint Will Add a Comment to a Change Request
GET
/api/admin/projects/{projectId}/change-requests/available-reviewers/{environment}
This Endpoint Will Return Users Available to Review/approve This Change Request
GET
/api/admin/search/change-requests
Search Change Requests
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are createFeatureStrategySchema (8 properties), changeRequestSegmentChangeSchema (8 properties), changeRequestChangeSchema (7 properties), constraintSchema (6 properties). Each schema is shown below with its type and property counts.
updateFeatureStrategySchema
object
Update a strategy configuration in a feature
6 properties
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
changeRequestConfigSchema
array
A list of environment-specific [change request](https://docs.getunleash.io/concepts/change-requests) configurations.
changeRequestsSchema
array
A list of change requests
upsertSegmentSchema
object
Data used to create or update a segment
4 properties
2 required
changeRequestCreateSchema
object
Data used to create a [change request](https://docs.getunleash.io/concepts/change-requests) for a single feature or segment change.
scheduledChangeRequestViewModelSchema
object
A change request view model, used in the UI to identify change requests in conflict
3 properties
2 required
changeRequestScheduleSchema
object
A schedule for a change request's application. The schedule can either be pending, failed, or suspended. The schedule will always contain the state of the sche…
changeRequestsCountSchema
object
Count of change requests in different stages of the [process](https://docs.getunleash.io/concepts/change-requestschange-request-flow).
6 properties
6 required
changeRequestCommentSchema
object
A comment belonging to a [change request](https://docs.getunleash.io/concepts/change-requests).
4 properties
3 required
changeRequestEnvironmentConfigSchema
object
The [change request](https://docs.getunleash.io/concepts/change-requests) configuration for a specific environment.
4 properties
4 required
changeRequestSearchItemSchema
object
A single change request item in search results.
updateChangeRequestEnvironmentConfigSchema
object
Data used to update change request in an environment
2 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
changeRequestSegmentChangeSchema
object
A change request segment change, containing info about the type of segment change and the specific changes.
8 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
changeRequestChangeSchema
object
A change request change, containing info about the type of change and the specific changes.
7 properties
2 required
changeRequestDefaultChangeSchema
object
A description of a default change that will be applied with the change request to prevent invalid states. Default changes are changes that are applied in addit…
2 properties
2 required
createDependentFeatureSchema
object
Feature dependency on a parent feature in write model
3 properties
1 required
releasePlanTemplateIdSchema
object
Schema for creating a release plan for a feature flag environment by copying and applying the configuration from a release plan template.
1 property
1 required
changeRequestScheduledResultSchema
array
A list of scheduled change request view models
changeRequestOneOrManyCreateSchema
Either a single change or a list of changes to create a change request from.
changeRequestSearchResponseSchema
object
Response containing a list of change requests and total count.
2 properties
2 required
setStrategySortOrderSchema
array
An array of strategies with their new sort order
createFeatureStrategySchema
object
Create a strategy configuration in a feature
8 properties
1 required
transitionConditionSchema
object
A transition condition for milestone progression
1 property
1 required
changeRequestAvailableReviewersSchema
object
A list of users available to review a change request.
1 property
1 required
parametersSchema
object
A list of parameters for a strategy
changeRequestApprovalSchema
object
Information about a [change request](https://docs.getunleash.io/concepts/change-requests) approval.
2 properties
2 required
changeRequestSchema
object
A [change request](https://docs.getunleash.io/concepts/change-requests)
safeguardTriggerConditionSchema
object
The condition that triggers the safeguard.
2 properties
2 required
changeRequestFeatureSchema
object
A feature and all its suggested changes.
4 properties
2 required
createSafeguardSchema
object
Request body to create a safeguard with metric-based alert condition.
2 properties
2 required
changeRequestReviewerSchema
object
Information about a user available to review a change request
5 properties
2 required
changeRequestAddCommentSchema
object
Data used to add a comment to a [change request](https://docs.getunleash.io/concepts/change-requests).
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Unleash 12
Other APIs Unleash publishes across the network.
Unleash Client API
Unleash Addons API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Auth API
Unleash Banners API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Events API
Unleash Feature Types API
#Change Requests