Skip to main content
PUT
Set a Sailbox's egress policy

Authorizations

Authorization
string
header
required

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

Headers

X-Sail-Owner-Override-Reason
string

Lets an organization admin operate a private Sailbox someone else created. Say why in plain text; the reason goes into your organization's audit log, and the operation is refused without it. Ignored on Sailboxes you could already operate.

Pause, resume, sleep, scheduled wake, upgrade, and terminate accept an override. Setting an egress policy accepts one too. Running commands and moving files accept one through an SDK or the CLI. Publishing and unpublishing ports, adding and removing custom domains, checkpointing, and creating from a checkpoint stay with the creator.

Pattern: ^[ -~]*$

Path Parameters

sailbox_id
string
required

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

Body

application/json
policy_id
string
required

ID of a saved policy, as returned by create. Send this or document, not both.

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}$
document
object

A policy document written inline. It cannot use secrets; save it as a policy first.

Response

The Sailbox's new 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.