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

GetInstallerDepotConfig

Retrieve the current depot configuration and connection status

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • connectedBoolean

    Whether the installer is currently connected to the depot

    Example: true

  • connectedAtString

    Connected at

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

  • configuredBoolean

    Whether a depot configuration has been saved

    Example: true

  • configObject

    Configuration data as key-value pairs

    • 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

Endpoint

GET/api/v1/installer/depot/config

/api/v1/installer/depot/config

Operation ID

GetInstallerDepotConfig

Permalink

Request Example

curl -X GET '{host}/api/v1/installer/depot/config' -H 'Authorization: Bearer {token}'

Response Example

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

Change History

This API has no change history records yet.

View all change history