Updates change request configuration for an environment in the project

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

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 stringrequired
environment stringrequired

application/json

Bodyrequired

updateChangeRequestEnvironmentConfigSchema

changeRequestsEnabled booleanrequired
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.
Example: 3

Responses

200

This response has no body.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• 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>' \
-d '{
  "changeRequestsEnabled": true,
  "requiredApprovals": 3
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

projectId — pathrequired

environment — pathrequired

Body required

{
  "changeRequestsEnabled": true,
  "requiredApprovals": 3
}

ResponseClear

Click the Send API Request button above and see the response here!