Backups
Scheduled and manual backups for databases, Compose services and the web server. Generated from the `notploy` command surface.
Scheduled and manual backups for databases, Compose services and the web server.
notploy backup exposes 12 commands. They map one-to-one onto the backup.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy backup --help to list these commands in your terminal, or
notploy backup <command> --help for a single command.
Commands
notploy backup create
Calls POST /api/trpc/backup.create.
notploy backup create --schedule <value> --prefix <value> --destinationId <value> --database <value> --databaseType <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--schedule <value> | string | Yes | — |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--prefix <value> | string | Yes | — |
--destinationId <value> | string | Yes | — |
--keepLatestCount <value> | number | No | — |
--database <value> | string | Yes | — |
--mariadbId <value> | string | No | — |
--mysqlId <value> | string | No | — |
--postgresId <value> | string | No | — |
--mongoId <value> | string | No | — |
--libsqlId <value> | string | No | — |
--databaseType <value> | string | Yes | postgres, mariadb, mysql, mongo, web-server, libsql |
--userId <value> | string | No | — |
--backupType <value> | string | No | database, compose |
--composeId <value> | string | No | — |
--serviceName <value> | string | No | — |
--includeEncryptionKey [boolean] | boolean | No | — |
--no-includeEncryptionKey | boolean | No | — |
--metadata <json> | object | No | — |
--profile <name> | string | No | — |
notploy backup list-backup-files
Calls GET /api/trpc/backup.listBackupFiles.
notploy backup list-backup-files --destinationId <value> --search <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--destinationId <value> | string | Yes | — |
--search <value> | string | Yes | — |
--serverId <value> | string | No | — |
--profile <name> | string | No | — |
notploy backup manual-backup-compose
Calls POST /api/trpc/backup.manualBackupCompose.
notploy backup manual-backup-compose --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-libsql
Calls POST /api/trpc/backup.manualBackupLibsql.
notploy backup manual-backup-libsql --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-mariadb
Calls POST /api/trpc/backup.manualBackupMariadb.
notploy backup manual-backup-mariadb --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-mongo
Calls POST /api/trpc/backup.manualBackupMongo.
notploy backup manual-backup-mongo --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-my-sql
Calls POST /api/trpc/backup.manualBackupMySql.
notploy backup manual-backup-my-sql --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-postgres
Calls POST /api/trpc/backup.manualBackupPostgres.
notploy backup manual-backup-postgres --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup manual-backup-web-server
Calls POST /api/trpc/backup.manualBackupWebServer.
notploy backup manual-backup-web-server --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup one
Calls GET /api/trpc/backup.one.
notploy backup one --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup remove
Calls POST /api/trpc/backup.remove.
notploy backup remove --backupId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--backupId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy backup update
Calls POST /api/trpc/backup.update.
notploy backup update --schedule <value> --enabled --prefix <value> --backupId <value> --destinationId <value> --database <value> --keepLatestCount <value> --serviceName <value> --metadata <json> --databaseType <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--schedule <value> | string | Yes | — |
--enabled [boolean] | boolean | Yes | — |
--prefix <value> | string | Yes | — |
--backupId <value> | string | Yes | — |
--destinationId <value> | string | Yes | — |
--database <value> | string | Yes | — |
--keepLatestCount <value> | number | Yes | — |
--serviceName <value> | string | Yes | — |
--metadata <json> | object | Yes | — |
--databaseType <value> | string | Yes | postgres, mariadb, mysql, mongo, web-server, libsql |
--includeEncryptionKey [boolean] | boolean | No | — |
--no-includeEncryptionKey | boolean | No | — |
--profile <name> | string | No | — |