Change Requests
API for managing change requests.
ποΈ Retrieves change request configuration for a project
Given a projectId, this endpoint will retrieve change request configuration for the project
ποΈ Updates change request configuration for an environment in the project
This endpoint will change the change request configuration for a given environment, set it to either on/off and optionally configure the number of approvals needed. The minimum number of approvals is 1 and the maximum number is 10. If you provide a number higher than 10 or lower than 1, Unleash will clamp it to the allowed range.
ποΈ Get scheduled change requests matching a query.
This endpoint retrieves basic information about all scheduled change requests that match the search criteria provided in the query parameters. The endpoint will return any change request that matches one or more of the provided parameters. If you use no query parameters, you'll get an empty list.
ποΈ Create/Add change to a change request
Given a change request exists, this endpoint will attempt to add a change to
ποΈ Retrieves number of project change requests in each state
This endpoint will retrieve the number of project change requests that are: approved, applied, rejected, scheduled or awaiting review
ποΈ Retrieves pending change requests in configured environments
This endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.
ποΈ Retrieves pending change requests in configured environments
This endpoint will retrieve the pending change requests in the configured environments for the project, for the current user performing the request.
ποΈ Retrieves all change requests for a project
This endpoint will retrieve all change requests regardless of status for a given project. There's an upper limit of last 300 change requests ordered by creation date.
ποΈ Retrieves all pending change requests referencing a feature in the project
This endpoint will retrieve all pending change requests (change requests with a status of Draft | In review | Approved) referencing the given feature flag name.
ποΈ Retrieves one change request by id
This endpoint will retrieve one change request if it matches the provided id.
ποΈ Deletes a change request by id
This endpoint will delete one change request if it matches the provided id.
ποΈ Discards a change from a change request by change id
This endpoint will discard one change from a change request if it matches the provided id.
ποΈ Edits a single change in a change request
This endpoint will edit one change from a change request if it matches the provided id. The edit removes previous change and inserts a new one. You
ποΈ This endpoint will update the state of a change request
This endpoint will update the state of a change request if the business rules allow it. The state can be one of the following: Draft, In review, Approved, Cancelled, Applied. In order to be approved, the change request must have at least one change and the number of approvals must be greater than or equal to the number of approvals required for the environment.
ποΈ This endpoint will update the custom title of a change request
Change requests get a default title e.g. Change Request #1. This endpoint allows to make the title
ποΈ This endpoint will add a comment to a change request
This endpoint will add a comment to a change request for the user making the request.