v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Connections

Update Connection Proxy Settings

Enables or disables use of a connection through the Connection Proxy API.

The setting is stored on the parent connection. To update proxy access for a shared connection, the caller must have edit permission for the parent connection.

Enabling proxy access requires a backend that supports the Connection Proxy API. If the connection backend is unsupported, the request returns 400 Bad Request. Disabling proxy access is allowed for any connection the caller can edit.

Setting enabled to false prevents proxy calls for the connection.

put/api/connections/{id}/proxy/settings

Path parameters

idstring uuid required

Unique identifier of the connection whose proxy settings should be updated.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the connection whose proxy settings should be updated.

Headers

X-Polytomic-Versionstring

Request body

enabledboolean required

Whether the connection can be used through the Connection Proxy API.

Response

Example response

{
  "data": {
    "connectionId": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "parentConnectionId": "248df4b7-aa70-47b8-a036-33ac447e668d"
  }
}