For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
Logo
GuidesAPI Reference
  • API Reference
      • GETGet Connection Types
      • GETGet Connection Type
      • POSTConnection Type Parameter Values
      • GETList Connections
      • POSTCreate Connection
      • POSTConnect
      • POSTTest Connection
      • GETGet Connection
      • PUTUpdate Connection
      • DELDelete Connection
      • GETConnection Parameter Values
      • POSTExecute Connection Proxy
      • GETGet Connection Proxy Info
      • GETList Current Org Shared Connections
      • GETList Partner Shared Connections
      • POSTCreate Partner Shared Connection
Log inBook a demo
API ReferenceConnections

Execute Connection Proxy

POST
https://app.polytomic.com/api/connections/:id/proxy
POST
/api/connections/:id/proxy
$curl -X POST https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/proxy \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "request": {
>    "method": "GET",
>    "path": "/v1/objects"
>  }
>}'
1{
2  "data": {
3    "body": "{\"items\":[{\"id\":\"12345\",\"name\":\"Sample Object\"}]}",
4    "contentType": "application/json",
5    "headers": {},
6    "jobId": "a3f1c2d4-5b67-4e89-9f01-23456789abcd",
7    "jobStatus": "created",
8    "jobUrl": "https://app.polytomic.com/api/jobs/connectionproxy/a3f1c2d4-5b67-4e89-9f01-23456789abcd",
9    "latencyMs": 150,
10    "proxyCallId": "b7e8f9a0-1234-4c56-8d90-abcdef123456",
11    "status": 200,
12    "truncated": true
13  }
14}
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`](../../../../api-reference/connections/get-proxy-info) to inspect the inherited base URL, blocked headers, accepted body types, and size and rate limits. ## Important behavior - `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`. 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}`](../../../../api-reference/jobs/get-job) 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.
Was this page helpful?
Previous

Get Connection Proxy Info

Next

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

  • 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.

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
dataobject

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