POpolytomic
Connections

Update Connection Proxy Settings

Changed on

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

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the connection whose proxy settings should be updated

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

Headers

X-Polytomic-Versionstring

Request body

enabledboolean required

Whether the connection can be used through the Connection Proxy API

Response

OK

Example response

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

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status