Retrieves change request configuration for a project

GET 
/api/admin/projects/:projectId/change-requests/config

Given a projectId, this endpoint will retrieve change request configuration for the project

Request

Path Parameters

projectId stringrequired

Responses

200

changeRequestConfigSchema

application/json

Schema

Schema

• Array [

environment stringrequired
The environment that this configuration applies to.
Example: my-dev-environment
type stringrequired
The type of the environment listed in environment.
Example: development
changeRequestEnabled booleanrequired
true if this environment has change requests enabled, otherwise false.
Example: true
requiredApprovals numbernullablerequired
The number of approvals that are required for a change request to be fully approved and ready to be applied in this environment.
Example: 2

• ]

Example (from schema)

[
  {
    "environment": "my-dev-environment",
    "type": "development",
    "changeRequestEnabled": true,
    "requiredApprovals": 2
  }
]

Loading...