Skip to main content
API Explorer|API Explorer
Infrastructure/Change Management
POSTChangeManagementSince 1.0SynchronousAuth Required

CloseChangeRequest

Close a change request and generate a post-change report

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • crIdStringRequired

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

Responses

200 OK

On success, this API returns the following response structure.

  • crIdString

    ID of the change request this report covers

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

  • actualDurationMinutesInteger

    Actual duration of the change window in minutes

    Example: 45

  • suppressedAlertCountInteger

    Total count of alerts suppressed during the change window

    Example: 7

  • unexpectedAlertCountInteger

    Count of alerts that fired outside the expected set

    Example: 1

  • impactAsExpectedBoolean

    Whether the actual impact matched the planned impact scope

    Example: true

  • lessonsLearnedTemplateString

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

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

  • generatedAtString

    Generated at

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

Endpoint

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

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

Operation ID

CloseChangeRequest

Permalink

Request Example

curl -X POST '{host}/api/v1/change-management/change-requests/{crId}/close' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "crId": "cr-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "actualDurationMinutes": 45,
  "suppressedAlertCount": 7,
  "unexpectedAlertCount": 1,
  "impactAsExpected": true,
  "lessonsLearnedTemplate": "## What went well\n## What could be improved\n",
  "generatedAt": "example"
}

Change History

This API has no change history records yet.

View all change history