Skip to main content
ZStack
Infrastructure/Change Management

TriggerRecovery

Manually trigger a recovery run to resolve stale change requests

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

Operation ID

TriggerRecovery

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

application/json

Body Fields

  • force
    BooleanRequired

    If true, force recovery even if it was recently run

    Example: false

  • targetStatuses
    ListRequired

    Target statuses

    Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • recoveredAt
    String

    Recovered at

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

  • recoveredCount
    Integer

    Number of stale change requests successfully recovered

    Example: 5

  • timeoutProcessed
    Integer

    Number of change requests that timed out and were processed

    Example: 2

  • errorCount
    Integer

    Number of errors encountered during the recovery run

    Example: 20

  • recoveryDurationMs
    String

    Total duration of the recovery operation in milliseconds

    Example: 312