Skip to main content
Infrastructure/OTA Upgrade Plans

PauseGraduatedPlan

Pause Graduated Plan

POST/api/v1/lifecycle/upgrade-plans/{planId}/pause

Operation ID

PauseGraduatedPlan

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

Path Parameters

  • planId
    StringRequired

    ID of the graduated plan to pause

Body Fields

  • reason
    StringRequired

    Reason for pausing the plan

    Example: Investigating elevated error rate in batch 2

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.