Skip to main content
ZStack
Infrastructure/OTA Upgrade Plans

Precheck

Run pre-upgrade compatibility checks against the target version

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

Operation ID

Precheck

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 upgrade plan to run the precheck for

Body Fields

  • item
    StringRequired

    Optional specific precheck item to run

    Example: agent-connectivity

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • allowed
    Boolean

    Whether the upgrade is allowed to proceed based on precheck results

    Example: true

  • items
    List

    Collection of result items

    Example: (nested array)

    • name
      String

      Name of the individual precheck item

      Example: agent-connectivity

    • passed
      Boolean

      Whether this check item passed

      Example: true

    • message
      String

      Human-readable message describing the check result

      Example: All agents are reachable

    • fix
      String

      Suggested remediation action if the check did not pass

      Example: Ensure all agents have active heartbeats before proceeding