backup destination

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship backup destination

Backup destinations (storage targets)

openship backup destination [options] [command]

Subcommand	Purpose
`list`	List backup destinations
`create [options]`	Create a backup destination
`preflight <destinationId>`	Verify a destination (write + read + delete a probe object)
`get <id>`	Show a destination without revealing its credentials
`usage <id>`	Show policies and stored backup usage for a destination
`update <id> <file>`	Update selected destination fields; omitted credentials stay unchanged
`remove\|rm <id>`	Remove a destination that has no active policies
`preflight-draft <file>`	Test destination settings before saving them

Create a backup destination

openship backup destination create [options]

Option	Meaning
`--name <name>`	Display name
`--kind <kind>`	s3_compatible \| sftp \| openship_server \| local
`--endpoint <url>`	Endpoint URL / absolute path (local)
`--region <region>`	S3 region
`--bucket <bucket>`	S3 bucket
`--path-prefix <prefix>`	Key/path prefix
`--ssh-host <host>`	SFTP host
`--ssh-port <port>`	SFTP port
`--ssh-user <user>`	SFTP user
`--server <id>`	Server ID (openship_server kind)
`--access-key-id <id>`	S3 access key ID
`--secret-access-key <key>`	S3 secret access key
`--sftp-password <pw>`	SFTP password
`--sftp-private-key <key>`	SFTP private key (raw)
`--sftp-private-key-file <path>`	Read the SFTP private key from a file
`--sftp-key-passphrase <pw>`	SFTP private key passphrase
`--default`	Mark as the default destination

Show a destination without revealing its credentials

openship backup destination get [options] <id>

Argument	Meaning
`id`	Destination ID

List backup destinations

openship backup destination list [options]

Verify a destination (write + read + delete a probe object)

openship backup destination preflight [options] <destinationId>

Argument	Meaning
`destinationId`	Destination ID

Test destination settings before saving them

openship backup destination preflight-draft [options] <file>

Argument	Meaning
`file`	JSON destination input; include id to reuse saved credentials

Remove a destination that has no active policies

openship backup destination remove|rm [options] <id>

Argument	Meaning
`id`	Destination ID

Update selected destination fields; omitted credentials stay unchanged

openship backup destination update [options] <id> <file>

Argument	Meaning
`id`	Destination ID
`file`	JSON destination patch

Show policies and stored backup usage for a destination

openship backup destination usage [options] <id>

Argument	Meaning
`id`	Destination ID