CLICommand referenceprojectvolume project volume
Commands, arguments, and options for openship project volume.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
Manage replicated project volumes and recoverable backups
openship project volume [options] [command]
Create a volume backup with an idempotent request ID
openship project volume backup [options] <project> <volume>
| Argument | Meaning |
|---|
project | Project ID |
volume | Volume name |
| Option | Meaning |
|---|
--request-id <id> | Stable request ID for this backup (16–64 characters) |
List volume backups available for recovery
openship project volume backups [options] <project>
| Argument | Meaning |
|---|
project | Project ID |
Create a volume, optionally restored from a named backup
openship project volume create [options] <id> [file]
| Argument | Meaning |
|---|
id | Resource ID |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
Stream health and operation progress
openship project volume events [options] <project>
| Argument | Meaning |
|---|
project | Project ID |
| Option | Meaning |
|---|
--timeout <ms> | Stop after this deadline |
List volumes, resource versions and replica health
openship project volume list [options] <project>
| Argument | Meaning |
|---|
project | Project ID |
Delete an unused volume and its data, checking its name and resource version
openship project volume remove [options] <id> [file]
| Argument | Meaning |
|---|
id | Resource ID |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
-y, --yes | Confirm this operation |
Delete a volume backup with explicit name confirmation
openship project volume remove-backup [options] <id> [file]
| Argument | Meaning |
|---|
id | Resource ID |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
-y, --yes | Confirm this operation |
Grow a volume using its exact resource version
openship project volume resize [options] <id> [file]
| Argument | Meaning |
|---|
id | Resource ID |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |
Set backup frequency and retention at a volume's current resource version
openship project volume schedule [options] <id> [file]
| Argument | Meaning |
|---|
id | Resource ID |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|
--schema | Print the accepted JSON schema without making a request |