latestOpenAPI 3.0.32026-08-1963193297.5 KB

a567add0c3f5

proxy

secureProxy

Routes an HTTP request through a VPC with either static IP egress or VPN secure link access. The VPC mode is determined by the referenced secure_proxy use case configuration. For secure_link mode, the target URL must match the use case's allowed_domains whitelist.

post/v1/secure-proxy

Request body

integration_idstring uuid required

Integration ID that owns the secure_proxy use case

use_case_idstring uuid

Use case ID (provide either use_case_id or use_case_slug)

use_case_slugstring

Use case slug (provide either use_case_id or use_case_slug)

urlstring uri required

Target URL to proxy the request to

method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required

HTTP method

headersobject

Request headers to forward

{"stackTrail":"components:schemas:SecureProxyRequest:properties:body","oasType":"schema","type":"unknown","description":"Request body (string or JSON)"}

response_type'json' | 'binary'

Expected response type

Response

Proxied response from the target URL

status_codeinteger

HTTP status code from the upstream response

headersobject

Response headers from upstream

{"stackTrail":"components:schemas:SecureProxyResponse:properties:body","oasType":"schema","type":"unknown","description":"Response body from upstream. When `status_code` is 502 and the target never produced an HTTP response (TLS/connection/DNS failure or timeout), this is a `SecureProxyUpstreamError` describing the underlying cause."}