Struct CreateSailboxRequest 

pub struct CreateSailboxRequest {
    pub app_id: String,
    pub name: String,
    pub ingress_ports: Vec<IngressPort>,
    pub volume_mounts: Vec<VolumeMount>,
    pub image: ImageSpec,
    pub size: Option<SailboxSize>,
    pub memory_gib: Option<u32>,
    pub disk_gib: Option<u32>,
    pub ssh: bool,
    pub private: bool,
    pub image_build_timeout: Option<Duration>,
}

Inputs to create a sailbox. The image is a typed ImageSpec; build one fluently with ImageDefinition.

Fields

app_id: String

Identifier of the app that will own the sailbox.

name: String

Caller-supplied name for the sailbox.

ingress_ports: Vec<IngressPort>

Guest ingress ports to reserve at create time.

volume_mounts: Vec<VolumeMount>

NFS volumes to mount into the guest.

image: ImageSpec

The image to create the sailbox from. Serialized to canonical proto-JSON and sent as the image field.

size: Option<SailboxSize>

Requested resource size; defaults server-side when absent.

memory_gib: Option<u32>

Optional memory limit in whole GiB, within the size’s range; the size’s default when absent.

disk_gib: Option<u32>

Optional disk size in whole GiB, within the size’s range; the size’s default when absent.

ssh: bool

Enable SSH on the new sailbox after create: trust the org SSH CA, start sshd, and expose guest port 22 as TCP once the CA-only daemon owns it. An explicit port-22 ingress entry contributes just its allowlist.

private: bool

By default a sailbox is org-wide: any credential in the org can exec, copy files, SSH, or run lifecycle operations on it. true restricts all of that to the creating user. An org admin can override that with a recorded reason for exec, files, and pause/resume/terminate/upgrade. SSH, exposing or removing listeners, and fork/checkpoint/restore stay creator-only. Requires a user-scoped API key.

image_build_timeout: Option<Duration>

Budget for rebuilding the image if Sail needs to rebuild it before the sailbox is created; the default build budget applies when absent.

Trait Implementations

impl Clone for CreateSailboxRequest

fn clone(&self) -> CreateSailboxRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateSailboxRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateSailboxRequest

fn default() -> CreateSailboxRequest

An empty request for a plain Debian-base sailbox: fill in app_id and name, override the rest as needed.