Skip to content

Retrieve and update the container-wide proxy root configuration: the enable_proxy kill-switch and the default allow/deny policy applied when no more-specific rule matches. Both endpoints return an etag and file_version to support optimistic-concurrency control on updates.


GET /api/v1/containers/{id}/proxy/settings

Section titled “GET /api/v1/containers/{id}/proxy/settings”

Returns the current proxy root settings for a container, including the enable_proxy flag, the default policy, the internal file_version, and the etag value required for safe updates.

NameInTypeRequiredDescription
idpathstringYesContainer ID
{
"statusCode": 200,
"message": "Proxy settings retrieved successfully",
"data": {
"enable_proxy": true,
"default": "allow",
"file_version": 3,
"etag": "file:v3"
}
}
const settings = await client.api.proxyDiscovery.getContainerProxySettings({
id: "c8f2e1a4b9d34e6f8a7c1d2e3f4a5b6c",
});

PATCH /api/v1/containers/{id}/proxy/settings

Section titled “PATCH /api/v1/containers/{id}/proxy/settings”

Updates one or both of the proxy root fields (enable_proxy, default). Provide the current etag in the If-Match header to enforce optimistic-concurrency control. At least one body field must be supplied.

NameInTypeRequiredDescription
idpathstringYesContainer ID
if-matchheaderstringNofile:v≤N≥ ETag precondition
FieldTypeRequiredDescription
enable_proxybooleanNoGlobal kill-switch for the container proxy
defaultstringNoDefault policy when no rule matches. One of allow, deny
{
"enable_proxy": true,
"default": "deny"
}
{
"statusCode": 200,
"message": "Proxy settings updated successfully",
"data": {
"enable_proxy": true,
"default": "deny",
"file_version": 4,
"etag": "file:v4"
}
}
const updated = await client.api.proxyDiscovery.updateContainerProxySettings({
id: "c8f2e1a4b9d34e6f8a7c1d2e3f4a5b6c",
"if-match": "file:v3",
data: {
enable_proxy: true,
default: "deny",
},
});