Skip to navigation

Get Connection Proxy Info

Returns the proxy contract for a connection.

Use this endpoint before calling POST /api/connections/{id}/proxy when you need to build requests programmatically. The response shows:

  • the inherited base URL that all proxied requests are sent to
  • locked headers and query parameters that are attached automatically
  • blocked request and response headers
  • allowed HTTP methods and body shapes
  • timeout, rate-limit, and payload-size limits

Some connections reach more than one upstream API, each with its own base URL and quota. For these, the response includes apis: one entry per API with its name, description, whether it is the default, and its own inheritedBase. The top-level inheritedBase describes the default API. Connections with a single API omit apis.

Sensitive inherited header and query values are redacted in the response. The contract is still useful for discovering which keys are fixed by the connection, even though their raw values are not exposed.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection whose proxy contract should be returned.

Headers

X-Polytomic-VersionstringOptional

Response

OK
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error