Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Upgrade Plans
POSTOTASince 1.0SynchronousAuth Required

Precheck

Run pre-upgrade compatibility checks against the target version

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • planIdStringRequired

    ID of the upgrade plan to run the precheck for

Body Fields

  • itemStringRequired

    Optional specific precheck item to run

    Example: agent-connectivity

Responses

200 OK

On success, this API returns the following response structure.

  • allowedBoolean

    Whether the upgrade is allowed to proceed based on precheck results

    Example: true

  • itemsList

    Collection of result items

    Example: (nested array)

    • nameString

      Name of the individual precheck item

      Example: agent-connectivity

    • passedBoolean

      Whether this check item passed

      Example: true

    • messageString

      Human-readable message describing the check result

      Example: All agents are reachable

    • fixString

      Suggested remediation action if the check did not pass

      Example: Ensure all agents have active heartbeats before proceeding

Endpoint

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

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

Operation ID

Precheck

Permalink

Request Example

curl -X POST '{host}/api/v1/lifecycle/upgrade-plans/{planId}/precheck' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"item":"agent-connectivity"}'

Response Example

200
{"allowed": true, "items": [{"name": "agent-connectivity", "passed": true, "message": "All agents are reachable", "fix": "Ensure all agents have active heartbeats before proceeding"}]}

Change History

This API has no change history records yet.

View all change history