Skip to main content
API Explorer|API Explorer
Infrastructure/Lifecycle
GETLifecycleSince 1.0SynchronousAuth Required

GetDepotConfig

Retrieve the current depot configuration including mode and endpoint

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.

  • 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

  • channelString

    Optional channel filter for package listing

    Example: stable

  • localDirString

    Local directory path when mode is "dir"

    Example: /opt/depot/packages

  • httpProxyString

    Optional HTTP proxy URL for depot access

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

Endpoint

GET/api/v1/lifecycle/depot/config

/api/v1/lifecycle/depot/config

Operation ID

GetDepotConfig

Permalink

Request Example

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

Response Example

200
{
  "mode": "online",
  "token": "****",
  "baseUrl": "https://depot.example.com",
  "channel": "stable",
  "localDir": "/opt/depot/packages",
  "httpProxy": "http://proxy.example.com:3128"
}

Change History

This API has no change history records yet.

View all change history