GET
/
proxy
/
{anyPath}
curl --request GET \
  --url https://api.nango.dev/proxy/{anyPath} \
  --header 'Connection-Id: <connection-id>' \
  --header 'Provider-Config-Key: <provider-config-key>'

​
API request

The path, query params, and headers you send to the Proxy are all passed on to the external API, except for the configuration headers mentioned here:

  • Authorization: See Nango API Authentication. Nango will add a new Authorization header for the external API as needed.
  • Provider-Config-Key
  • Connection-Id
  • Retries
  • Base-Url-Override: provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden

​
API response

The response from the external API is passed back to you exactly as Nango gets it:

  • Response code
  • Response headers
  • Response body

Headers

Connection-Id
string
required

The connection ID used to create the connection.

Provider-Config-Key
string
required

The integration ID used to create the connection (aka Unique Key).

Retries
string

The number of retries in case of failure (with exponential back-off). Optional, default 0.

Retry On
string

Comma separated status codes to explicitly retry on in addition to the default 5xx and 429.

Base-Url-Override
string

Provide an API base URL when the base API is not listed in the providers.yaml or it needs to be overridden. Optional

Decompress
string

Override the decompress option when making requests. Optional, defaults to false

nango-proxy-$ANY_HEADER
string

Any other headers you send are passed on to the external API

Path Parameters

anyPath
string
required

Query Parameters

$ANY_QUERY_PARAMS
string
required

Was this page helpful?

Trigger an actionProxy - POST requests