List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
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 disk device.
System name of the disk device.
Storage subsystem type.
"SCSI"
"ATA"
Numeric identifier assigned to the disk.
Manufacturer serial number of the disk.
Logical unit number identifier or null if not applicable.
Total size of the disk in bytes. null if not available.
Human-readable description of the disk device.
Data transfer mode and capabilities of the disk.
Hard disk standby timer in minutes or ALWAYS ON to disable standby.
Advanced power management level or DISABLED to turn off power management.
Expiration timestamp for disk data or null if not applicable.
Manufacturer model name/number of the disk. null if not available.
Disk rotation speed in RPM or null for SSDs and unknown devices.
Disk type classification or null if not determined.
ZFS globally unique identifier for this disk or null if not used in ZFS.
System bus type the disk is connected to.
Device name in the operating system.
"/dev/sda"
Physical enclosure information or null if not in an enclosure.
Enclosure number where the disk is located.
Physical slot position within the enclosure.
Name of the storage pool this disk belongs to. null if not part of any pool.
Disk encryption password (masked for security).
KMIP (Key Management Interoperability Protocol) unique identifier or null.
Unique identifier for the disk device.
System name of the disk device.
Storage subsystem type.
"SCSI"
"ATA"
Numeric identifier assigned to the disk.
Manufacturer serial number of the disk.
Logical unit number identifier or null if not applicable.
Total size of the disk in bytes. null if not available.
Human-readable description of the disk device.
Data transfer mode and capabilities of the disk.
Hard disk standby timer in minutes or ALWAYS ON to disable standby.
Advanced power management level or DISABLED to turn off power management.
Expiration timestamp for disk data or null if not applicable.
Manufacturer model name/number of the disk. null if not available.
Disk rotation speed in RPM or null for SSDs and unknown devices.
Disk type classification or null if not determined.
ZFS globally unique identifier for this disk or null if not used in ZFS.
System bus type the disk is connected to.
Device name in the operating system.
"/dev/sda"
Physical enclosure information or null if not in an enclosure.
Name of the storage pool this disk belongs to. null if not part of any pool.
Disk encryption password (masked for security).
KMIP (Key Management Interoperability Protocol) unique identifier or null.