Sign in

v2

latestOpenAPI 3.0.42026-08-04123200540.7 KB
Change Requests (Approval flow & Scheduled changes) - Beta

Create Change Request

Creates a new Change Request for the specified Config and Environment.

post/v2/configs/{configId}/environments/{environmentId}/change-requests

Path parameters

configIdstring uuid required

The identifier of the Config.

environmentIdstring uuid required

The identifier of the Environment.

Request body

titlestring required

The title of the Change Request.

reasonstring nullable

The optional notes describing the purpose of the Change Request. This will appear in the Audit Log (in the Notes section when you expand the corresponding entry) upon applying the change request.

applyAtstring date-time nullable

The optional UTC date and time when the scheduled Change Request should be applied automatically.

bypassApprovalboolean

When true, bypasses required approval checks for scheduled changes.

Response

When the creation was successful.

changeRequestIdinteger required

Identifier of the Change Request.

configIdstring uuid required

Identifier of the Config.

environmentIdstring uuid required

Identifier of the Environment.

changeRequestStatus'open' | 'applied' | 'closed' required

The lifecycle status of a Change Request.

needsAttentionboolean required

Indicates whether the Change Request needs attention.

titlestring required

Title of the Change Request.

reasonstring nullable required

Optional notes describing the purpose of the Change Request.

applyAtstring date-time nullable required

Optional UTC date and time when the Change Request should be applied automatically.

createdAtstring date-time required

The UTC date and time when the Change Request was created.

creatorUserEmailstring required

Email of the user who created the Change Request.

creatorUserFullNamestring required

Full name of the user who created the Change Request.

creatorUserIdstring nullable required

Identifier of the creator user.

approvedboolean required

Indicates whether the Change Request has been approved.

appliedAtstring date-time nullable required

Optional UTC date and time when the Change Request was applied.

appliedByUserIdstring nullable required

Identifier of the user who applied the Change Request.

appliedByUserEmailstring nullable required

Email of the user who applied the Change Request.

appliedByUserFullNamestring nullable required

Full name of the user who applied the Change Request.

closedAtstring date-time nullable required

Optional UTC date and time when the Change Request was closed.

closedByUserIdstring nullable required

Identifier of the user who closed the Change Request.

closedByUserEmailstring nullable required

Email of the user who closed the Change Request.

closedByUserFullNamestring nullable required

Full name of the user who closed the Change Request.

bypassApprovalboolean required

Indicates whether approval flow is bypassed.