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

GetChangeLiveStatus

Get real-time status of an in-progress change including unexpected alerts

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 in-progress change request to monitor

Responses

200 OK

On success, this API returns the following response structure.

  • crIdString

    ID of the change request being monitored

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

  • elapsedMinutesLong

    Minutes elapsed since the change window opened

    Example: 12.5

  • suppressedAlertCountInteger

    Number of alerts suppressed during this change window

    Example: 4

  • unexpectedAlertsList

    Unexpected alerts

    Example: (nested array)

    • alertIdString

      Unique identifier of the alert instance

      Example: alert-xyz789

    • ruleNameString

      Name of the alert rule that triggered this alert

      Example: HighCPUUsage

    • severityString

      Severity level of the alert

      Example: warning

    • firedAtString

      Fired at

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

  • changePhaseString

    Current execution phase of the change window

    Example: executing

Endpoint

GET/api/v1/change-management/change-requests/{crId}/live-status

/api/v1/change-management/change-requests/{crId}/live-status

Operation ID

GetChangeLiveStatus

Permalink

Request Example

curl -X GET '{host}/api/v1/change-management/change-requests/{crId}/live-status' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "crId": "cr-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "elapsedMinutes": 12.5,
  "suppressedAlertCount": 4,
  "unexpectedAlerts": [
    {}
  ],
  "changePhase": "executing"
}

Change History

This API has no change history records yet.

View all change history