Skip to main content

Updates change request configuration for an environment in the project

PUT <your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests/config

Authorization

name: Authorizationtype: apiKeyin: header

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.

Request

Path Parameters

  • projectId string required
  • environment string required

Body

required

updateChangeRequestEnvironmentConfigSchema

  • changeRequestsEnabled boolean required

    true if change requests should be enabled, otherwise false.

  • requiredApprovals integer

    The number of approvals required before a change request can be applied in this environment.

Responses

This response has no body.

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
<your-unleash-url>
apiKey
projectId — path required
environment — path required
Body required
{
"changeRequestsEnabled": true,
"requiredApprovals": 3
}
curl / cURL
curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests/config' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"changeRequestsEnabled": true,
"requiredApprovals": 3
}'