Skip to main content
GET
Get a Sailbox's egress policy

Authorizations

Authorization
string
header
required

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

Path Parameters

sailbox_id
string
required

Id of the Sailbox, as returned by create. It is sb_ followed by a UUID.

Response

The Sailbox's policy.

policy_id
string | null
required

ID of the saved policy the Sailbox uses, or null when its policy was written inline or it was created without one.

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}$
name
string | null
required

Display name of the saved policy, or null when policy_id is null.

document
object
required

The policy document the Sailbox runs under. {} when every host is reachable and no rules apply.