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.
The dataset to take snapshots of.
Whether to recursively snapshot child datasets.
Number of time units to retain snapshots. lifetime_unit gives the time unit.
Unit of time for snapshot retention.
Whether this periodic snapshot task is enabled.
Array of dataset patterns to exclude from recursive snapshots.
No Additional ItemsNaming pattern for generated snapshots using strftime format.
Whether to take snapshots even if no data has changed.
Cron schedule for when snapshots should be taken.
No Additional PropertiesMinute when snapshots should be taken (cron format).
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Start time of the window when snapshots can be taken.
"00:00"
"06:30"
"18:00"
"23:00"
End time of the window when snapshots can be taken.
"00:00"
"06:30"
"18:00"
"23:00"
Unique identifier for the periodic snapshot task.
Detailed state information for the task.
Whether VMware VMs are synced before taking snapshots.
The dataset to take snapshots of.
Whether to recursively snapshot child datasets.
Number of time units to retain snapshots. lifetime_unit gives the time unit.
Unit of time for snapshot retention.
Whether this periodic snapshot task is enabled.
Array of dataset patterns to exclude from recursive snapshots.
No Additional ItemsNaming pattern for generated snapshots using strftime format.
Whether to take snapshots even if no data has changed.
Cron schedule for when snapshots should be taken.
Unique identifier for the periodic snapshot task.
Detailed state information for the task.
Whether VMware VMs are synced before taking snapshots.