Skip to content

deploy module route (requires deploy:deployment:admin)

PUT
/v1/m/deploy/executor/config
curl --request PUT \
--url https://example.com/v1/m/deploy/executor/config \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "credential_ref": "example", "socket_path": "/var/run/docker.sock" }'

Returns HTTP 501 because deployment is a Business feature; no deployment action is performed.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

The handler accepts one JSON document and caps decoding at 256 KiB.

Media type application/json
object
credential_ref
required

A store: reference into this tenant’s sealed secret store; secret values and other schemes are refused.

string
socket_path
string
default: /var/run/docker.sock
Allowed values: /var/run/docker.sock /run/docker.sock

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}