Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.
Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.
An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
any null values at the head of the results list), nulls_last: (place any null values at the tail of the
results list).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
An array of field names specifying the exact fields to include in the query return. The dot character .
may be used to explicitly select only subkeys of the query result.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.
This specifies the beginning offset of the results array. When combined with the limit query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.
This specifies the maximum number of results matching the specified query-filters to return. When
combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.
The name of the task to display in the UI
The local path to back up beginning with /mnt or /dev/zvol
Cloud credentials to use for each backup
No Additional PropertiesMust be at least 1 characters long
"AZUREBLOB" Must be at least 1 characters long
Must be at least 1 characters long
"" Must be at least 1 characters long
Must be at most 2083 characters long
"B2" Must be at least 1 characters long
Must be at least 1 characters long
"BOX" Must be at least 1 characters long
"DROPBOX" Must be at least 1 characters long
"FTP" Must be at least 1 characters long
Must be at least 1 characters long
"GOOGLE_CLOUD_STORAGE" Must be at least 1 characters long
"GOOGLE_DRIVE" Must be at least 1 characters long
"GOOGLE_PHOTOS" Must be at least 1 characters long
"HTTP" Must be at least 1 characters long
Must be at most 2083 characters long
"HUBIC" Must be at least 1 characters long
"MEGA" Must be at least 1 characters long
Must be at least 1 characters long
"ONEDRIVE" Must be at least 1 characters long
"PCLOUD" Must be at least 1 characters long
"S3" Must be at least 1 characters long
Must be at least 1 characters long
"SFTP" Must be at least 1 characters long
Must be at least 1 characters long
"STORJ_IX" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at most 2083 characters long
"OPENSTACK_SWIFT" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
"WEBDAV" Must be at least 1 characters long
Must be at most 2083 characters long
"YANDEX" Must be at least 1 characters long
Additional information for each backup, e.g. bucket name
Cron schedule dictating when the task should run
No Additional Properties"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
A Bash script to run immediately before every backup
A Bash script to run immediately after every backup if it succeeds
Whether to create a temporary snapshot of the dataset before every backup
Paths to pass to restic backup --include
Must be at least 1 characters long
Paths to pass to restic backup --exclude
Must be at least 1 characters long
(Slated for removal)
Can enable/disable the task
Information regarding the task's job state, e.g. progress
A locked task cannot run
Password for the remote repository
Must be at least 1 characters long
How many of the most recent backup snapshots to keep after each backup
Value must be strictly greater than 0
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
Whether to preserve absolute paths in each backup (cannot be set when snapshot=True)
Cache path. If not set, performance may degrade.