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.
No Additional PropertiesExtra 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.
Force use of SQL for result filtering to reduce response time. May not work for all methods.
The full dataset path including pool name.
"tank/dataset/child"
The dataset type.
"FILESYSTEM"
"VOLUME"
The dataset name without the pool prefix.
The name of the ZFS pool containing this dataset.
Whether the dataset is encrypted.
The root dataset where encryption is enabled. null if the dataset is not encrypted.
Whether the encryption key is currently loaded for encrypted datasets. null for unencrypted datasets.
Array of child dataset objects nested under this dataset.
No Additional ItemsCustom user-defined ZFS properties set on this dataset as key-value pairs.
Whether an encrypted dataset is currently locked (key not loaded).
ZFS comments property for storing descriptive text about the dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
ZFS quota warning threshold property as a percentage.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
ZFS quota critical threshold property as a percentage.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
ZFS reference quota warning threshold property as a percentage.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
ZFS reference quota critical threshold property as a percentage.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Identifies which service or system manages this dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
ZFS deduplication setting - whether identical data blocks are stored only once.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
How Access Control Lists (ACLs) are handled when chmod is used.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
The type of Access Control List system used (NFSV4, POSIX, or OFF).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Extended attributes storage method (on/off).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Whether file access times are updated when files are accessed.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
File name case sensitivity setting (sensitive/insensitive).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Data integrity checksum algorithm used for this dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Whether files in this dataset can be executed.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Synchronous write behavior (standard/always/disabled).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Compression algorithm and level applied to data in this dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
The achieved compression ratio as a decimal (e.g., '2.50x').
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
The snapshot from which this clone was created. Empty for non-clone datasets.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Maximum amount of disk space this dataset and its children can consume.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Maximum amount of disk space this dataset itself can consume (excluding children).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Minimum amount of disk space guaranteed to be available to this dataset and its children.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Minimum amount of disk space guaranteed to be available to this dataset itself.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Number of copies of data blocks to maintain for redundancy (1-3).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Visibility of the .zfs/snapshot directory (visible/hidden).
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Whether the dataset is read-only.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
The suggested block size for files in this filesystem dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
For volumes, whether to use sparse (thin) provisioning.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
For volumes, the logical size of the volume.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
For volumes, the block size used by the volume.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Format of the encryption key (hex/raw/passphrase). Only relevant for encrypted datasets.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Encryption algorithm used (e.g., AES-256-GCM). Only relevant for encrypted datasets.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Total amount of disk space consumed by this dataset and all its children.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Amount of disk space consumed by child datasets.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Amount of disk space consumed by this dataset itself, excluding children and snapshots.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Amount of disk space consumed by the refreservation of this dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Amount of disk space consumed by snapshots of this dataset.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Amount of disk space available to this dataset and its children.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Size threshold below which blocks are stored on special vdevs if configured.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Number of PBKDF2 iterations used for passphrase-based encryption keys.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Timestamp when this dataset was created.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Controls visibility of volume snapshots under /dev/zvol/<pool>/.
No Additional PropertiesThe ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).
The raw string value of the ZFS property as stored in the pool. Can be null if not set.
The current effective value of the ZFS property as a string. Can be null if inherited or not set.
Indicates where the property value originates from.
"LOCAL"
"INHERITED"
"DEFAULT"
Additional metadata about the property source, such as the parent dataset for inherited values.
Filesystem path where this dataset is mounted. Null for unmounted datasets or volumes.
Additional Properties of any type are allowed.
Type: object