Skip to main content
ZStack
Infrastructure/Installer

GetValidateStatus

Retrieve the current status of a previously initiated validation session

GET/api/v1/installer/validate/status

Operation ID

GetValidateStatus

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

Query Parameters

  • id
    String

    Optional filter to retrieve a specific validate session by ID Optional filter to retrieve a specific validate session by ID

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • status
    String

    Current validation status

    Example: passed

  • session
    Object

    Session for this resource

    • id
      String

      Unique identifier for this precheck session

      Example: precheck-a1b2c3d4

    • status
      String

      Current status of the precheck session

      Example: passed

    • results
      List

      Results for this resource

      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