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 DNS authenticator.
Authentication credentials and configuration (masked for security).
DNS authenticator type identifier for Cloudflare.
Specific value:"cloudflare"
Cloudflare Email.
Must be at least 1 characters long
API Key.
Must be at least 1 characters long
API Token.
Must be at least 1 characters long
DNS authenticator type identifier for DigitalOcean.
Specific value:"digitalocean"
DigitalOcean Token.
Must be at least 1 characters long
DNS authenticator type identifier for OVH.
Specific value:"OVH"
OVH Application Key.
Must be at least 1 characters long
OVH Application Secret.
Must be at least 1 characters long
OVH Consumer Key.
Must be at least 1 characters long
OVH Endpoint.
DNS authenticator type identifier for AWS Route 53.
Specific value:"route53"
AWS Access Key ID.
Must be at least 1 characters long
AWS Secret Access Key.
Must be at least 1 characters long
DNS authenticator type identifier for custom shell scripts.
Specific value:"shell"
Authentication Script.
Running user.
Must be at least 1 characters long
Script Timeout.
Value must be greater or equal to 5
Propagation delay.
Value must be greater or equal to 10
Human-readable name for the DNS authenticator.