Important: You can only egress to domains that are listed in the Runtime egress permissions in your Forge Manifest. See Runtime egress permissions for details.

External domains must be declared in the permissions.external.fetch.backend section of your manifest.yml file. Use the /proxy/{target} endpoint to proxy requests to external services.

Operations

GET/proxy/{target}PUT/proxy/{target}POST/proxy/{target}DEL/proxy/{target}OPT/proxy/{target}HEAD/proxy/{target}PATCH/proxy/{target}

GET

Proxy GET request to external service

Proxies requests to external services through the Forge Outbound Proxy (FOP). The target parameter specifies the external service to proxy to.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied

application/json

object

GET/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PUT

Proxy PUT request to external service

Proxies PUT requests to external services through the Forge Outbound Proxy (FOP). The target parameter specifies the external service to proxy to.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied

application/json

object

PUT/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST

Proxy POST request to external service

Proxies POST requests to external services through the Forge Outbound Proxy (FOP). The target parameter specifies the external service to proxy to.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied

application/json

object

POST/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'

DEL

Proxy DELETE request to external service

Proxies DELETE requests to external services through the Forge Outbound Proxy (FOP). The target parameter specifies the external service to proxy to.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied

application/json

object

DEL/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request DELETE \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

OPT

Proxy OPTIONS request to external service

Proxies OPTIONS requests to external services through the Forge Outbound Proxy (FOP). Used for CORS preflight requests and method discovery.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied

application/json

object

OPT/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request OPTIONS \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

HEAD

Proxy HEAD request to external service

Proxies HEAD requests to external services through the Forge Outbound Proxy (FOP). Returns headers without response body, useful for checking resource existence.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Request successfully proxied

application/json

object

HEAD/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request HEAD \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

PATCH

Proxy PATCH request to external service

Proxies PATCH requests to external services through the Forge Outbound Proxy (FOP). The target parameter specifies the external service to proxy to.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

target

string

Required

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Generic request body

object

Responses

Request successfully proxied

application/json

object

PATCH/proxy/{target}

curl

Node.js

Java

Python

PHP

curl --request PATCH \
  --url '{FORGE_EGRESS_PROXY_URL}/proxy/{target}' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{}'