Skip to main content
Infrastructure/Lifecycle

SetDepotConfig

Update the depot configuration with new mode, URL, or credentials

PUT/api/v1/lifecycle/depot/config

Operation ID

SetDepotConfig

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

    Configuration data as key-value pairs

    • 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

    • channel
      String

      Optional channel filter for package listing

      Example: stable

    • localDir
      String

      Local directory path when mode is "dir"

      Example: /opt/depot/packages

    • 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 an empty JSON object {}.