Table Of Contents

Previous topic

cloud_backup.list_snapshots

Next topic

cloud_backup.restore

cloud_backup.query

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items
Each item of this array must be:
Type: object
Parameter 2: options

options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Select

Type: array Default: []
No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

Result


Type: array of object
No Additional Items
Each item of this array must be:

CloudBackupQueryResultItem

Type: object
No Additional Properties

Description

Type: string

The name of the task to display in the UI

Path

Type: string

The local path to back up beginning with /mnt or /dev/zvol

Type: object

Cloud credentials to use for each backup

Attributes

Type: object

Additional information for each backup, e.g. bucket name

Type: object

Cron schedule dictating when the task should run

Pre Script

Type: string

A Bash script to run immediately before every backup

Post Script

Type: string

A Bash script to run immediately after every backup if it succeeds

Snapshot

Type: boolean

Whether to create a temporary snapshot of the dataset before every backup

Include

Type: array of string

Paths to pass to restic backup --include

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Exclude

Type: array of string

Paths to pass to restic backup --exclude

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Args

Type: string

(Slated for removal)

Enabled

Type: boolean

Can enable/disable the task

Password

Type: string

Password for the remote repository

Must be at least 1 characters long

Keep Last

Type: integer

How many of the most recent backup snapshots to keep after each backup

Value must be strictly greater than 0

Transfer Setting

Type: enum (of string)

DEFAULT:
- pack size given by $RESTIC_PACK_SIZE (default 16 MiB)
- read concurrency given by $RESTIC_READ_CONCURRENCY (default 2 files)
PERFORMANCE:
- pack size = 29 MiB
- read concurrency given by $RESTIC_READ_CONCURRENCY (default 2 files)
FAST_STORAGE:
- pack size = 58 MiB
- read concurrency = 100 files

Must be one of:
  • "DEFAULT"
  • "PERFORMANCE"
  • "FAST_STORAGE"

Absolute Paths

Type: boolean

Whether to preserve absolute paths in each backup (cannot be set when snapshot=True)

Id

Type: integer

Job


Information regarding the task's job state, e.g. progress

Type: object
Type: null

Locked

Type: boolean

A locked task cannot run

CloudBackupQueryResultItem

Type: object
No Additional Properties

Description

Type: string

The name of the task to display in the UI

Path

Type: string

The local path to back up beginning with /mnt or /dev/zvol

Type: object

Cloud credentials to use for each backup

Attributes

Type: object

Additional information for each backup, e.g. bucket name

Type: object

Cron schedule dictating when the task should run

Pre Script

Type: string

A Bash script to run immediately before every backup

Post Script

Type: string

A Bash script to run immediately after every backup if it succeeds

Snapshot

Type: boolean

Whether to create a temporary snapshot of the dataset before every backup

Include

Type: array of string

Paths to pass to restic backup --include

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Exclude

Type: array of string

Paths to pass to restic backup --exclude

No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Args

Type: string

(Slated for removal)

Enabled

Type: boolean

Can enable/disable the task

Password

Type: string

Password for the remote repository

Must be at least 1 characters long

Keep Last

Type: integer

How many of the most recent backup snapshots to keep after each backup

Value must be strictly greater than 0

Transfer Setting

Type: enum (of string)

DEFAULT:
- pack size given by $RESTIC_PACK_SIZE (default 16 MiB)
- read concurrency given by $RESTIC_READ_CONCURRENCY (default 2 files)
PERFORMANCE:
- pack size = 29 MiB
- read concurrency given by $RESTIC_READ_CONCURRENCY (default 2 files)
FAST_STORAGE:
- pack size = 58 MiB
- read concurrency = 100 files

Must be one of:
  • "DEFAULT"
  • "PERFORMANCE"
  • "FAST_STORAGE"

Absolute Paths

Type: boolean

Whether to preserve absolute paths in each backup (cannot be set when snapshot=True)

Id

Type: integer

Job


Information regarding the task's job state, e.g. progress

Type: object
Type: null

Locked

Type: boolean

A locked task cannot run

Type: integer


Required roles: