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 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.
Extra 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.
See the comment in Rsyncmod about path length limits.
Must be at most 1023 characters long
different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode
ip address or hostname of the remote system. If username differs on the remote host, "username@remote_host"
format should be used.
name of remote module, this attribute should be specified when mode is set to MODULE.
In SSH mode, if ssh_credentials (a keychain credential of SSH_CREDENTIALS type) is specified then it is used
to connect to the remote host. If it is not specified, then keys in user's .ssh directory are used.
Distinguishes this Keychain Credential from others.
Must be at least 1 characters long
At least one of the two keys must be provided on creation.
No Additional PropertiesCan be omitted and automatically derived from the private key.
Keychain Credential ID.
Can be discovered with keychaincredential.remotesshhostkeyscan.
will automatically add remote host key to user's known_hosts file
specifies if data should be PULLED or PUSHED from the remote system
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
when set reduces the size of the data which is to be transmitted.
when set makes rsync run recursively, preserving symlinks, permissions, modification times, group, and special
files.
when set deletes files in the destination directory which do not exist in the source directory.
when set preserves original file permissions.
See the comment in Rsyncmod about path length limits.
Must be at most 1023 characters long
different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode
ip address or hostname of the remote system. If username differs on the remote host, "username@remote_host"
format should be used.
name of remote module, this attribute should be specified when mode is set to MODULE.
In SSH mode, if ssh_credentials (a keychain credential of SSH_CREDENTIALS type) is specified then it is used
to connect to the remote host. If it is not specified, then keys in user's .ssh directory are used.
will automatically add remote host key to user's known_hosts file
specifies if data should be PULLED or PUSHED from the remote system
when set reduces the size of the data which is to be transmitted.
when set makes rsync run recursively, preserving symlinks, permissions, modification times, group, and special
files.
when set deletes files in the destination directory which do not exist in the source directory.
when set preserves original file permissions.