snapshot Beta

Manage your snapshots. Snapshots are disk images of your machine at a specific point in time. You can use them to restore a machine to a previous state. We recommend using snapshots before taking actions that could affect the usability of your machine or its network connection.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace snapshot create

Create a snapshot from a machine.

Flags

–fields, -F (string, optional)

The fields to include in the response.

–name, -n (string, required)

The name of the snapshot

–machine-id, -m (string, required)

The ID of the machine to create a snapshot from

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace snapshot list

List snapshots in your team.

Pick a subset of fields to display:

pspace snapshot list -F name -F dtModified

Flags

–limit (number, optional)

The number of items to return in the next page.

–after (string, optional)

The cursor to fetch the next results from.

–orderBy (string, optional)

The field to order items by. One of dtCreated.

–asc (boolean, optional)

Whether to order items ascending.

–desc (boolean, optional)

Whether to order items descending.

–fields, -F (string, optional)

The fields to include in the response.

–machine-id, -m (string, optional)

The ID of the machine the event is for. If not specified, all events are returned.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace snapshot restore

Restore a machine to a snapshot.

Arguments

[argument] (string, required)

The ID of the snapshot to restore to

Flags

–fields, -F (string, optional)

The fields to include in the response.

–create-snapshot (boolean, optional)

Create an additional snapshot before restore

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command

---

pspace snapshot delete

Delete a snapshot from a team.

Arguments

[argument] (string, required)

The ID of the snapshot to delete

Flags

–fields, -F (string, optional)

The fields to include in the response.

Global Flags

These flags are available on all commands.

–log-level, -l (string, optional)

Enable debug logging. One of debug, info, warning, error, or critical.

–json, -j (boolean, optional)

Output JSON

–api-key (string, optional)

A Paperspace public API Key used for authenticating requests

–help, -h (boolean, optional)

Show help for a command