Destinations
S3-compatible storage destinations that backups are uploaded to. Generated from the `notploy` command surface.
S3-compatible storage destinations that backups are uploaded to.
notploy destination exposes 7 commands. They map one-to-one onto the destination.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy destination --help to list these commands in your terminal, or
notploy destination <command> --help for a single command.
Commands
notploy destination all
Calls GET /api/trpc/destination.all.
notploy destination all [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy destination create
Calls POST /api/trpc/destination.create.
notploy destination create --name <value> --provider <value> --accessKey <value> --bucket <value> --region <value> --endpoint <value> --secretAccessKey <value> --additionalFlags <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--provider <value> | string | Yes | — |
--accessKey <value> | string | Yes | — |
--bucket <value> | string | Yes | — |
--region <value> | string | Yes | — |
--endpoint <value> | string | Yes | — |
--secretAccessKey <value> | string | Yes | — |
--additionalFlags <json> | array | Yes | — |
--serverId <value> | string | No | — |
--objectStorageBucketId <value> | string | No | — |
--profile <name> | string | No | — |
notploy destination from-object-storage-bucket
Calls POST /api/trpc/destination.fromObjectStorageBucket.
notploy destination from-object-storage-bucket --objectStorageBucketId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--objectStorageBucketId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy destination one
Calls GET /api/trpc/destination.one.
notploy destination one --destinationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--destinationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy destination remove
Calls POST /api/trpc/destination.remove.
notploy destination remove --destinationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--destinationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy destination test-connection
Calls POST /api/trpc/destination.testConnection.
notploy destination test-connection --name <value> --provider <value> --accessKey <value> --bucket <value> --region <value> --endpoint <value> --secretAccessKey <value> --additionalFlags <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--provider <value> | string | Yes | — |
--accessKey <value> | string | Yes | — |
--bucket <value> | string | Yes | — |
--region <value> | string | Yes | — |
--endpoint <value> | string | Yes | — |
--secretAccessKey <value> | string | Yes | — |
--additionalFlags <json> | array | Yes | — |
--serverId <value> | string | No | — |
--objectStorageBucketId <value> | string | No | — |
--profile <name> | string | No | — |
notploy destination update
Calls POST /api/trpc/destination.update.
notploy destination update --name <value> --accessKey <value> --bucket <value> --region <value> --endpoint <value> --secretAccessKey <value> --destinationId <value> --provider <value> --additionalFlags <json> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--name <value> | string | Yes | — |
--accessKey <value> | string | Yes | — |
--bucket <value> | string | Yes | — |
--region <value> | string | Yes | — |
--endpoint <value> | string | Yes | — |
--secretAccessKey <value> | string | Yes | — |
--destinationId <value> | string | Yes | — |
--provider <value> | string | Yes | — |
--additionalFlags <json> | array | Yes | — |
--serverId <value> | string | No | — |
--objectStorageBucketId <value> | string | No | — |
--profile <name> | string | No | — |