Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Versions & Policies
GETOTASince 1.0SynchronousAuth Required

ListPreflightResults

List Preflight Results

Execution Availability

Try It Out

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

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • planIdStringRequired

    ID of the upgrade plan to list preflight history for

Query Parameters

  • pageSizeInteger

    Maximum number of preflight results to return

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • planIdString

      ID of the upgrade plan this preflight result covers

      Example: plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • modeString

      Mode used for this preflight run

      Example: strict

    • totalAgentsInteger

      Total number of agents evaluated during preflight

      Example: 20

    • healthyAgentsInteger

      Number of agents that passed all preflight checks

      Example: 19

    • unhealthyAgentsInteger

      Number of agents that failed one or more preflight checks

      Example: 1

    • healthyPctLong

      Percentage of agents that passed preflight checks

      Example: 95

    • decisionString

      Gate decision based on the configured minimum healthy percentage

      Example: proceed

    • excludedAgentIdsList

      Excluded agent ids

      Example: item1,item2

    • agentResultsList

      Agent results

      Example: (nested array)

      • agentIdString

        ID of the agent this preflight result belongs to

        Example: lca-node01.example.com

      • agentNameString

        Display name of the agent node

        Example: node01

      • healthyBoolean

        Whether this agent passed all preflight checks

        Example: true

      • checkResultsLinkedHashMap

        Preflight check result entries

        Example: (nested object)

      • failReasonsList

        Fail reasons

        Example: item1,item2

    • checkedAtString

      Checked at

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

    • durationMsString

      Duration of the preflight run in milliseconds

      Example: 4800

  • totalInteger

    Total number of preflight results for this plan

    Example: 5

  • limitInteger

    Maximum number of items returned per page

    Example: 10

  • offsetInteger

    Number of items skipped before the current page

    Example: 20

Endpoint

GET/api/v1/ota/plans/{planId}/preflight/history

/api/v1/ota/plans/{planId}/preflight/history

Operation ID

ListPreflightResults

Permalink

Request Example

curl -X GET '{host}/api/v1/ota/plans/{planId}/preflight/history' -H 'Authorization: Bearer {token}'

Response Example

200
{"items": [{"planId": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "mode": "strict", "totalAgents": 20, "healthyAgents": 19, "unhealthyAgents": 1, "healthyPct": 95.0, "decision": "proceed", "excludedAgentIds": ["value"]}], "total": 5, "limit": 10, "offset": 20}

Change History

This API has no change history records yet.

View all change history