Create/Add change to a change request
POST <your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Given a change request exists, this endpoint will attempt to add a change to an existing change request for the user. If a change request does not exist. It will attempt to create it.
Request
Path Parameters
- projectId string required
- environment string required
- application/json
Body
required
changeRequestOneOrManyCreateSchema
- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
- MOD8
- MOD9
- MOD10
- MOD11
- MOD12
- action string required
Possible values: [
updateSegment
]The name of this action.
payload objectrequired
- action string required
Possible values: [
deleteSegment
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
updateEnabled
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
addStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
updateStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
deleteStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
archiveFeature
]The name of this action.
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
patchVariant
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
reorderStrategy
]The name of this action.
payload object[]required
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
addDependency
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
deleteDependency
]The name of this action.
- Array [
- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
- MOD8
- MOD9
- MOD10
- MOD11
- action string required
Possible values: [
updateSegment
]The name of this action.
payload objectrequired
- action string required
Possible values: [
deleteSegment
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
updateEnabled
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
addStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
updateStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
deleteStrategy
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
archiveFeature
]The name of this action.
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
patchVariant
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
reorderStrategy
]The name of this action.
payload object[]required
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
addDependency
]The name of this action.
payload objectrequired
- feature string required
The name of the feature that this change applies to.
- action string required
Possible values: [
deleteDependency
]The name of this action.
- ]
- 200
changeRequestSchema
- application/json
- Schema
Schema
- MOD1
- MOD2
- id number required
This change requests's ID.
- title string
A title describing the change request's content.
- environment string required
The environment in which the changes should be applied.
- minApprovals number required
The minimum number of approvals required before this change request can be applied.
- project string required
The project this change request belongs to.
features object[]required
segments object[]required
approvals object[]
rejections object[]
comments object[]
createdBy objectrequired
- createdAt date-time required
When this change request was created.
- state string required
Possible values: [
Draft
,In review
,Approved
,Applied
,Cancelled
,Rejected
]The current state of the change request.
- id number required
This change requests's ID.
- title string
A title describing the change request's content.
- environment string required
The environment in which the changes should be applied.
- minApprovals number required
The minimum number of approvals required before this change request can be applied.
- project string required
The project this change request belongs to.
features object[]required
segments object[]required
approvals object[]
rejections object[]
comments object[]
createdBy objectrequired
- createdAt date-time required
When this change request was created.
- state string required
Possible values: [
Scheduled
]The current state of the change request.
schedule objectrequired
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'
curl -L -X POST '<your-unleash-url>/api/admin/projects/:projectId/environments/:environment/change-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"action": "updateSegment",
"payload": {
"id": 1
}
}'