Skip to main content
API Explorer|API Explorer
Infrastructure/Installer
POSTInstallerSince 1.0SynchronousAuth Required

TestInstallerDepotConnection

Test connectivity to the configured depot and return the result

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • configObjectRequired

    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.

    • modeString

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

      Example: online

    • tokenString

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

      Example: ****

    • baseUrlString

      Base URL of the upstream depot service

      Example: https://depot.example.com

    • localDirString

      Local directory path when mode is "dir"

      Example: /opt/packages

    • channelString

      Optional channel filter for package listing

      Example: stable

    • httpProxyString

      Optional HTTP proxy URL for depot access

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

Responses

200 OK

On success, this API returns the following response structure.

  • connectedBoolean

    Whether the depot is reachable with the current configuration

    Example: true

  • connectedAtString

    Connected at

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

Endpoint

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

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

Operation ID

TestInstallerDepotConnection

Permalink

Request Example

curl -X POST '{host}/api/v1/installer/depot/test-connection' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"config":{"mode":"online","token":"****","baseUrl":"https://depot.example.com","localDir":"/opt/packages","channel":"stable","httpProxy":"http://proxy.example.com:3128"}}'

Response Example

200
{
  "connected": true,
  "connectedAt": "example"
}

Change History

This API has no change history records yet.

View all change history