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 rsync task.
Local filesystem path to synchronize.
Must be at most 1023 characters long
Username to run the rsync task as.
Operating mechanism for Rsync, i.e. Rsync Module mode or 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.
Port number for SSH connection. Only applies when mode is SSH.
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.
Unique identifier for this keychain credential.
Distinguishes this Keychain Credential from others.
Must be at least 1 characters long
Type of credential stored in the keychain.
SSH_KEY_PAIR: SSH public/private key pairSSH_CREDENTIALS: SSH connection credentials including host and authenticationCredential-specific configuration and authentication data.
At least one of the two keys must be provided on creation.
No Additional PropertiesSSH private key in OpenSSH format. null if only public key is provided.
Can be omitted and automatically derived from the private key.
SSH server hostname or IP address.
SSH server port number.
SSH username for authentication.
Keychain Credential ID.
Can be discovered with keychaincredential.remotesshhostkeyscan.
Connection timeout in seconds for SSH connections.
Path on the remote system to synchronize with.
Specify if data should be PULLED or PUSHED from the remote system.
Description of the rsync task.
Cron schedule for when the rsync task should run.
No Additional PropertiesMinute when the rsync task should run (cron format).
"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
Recursively transfer subdirectories.
Preserve modification times of files.
Reduce the size of the data to be transmitted.
Make rsync run recursively, preserving symlinks, permissions, modification times, group, and special files.
Delete files in the destination directory that do not exist in the source directory.
Suppress informational messages from rsync.
Preserve original file permissions.
Preserve extended attributes of files.
Delay updating destination files until all transfers are complete.
Array of additional rsync command-line options.
No Additional ItemsWhether this rsync task is enabled.
Whether this rsync task is currently locked (running).
Information about the currently running job. null if no job is running.
Unique identifier for the rsync task.
Local filesystem path to synchronize.
Must be at most 1023 characters long
Username to run the rsync task as.
Operating mechanism for Rsync, i.e. Rsync Module mode or 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.
Port number for SSH connection. Only applies when mode is SSH.
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.
Path on the remote system to synchronize with.
Specify if data should be PULLED or PUSHED from the remote system.
Description of the rsync task.
Cron schedule for when the rsync task should run.
Recursively transfer subdirectories.
Preserve modification times of files.
Reduce the size of the data to be transmitted.
Make rsync run recursively, preserving symlinks, permissions, modification times, group, and special files.
Delete files in the destination directory that do not exist in the source directory.
Suppress informational messages from rsync.
Preserve original file permissions.
Preserve extended attributes of files.
Delay updating destination files until all transfers are complete.
Array of additional rsync command-line options.
No Additional ItemsWhether this rsync task is enabled.
Whether this rsync task is currently locked (running).
Information about the currently running job. null if no job is running.