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

TriggerRecovery

Manually trigger a recovery run to resolve stale change requests

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • forceBooleanRequired

    If true, force recovery even if it was recently run

    Example: false

  • targetStatusesListRequired

    Target statuses

    Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • recoveredAtString

    Recovered at

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

  • recoveredCountInteger

    Number of stale change requests successfully recovered

    Example: 5

  • timeoutProcessedInteger

    Number of change requests that timed out and were processed

    Example: 2

  • errorCountInteger

    Number of errors encountered during the recovery run

    Example: 20

  • recoveryDurationMsString

    Total duration of the recovery operation in milliseconds

    Example: 312

Endpoint

POST/api/v1/change-management/recovery/trigger

/api/v1/change-management/recovery/trigger

Operation ID

TriggerRecovery

Permalink

Request Example

curl -X POST '{host}/api/v1/change-management/recovery/trigger' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"force":false,"targetStatuses":"item1,item2"}'

Response Example

200
{
  "recoveredAt": "example",
  "recoveredCount": 5,
  "timeoutProcessed": 2,
  "errorCount": 20,
  "recoveryDurationMs": 312
}

Change History

This API has no change history records yet.

View all change history