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
apisin the proxy info response), setrequest.apito the name of the API to call. Requests withoutrequest.apigo to the default API.request.apiis rejected for connections that expose a single API. request.pathmust be relative and start with/.- Use either
request.queryorrequest.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
truncatedis set totrue. - A
429means 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
Basic organization-scoped API key
