Skip to main content
GET
Get an egress policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policy_id
string
required

Id of the egress policy, as returned by create. It is ep_ followed by a UUID.

Response

The policy.

id
string
required

Stable policy ID.

Pattern: ^(?:ep|hp)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
org_id
string
required

Organization that owns the policy.

name
string
required

Display name.

document
object
required

An egress policy: what a Sailbox may connect to (no_network, allowlist, and blocked) and what happens to the HTTPS requests it sends (rules). Every field is optional. The empty document {} allows every destination and applies no rules. Sail saves a normalized form (for example, host names are lowercased and defaults are filled in), so reading a policy back can return a different shape with the same behavior. At most 64 KiB when encoded. Guide: https://docs.sailresearch.com/sailboxes-egress-policy

created_at
string<date-time>
required

When the policy was created.

updated_at
string<date-time>
required

When the policy name last changed.