Skip to main content
ZStack
Infrastructure/Installer

TestInstallerDepotConnection

Test connectivity to the configured depot and return the result

POST/api/v1/installer/depot/test-connection

Operation ID

TestInstallerDepotConnection

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

Body Fields

  • config
    ObjectRequired

    Optional: probe this config directly instead of the saved one. When provided, no state is mutated (ad-hoc test for "did I type the server address right?" flows). When omitted, the currently saved config is tested and DepotConnected / DepotConnAt are refreshed on success (back-compat with older clients that send an empty body). Token masking mirrors SetDepotConfig: a MaskedValue token is resolved from saved state so edits don't require re-entering the token.

    • mode
      String

      Depot access mode: "online" for upstream, "dir" for local directory

      Example: online

    • token
      String

      Bearer token for authenticating with the upstream depot (masked in responses)

      Example: ****

    • baseUrl
      String

      Base URL of the upstream depot service

      Example: https://depot.example.com

    • localDir
      String

      Local directory path when mode is "dir"

      Example: /opt/packages

    • channel
      String

      Optional channel filter for package listing

      Example: stable

    • httpProxy
      String

      Optional HTTP proxy URL for depot access

      Example: http://proxy.example.com:3128

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • connected
    Boolean

    Whether the depot is reachable with the current configuration

    Example: true

  • connectedAt
    String

    Connected at

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