Get egress IPs

Read the fixed IP addresses Tried sends webhooks and custom function requests from.

GEThttps://api.tried.com.au/workspace/egress

Returns the source IP addresses that outbound requests to your systems come from: webhooks, custom functions and workflow steps. Add them to your firewall allowlist when your endpoints only accept known addresses.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace/egress \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace/egress", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const egress = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace/egress",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
egress = res.json()

Response#

200 OK

{
  "fixed": true,
  "ips": ["198.51.100.24", "198.51.100.25"],
  "note": "Webhooks, custom functions and workflow steps leave from these addresses."
}

Field	Type	Description
`fixed`	boolean	`true` when the deployment publishes fixed egress addresses.
`ips`	string[]	The addresses. Empty when `fixed` is `false`.
`note`	string	Plain-text explanation. When `fixed` is `false` it reads `Egress IPs are not fixed in this deployment. Set EGRESS_IPS once outbound traffic goes through a NAT gateway.`

The list comes from the server's EGRESS_IPS setting, so it is the same for every workspace on a deployment.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.