Skip to main content

Snapshots off

boat never captures a sandbox with snapshots off.
  • Nothing of the sandbox is stored outside its machine.
  • No background work runs on it.
  • A stop erases it.
  • You cannot resume it, fork it or save it as a saved snapshot.
  • If its machine fails, there is no backup.
  • If you create it from a saved snapshot or another sandbox, its snapshot list shows the snapshots of that source with origin: "template". They are copies of the data of the source. boat did not capture them from this sandbox.

Turn snapshots off for the whole account

Do one of these:
  • On the Account tab, under Data & privacy, turn on Snapshots off.
  • Send PATCH /account/data-retention with {"snapshotsOff": true}. This needs a browser sign-in session. An API key gets 403 session_required.
Every sandbox that you create or fork after this has snapshots off, from any surface. Existing sandboxes keep their setting. The setting covers the sandboxes that you create, also in an organization. It does not cover sandboxes of other members.

Turn snapshots off for one sandbox

Monitoring off

boat keeps no monitoring data for a sandbox with monitoring off.
  • The sandbox runs no process tracer.
  • Disk-full alerts need CPU/RAM samples. They are not available for this sandbox.
  • The cause shown for a lost sandbox needs CPU/RAM samples. It is not available for this sandbox.
  • Its history, processes and metrics calls return 409 monitoring_off.

Turn monitoring off for the whole account

Do one of these:
  • On the Account tab, under Data & privacy, turn on Monitoring off.
  • Send PATCH /account/data-retention with {"monitoringOff": true}. This needs a browser sign-in session. An API key gets 403 session_required.
Every sandbox that you create or fork after this has monitoring off. Existing sandboxes keep their setting. The setting covers the sandboxes that you create, also in an organization. While this setting is on, boat refuses a request with monitoring: true. The error is 409 monitoring_off_for_account. A fork of a sandbox with monitoring off also has monitoring off. To change this, send monitoring: true in the fork request.

Turn monitoring off for one sandbox

The sandbox shows "monitoring": false.