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.
Human-readable name for the alert service.
Must be at least 1 characters long
Service-specific configuration attributes (credentials, endpoints, etc.).
Alert service type identifier for Amazon SNS.
Specific value:"AWSSNS"
AWS region where the SNS topic is located.
Must be at least 1 characters long
Amazon Resource Name (ARN) of the SNS topic to publish alerts to.
Must be at least 1 characters long
AWS access key ID for authentication.
Must be at least 1 characters long
AWS secret access key for authentication.
Must be at least 1 characters long
Alert service type identifier for InfluxDB.
Specific value:"InfluxDB"
InfluxDB server hostname or IP address.
Must be at least 1 characters long
Username for InfluxDB authentication.
Must be at least 1 characters long
Password for InfluxDB authentication.
Must be at least 1 characters long
InfluxDB database name to store alert data.
Must be at least 1 characters long
Name of the time series to store alert events.
Must be at least 1 characters long
Alert service type identifier for email notifications.
Specific value:"Mail"
Email address to send alerts to. Empty string uses system default.
Alert service type identifier for Mattermost.
Specific value:"Mattermost"
Mattermost webhook URL for posting alerts.
Must be at least 1 characters long
Must be at most 2083 characters long
Username to display when posting alerts to Mattermost.
Must be at least 1 characters long
Mattermost channel name to post alerts to. Empty string uses webhook default.
URL of icon image to display with alert messages. Empty string uses default.
""
Must be at least 1 characters long
Must be at most 2083 characters long
Alert service type identifier for OpsGenie.
Specific value:"OpsGenie"
OpsGenie API key for authentication.
Must be at least 1 characters long
OpsGenie API URL. Empty string uses default OpsGenie endpoint.
""
Must be at least 1 characters long
Must be at most 2083 characters long
Alert service type identifier for PagerDuty.
Specific value:"PagerDuty"
PagerDuty service integration key for sending alerts.
Must be at least 1 characters long
Client name to identify the source of alerts in PagerDuty.
Must be at least 1 characters long
Alert service type identifier for Slack.
Specific value:"Slack"
Slack webhook URL for posting alert messages.
Must be at least 1 characters long
Must be at most 2083 characters long
Alert service type identifier for SNMP traps.
Specific value:"SNMPTrap"
SNMP trap receiver hostname or IP address.
TCP port number for SNMP trap receiver.
Value must be greater or equal to 1 and lesser or equal to 65535
Whether to use SNMP v3 instead of v1/v2c.
SNMP community string for v1/v2c authentication or null for v3.
Must be at least 1 characters long
SNMP v3 username for authentication or null for v1/v2c.
Must be at least 1 characters long
SNMP v3 authentication key or null if not using authentication.
Must be at least 1 characters long
SNMP v3 privacy key for encryption or null if not using privacy.
Must be at least 1 characters long
SNMP v3 authentication protocol or null for no authentication.
SNMP v3 privacy protocol for encryption or null for no privacy.
Alert service type identifier for Telegram.
Specific value:"Telegram"
Telegram bot token for API authentication.
Must be at least 1 characters long
List of Telegram chat IDs to send alerts to (minimum 1 required).
Must contain a minimum of 1 items
Alert service type identifier for VictorOps (now Splunk On-Call).
Specific value:"VictorOps"
VictorOps API key for authentication.
Must be at least 1 characters long
VictorOps routing key to determine alert destination and escalation policy.
Must be at least 1 characters long
Minimum alert severity level that triggers notifications through this service.
Whether the alert service is active and will send notifications.
Unique identifier for the alert service.
Human-readable title for the alert service type.