How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

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 API
  • bearerToken — 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
getProjectChangeRequestConfig 1 param → 200
PUT
/api/admin/projects/{projectId}/environments/{environment}/change-requests/config
Updates Change Request Configuration for an Environment in the Project
updateProjectChangeRequestConfig 2 params body → 200
GET
/api/admin/projects/{projectId}/change-requests/scheduled
Get Scheduled Change Requests Matching a Query.
getScheduledChangeRequests 1 param → 200404
POST
/api/admin/projects/{projectId}/environments/{environment}/change-requests
Create/add Change to a Change Request
changeRequest 2 params body → 200400
GET
/api/admin/projects/{projectId}/change-requests/count
Retrieves Number of Project Change Requests in Each State
getChangeRequestsCount 1 param → 200
GET
/api/admin/projects/{projectId}/change-requests/opendeprecated
Retrieves Pending Change Requests in Configured Environments
getOpenChangeRequestsForUser 1 param → 200
GET
/api/admin/projects/{projectId}/change-requests/pending
Retrieves Pending Change Requests in Configured Environments
getPendingChangeRequestsForUser 1 param → 200
GET
/api/admin/projects/{projectId}/change-requests
Retrieves All Change Requests for a Project
getChangeRequestsForProject 1 param → 200
GET
/api/admin/projects/{projectId}/change-requests/pending/{featureName}
Retrieves All Pending Change Requests Referencing a Feature in the Project
getPendingChangeRequestsForFeature 2 params → 200
GET
/api/admin/projects/{projectId}/change-requests/{id}
Retrieves One Change Request by ID
getChangeRequest 2 params → 200404
DELETE
/api/admin/projects/{projectId}/change-requests/{id}
Deletes a Change Request by ID
deleteChangeRequest 2 params → 200
DELETE
/api/admin/projects/{projectId}/change-requests/{changeRequestId}/changes/{changeId}
Discards a Change From a Change Request by Change ID
deleteChange 3 params → 200
PUT
/api/admin/projects/{projectId}/change-requests/{changeRequestId}/changes/{changeId}
Edits a Single Change in a Change Request
editChange 3 params body → 200404
PUT
/api/admin/projects/{projectId}/change-requests/{id}/state
This Endpoint Will Update the State of a Change Request
updateChangeRequestState 2 params → 200
PUT
/api/admin/projects/{projectId}/change-requests/{id}/title
This Endpoint Will Update the Custom Title of a Change Request
updateChangeRequestTitle 2 params → 204
PUT
/api/admin/projects/{projectId}/change-requests/{id}/approvers
This Endpoint Will Update the Reviewers of a Change Request
addChangeRequestReviewers 2 params → 204
GET
/api/admin/projects/{projectId}/change-requests/{id}/approvers
This Endpoint Fetches the Requested Approvers of a Change Request
getChangeRequestApprovers 2 params → 200
POST
/api/admin/projects/{projectId}/change-requests/{id}/comments
This Endpoint Will Add a Comment to a Change Request
addChangeRequestComment 2 params body → 204
GET
/api/admin/projects/{projectId}/change-requests/available-reviewers/{environment}
This Endpoint Will Return Users Available to Review/approve This Change Request
getAvailableChangeRequestReviewers 2 params → 200
GET
/api/admin/search/change-requests
Search Change Requests
searchChangeRequests 5 params → 200401403404

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), variantSchema (6 properties). Each schema is shown below with its type and property counts.

createFeatureStrategySchema
object
Create a strategy configuration in a feature
8 properties 1 required
safeguardTriggerConditionSchema
object
The condition that triggers the safeguard.
2 properties 2 required
changeRequestSchema
object
A [change request](https://docs.getunleash.io/concepts/change-requests)
changeRequestReviewerSchema
object
Information about a user available to review a change request
5 properties 2 required
setStrategySortOrderSchema
array
An array of strategies with their new sort order
upsertSegmentSchema
object
Data used to create or update a segment
4 properties 2 required
createSafeguardSchema
object
Request body to create a safeguard with metric-based alert condition.
2 properties 2 required
changeRequestCommentSchema
object
A comment belonging to a [change request](https://docs.getunleash.io/concepts/change-requests).
4 properties 3 required
changeRequestCreateSchema
object
Data used to create a [change request](https://docs.getunleash.io/concepts/change-requests) for a single feature or segment change.
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
changeRequestsSchema
array
A list of change requests
changeRequestSegmentChangeSchema
object
A change request segment change, containing info about the type of segment change and the specific changes.
8 properties 4 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
changeRequestEnvironmentConfigSchema
object
The [change request](https://docs.getunleash.io/concepts/change-requests) configuration for a specific environment.
4 properties 4 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
updateFeatureStrategySchema
object
Update a strategy configuration in a feature
6 properties
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…
changeRequestChangeSchema
object
A change request change, containing info about the type of change and the specific changes.
7 properties 2 required
changeRequestFeatureSchema
object
A feature and all its suggested changes.
4 properties 2 required
changeRequestScheduledResultSchema
array
A list of scheduled change request view models
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
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
changeRequestApprovalSchema
object
Information about a [change request](https://docs.getunleash.io/concepts/change-requests) approval.
2 properties 2 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
changeRequestConfigSchema
array
A list of environment-specific [change request](https://docs.getunleash.io/concepts/change-requests) configurations.
changeRequestAddCommentSchema
object
Data used to add a comment to a [change request](https://docs.getunleash.io/concepts/change-requests).
1 property 1 required
changeRequestAvailableReviewersSchema
object
A list of users available to review a change request.
1 property 1 required
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
scheduledChangeRequestViewModelSchema
object
A change request view model, used in the UI to identify change requests in conflict
3 properties 2 required
overrideSchema
object
An override for deciding which variant should be assigned to a user based on the context name
2 properties 2 required
parametersSchema
object
A list of parameters for a strategy
changeRequestSearchResponseSchema
object
Response containing a list of change requests and total count.
2 properties 2 required
changeRequestOneOrManyCreateSchema
Either a single change or a list of changes to create a change request from.
createDependentFeatureSchema
object
Feature dependency on a parent feature in write model
3 properties 1 required
transitionConditionSchema
object
A transition condition for milestone progression
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-change-requests-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Unleash Change Requests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.