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.
Full snapshot identifier including dataset and snapshot name.
Object mapping ZFS property names to their values and metadata.
Each additional property must conform to the following schema
Current effective value of the ZFS property as a string.
Raw string value of the ZFS property as stored.
Source of the property value.
NONE: Property is not setDEFAULT: Using ZFS default valueLOCAL: Set locally on this snapshotTEMPORARY: Temporary override valueINHERITED: Inherited from parent datasetRECEIVED: Set by ZFS receive operationProperty value parsed into the appropriate type (string, boolean, integer, etc.).
Name of the ZFS pool containing this snapshot.
Full name of the snapshot including dataset path.
Type identifier indicating this is a ZFS snapshot.
Specific value:"SNAPSHOT"
Just the snapshot name portion without the dataset path.
Name of the dataset this snapshot was taken from.
Transaction group ID when the snapshot was created.
Returned when options.extra.holds is set.
No Additional PropertiesPresent if a hold has been placed on the snapshot.
Returned when options.extra.retention is set.
Timestamp when the snapshot will be eligible for removal.
Indicates retention is managed by a periodic snapshot task.
Specific value:"periodic_snapshot_task"
ID of the periodic snapshot task managing this retention.
Timestamp when the snapshot will be eligible for removal.
Indicates retention is managed by ZFS properties.
Specific value:"property"