Retrieve a Sailbox
Returns one Sailbox, including its latest observed resource usage.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Id of the Sailbox, as returned by create. It is sb_ followed by a UUID.
^sb_[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}$Response
The Sailbox.
A Sailbox and its latest observed resource usage. The can_ flags are hints for deciding which actions are worth offering. They are all false on a private Sailbox you did not create, even where X-Sail-Owner-Override-Reason would still let you act.
Unique id of the Sailbox.
The Sailbox's display name: the one you gave at create, restore, or fork time, or one derived from the source when you left it out.
Id of the app the Sailbox belongs to.
Name of the app the Sailbox belongs to.
Id of the built image the Sailbox boots from. Two Sailboxes created from the same image share this id.
Current state of the Sailbox. Values in use today are creating, running, paused, sleeping, terminating, terminated, failed, create_failed, interrupted_restorable, and interrupted_unsafe_to_retry. New values can appear over time, so treat this as an open set.
CPU architecture the Sailbox runs on.
Virtual CPUs allocated to the Sailbox.
Memory limit in MiB.
Disk limit in GiB.
Virtual CPUs in use in the most recent sample. 0 when there is no recent sample.
Memory in use in the most recent sample. 0 when there is no recent sample.
Disk in use in the most recent sample. 0 when there is no recent sample.
Why the Sailbox failed, when it failed.
Upgrade notice when this Sailbox has a deadline to act on and your credential can act on it. null otherwise, which is the usual case.
Version of the Sail runtime inside the Sailbox. null when the version is not known.
User whose key created the Sailbox. null when a service key created it.
private means only the creator can operate the Sailbox, apart from the operations an organization admin can take with X-Sail-Owner-Override-Reason. org or null means anyone in the organization can operate it.
When the Sailbox first started running. It is not rewritten when a Sailbox resumes.
When the Sailbox last saved its state.
Checkpoint counter for the Sailbox. It goes up by one every time the Sailbox saves its state, which includes pausing and sleeping. Compare it across two reads to tell whether the Sailbox saved again in between.
When the Sailbox was created.
When the Sailbox last changed.
Whether pausing would change this Sailbox now. False once it is paused.
Whether sleeping would change this Sailbox now. False once it is asleep.
Whether resuming would change this Sailbox now. False once it is running.
Whether terminating would change this Sailbox now. False once it is shutting down or gone.