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

Get Connection Proxy Info

GET
https://app.polytomic.com/api/connections/:id/proxy/info
GET
/api/connections/:id/proxy/info
$curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/proxy/info \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "data": {
3    "backendType": "salesforce",
4    "connectionId": "248df4b7-aa70-47b8-a036-33ac447e668d",
5    "inheritedBase": {
6      "baseUrl": "https://api.salesforce.com/v52.0/",
7      "lockedHeaders": [
8        {
9          "name": "Authorization",
10          "redacted": true,
11          "value": "[REDACTED]"
12        },
13        {
14          "name": "Content-Type",
15          "redacted": false,
16          "value": "application/json"
17        }
18      ],
19      "lockedQuery": {
20        "api_key": "[REDACTED]",
21        "version": "52.0"
22      }
23    },
24    "mergeRules": {
25      "headers": "override",
26      "query": "merge"
27    },
28    "requestContract": {
29      "allowedMethods": [
30        "GET",
31        "POST",
32        "PATCH",
33        "DELETE"
34      ],
35      "blockedRequestHeaders": [
36        "Cookie",
37        "Set-Cookie"
38      ],
39      "blockedResponseHeaders": [
40        "Set-Cookie",
41        "X-Powered-By"
42      ],
43      "bodyTypes": [
44        "object",
45        "null"
46      ],
47      "maxRequestBodyBytes": 1048576,
48      "maxResponseBodyBytes": 5242880,
49      "pathRule": "^/services/data/v52\\.0/.*$",
50      "queryModes": [
51        "query",
52        "rawQuery"
53      ],
54      "queryValueTypes": [
55        "string",
56        "number",
57        "boolean"
58      ],
59      "rateLimitPerMinute": 1200,
60      "rawQueryRule": "append; caller encodes",
61      "timeoutMs": 30000
62    },
63    "stats": {
64      "callsLast24h": 3500,
65      "lastProxyCallAt": "2024-04-26T14:45:00Z",
66      "proxy2xxLast24h": 3400,
67      "proxy4xxLast24h": 80,
68      "proxy5xxLast24h": 20,
69      "proxyCallsLast24h": 3500
70    }
71  }
72}
Returns the proxy contract for a connection. Use this endpoint before calling [`POST /api/connections/{id}/proxy`](../../../../../api-reference/connections/execute-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 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.
Was this page helpful?
Previous

List Current Org Shared Connections

Next

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

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
dataobject

Errors

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