Skip to navigation

Execute Connection Proxy

Proxies an HTTP request to a connection’s underlying API using the connection’s stored credentials, subject to per-connection rate limits and size caps.

This endpoint is intended for controlled passthrough use, not as a general replacement for Polytomic’s modeled endpoints. The request is executed with the connection’s stored credentials and inherited base URL, headers, and query parameters.

Before building requests dynamically, call GET /api/connections/{id}/proxy/info to inspect the inherited base URL, blocked headers, accepted body types, and size and rate limits.

Important behavior

  • For connections that expose more than one API (listed in apis in the proxy info response), set request.api to the name of the API to call. Requests without request.api go to the default API. request.api is rejected for connections that expose a single API.
  • request.path must be relative and start with /.
  • Use either request.query or request.rawQuery, not both.
  • Caller-supplied headers are merged with inherited headers, but inherited auth headers cannot be overridden.
  • The proxy strips a fixed set of request and response headers for safety.
  • Response bodies larger than the configured maximum are truncated, and truncated is set to true.
  • A 429 means Polytomic’s proxy rate limit was reached, or the connection’s upstream quota, which the proxy shares with the connection’s syncs, is exhausted.

To run a GET request asynchronously, set async to true. The initial response returns status: 202, jobId, jobStatus, and jobUrl. Poll GET /api/jobs/{type}/{id} with type=connectionproxy and the returned jobId until the job is complete. The completed job result includes the upstream status, sanitized headers, contentType, contentLength, latencyMs, and a short-lived bodyDownloadUrl for the upstream response body.

The response includes proxyCallId, which you can use to correlate the call with audit logs.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection to proxy the request through.

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
requestobjectRequired
asyncbooleanOptional
When true, submits a GET request for asynchronous execution and returns a job handle instead of a synchronous upstream response.

Response

OK
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
504
Gateway Timeout Error