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

SetDepotConfig

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

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • configObjectRequired

    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

    • 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

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

PUT/api/v1/lifecycle/depot/config

/api/v1/lifecycle/depot/config

Operation ID

SetDepotConfig

Permalink

Request Example

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

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history