Skip to main content
ZStack
Infrastructure/Change Management

CloseChangeRequest

Close a change request and generate a post-change report

POST/api/v1/change-management/change-requests/{crId}/close

Operation ID

CloseChangeRequest

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • crId
    StringRequired

    ID of the change request to close and generate a report for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • crId
    String

    ID of the change request this report covers

    Example: cr-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • actualDurationMinutes
    Integer

    Actual duration of the change window in minutes

    Example: 45

  • suppressedAlertCount
    Integer

    Total count of alerts suppressed during the change window

    Example: 7

  • unexpectedAlertCount
    Integer

    Count of alerts that fired outside the expected set

    Example: 1

  • impactAsExpected
    Boolean

    Whether the actual impact matched the planned impact scope

    Example: true

  • lessonsLearnedTemplate
    String

    Pre-filled lessons-learned template for post-change review

    Example: ## What went well ## What could be improved

  • generatedAt
    String

    Generated at

    Example: 2026-01-15T08:00:00Z