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.
Unique identifier for the containers device.
Device-specific configuration attributes.
Device type identifier for FILESYSTEM devices.
Specific value:"FILESYSTEM"
Target must not contain braces.
Must match regular expression:^[^{}]*$
Must be at least 1 characters long
Source must not contain braces, and not start with /mnt/.
Must match regular expression:^[^{}]*$
Must be at least 1 characters long
Device type identifier for GPU devices.
Specific value:"GPU"
GPU device type.
Specific value:"AMD"
PCI address of the GPU device on the host system.
Must be at least 1 characters long
Device type identifier for network interface cards.
Specific value:"NIC"
Whether to trust guest OS receive filter settings for better performance.
Network interface controller type. E1000 for Intel compatibility, VIRTIO for performance.
Host network interface or bridge to attach to. null for no attachment.
MAC address for the virtual network interface. null for auto-generation.
^([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})$
Device type identifier for USB devices.
Specific value:"USB"
USB device attributes for identification. null for USB host controller only.
USB vendor identifier in hexadecimal format (e.g., '0x1d6b' for Linux Foundation).
Must match regular expression:^0x.*
Must be at least 1 characters long
USB product identifier in hexadecimal format (e.g., '0x0002' for 2.0 root hub).
Must match regular expression:^0x.*
Must be at least 1 characters long
Host USB device path to pass through. null for controller only.
Must be at least 1 characters long
ID of the container this device belongs to.