Acquia CLI commands¶

--format¶

The output format (txt, xml, json, or md)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: 'txt'

--raw¶

To output raw command help

• Accept value: no

• Is value required: no

• Is multiple: no

• Is negatable: no

• Default: false

--limit¶

A positive integer (max 100).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--order¶

Either “ASC” or “DESC”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--source¶

The source of the event.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--module¶

The system name of the module.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--scope¶

The general scope of the changes.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--type¶

The specific type of changes.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--nid¶

An associated node ID.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--uid¶

The user who made the change.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 1000).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 1000).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer not higher than 100.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--parent_id¶

The parent group ID, if applicable.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 1000).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

Get only the profiles on the given stack.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--is_enabled¶

Get only the enabled/disabled profiles.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The installation profile’s stack.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The installation profile’s stack.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The installation profile’s stack.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--start_from¶

The first date from which to start showing the statistics in the format of YYYY-MM.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sort_order¶

The sort order direction. Either asc or desc.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

The number of months to be listed. Maximum value is 120.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

The page number to show in the list.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--domain_name¶

Full domain name or a prefix for filtering the results.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sort_order¶

The sort order direction. Either asc or desc.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

The number of domains to be listed. (max 100)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

The page number to show in the list.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--reason¶

Brief explanation for pausing workers.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 100).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--order¶

Either “ASC” or “DESC”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 1000).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--canary¶

No value necessary.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--show_incomplete¶

Show sites that are incomplete.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

Show sites on a specific stack.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--domain_contains¶

Show sites whose domain contains this value.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--domain_not_contains¶

Show sites whose domain does not contain this value.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--has_custom_domain¶

Whether to only show sites with custom domains.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--site_owner¶

Either a user id or a comma separated list of user ids.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--show_custom_domain¶

Return the first custom domain if the site has one instead of the internal one.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--install_profile¶

The install profile to be used to install the site.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The stack id where the site should go.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--group_ids¶

Either a single group ID, or an array of group IDs.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--exact_copy¶

A boolean indicating whether or not to create an exact copy.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--group_ids¶

Either a single group ID, or an array of group IDs.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--label¶

The human-readable description of this backup.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_url¶

The callback URL, which is invoked upon completion.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_method¶

The callback method, “GET”, or “POST”. Uses “POST” if empty.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--caller_data¶

Data that should be included in the callback, json encoded.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--components¶

Array of components to be included in the backup. The following component names are accepted: codebase, database, public files, private files, themes. When omitting this parameter it will default to a backup with every component.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--limit¶

A positive integer (max 100).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--lifetime¶

The number of seconds the temporary URL is good for.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_url¶

The callback URL, which is invoked upon completion.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_method¶

The callback method, “GET”, or “POST”. Uses “POST” if empty.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--caller_data¶

Data that should be included in the callback, json encoded.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--target_site_id¶

ID of the site to restore the backup onto.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--backup_id¶

ID of the backup to restore defaults to the most recent.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_url¶

The callback URL, which is invoked upon completion.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--callback_method¶

The callback method, “GET”, or “POST”. Uses “POST” if empty.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--caller_data¶

Data that should be included in the callback, json encoded.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--components¶

Array of components to be restored from the backup. The following component names are accepted: database, public files, private files, themes. When omitting this parameter it will default to the backup’s every component.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--wipe_target_environment¶

Use this option to wipe the management console and all stacks on the selected environment before deploying sites.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--synchronize_all_users¶

Use this parameter to only stage the user accounts that are required for the provided sites and the related site collections and site groups.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--detailed_status¶

Provide a status email for each site as it completes.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--skip_site_files¶

Skip copying the staged down sites’ files.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sites¶

Node IDs of sites to deploy.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--wipe_stacks¶

Stack ids to wipe. It will be ignored if wipe_target_environment is true.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--skip_site_files_overwrite¶

File patterns to skip copying during the stage down process. Ignored if skip_site_files is false.

• Accept value: yes

• Is value required: yes

• Is multiple: yes

• Is negatable: no

• Default: array ()

--all¶

on, off, or something strtotime accepts

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--site_creation¶

on, off, or something strtotime accepts

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--site_duplication¶

on, off, or something strtotime accepts

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--domain_management¶

on, off, or something strtotime accepts

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--bulk_operations¶

on, off, or something strtotime accepts

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 100).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--status¶

processing, error or not-started

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--class¶

A WIP class name to filter on.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--group¶

A WIP group name to filter on.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--level¶

The minimum status level to display

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--descendants¶

Include the logs of all descendant tasks.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--wip_log_level¶

Level of Wip log messages to keep on successful completion.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--wip_log_maximum_level¶

The maximum log level that will be written to the log.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sitegroup_id¶

The ID of a specific sitegroup to process e.g. “tangle001”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--vcs_url¶

The external theme repository’s url.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--nid¶

The node ID of the related entity (site or group). Not relevant for the “global” scope.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--theme¶

The system name of the theme. Only relevant for “theme” scope notifications.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--uid¶

The user id owning the notification and who should get notified if an error occurs during processing.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--username¶

New owner username to which site needs to be transferred (either username or email field is required).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--email¶

New owner email id to which site needs to be transferred.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--force_transfer¶

Transfer site ownership without mail confirmation from owner and recipient.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--scope¶

Either “sites”, “factory”, or “both”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--start_time¶

A start time string, parseable by strtotime(). Interpreted as UTC if no timezone is specified.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sites_ref¶

A VCS ref to deploy to the sites.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--factory_ref¶

A VCS ref to deploy to the Factory.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sites_type¶

Either “code”, “code, db”, or “code, db, registry”

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--factory_type¶

Either “code” or “code, db”

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The stack id to release to.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--site_update_fail_action¶

Action to be performed on sites when updates fail. Either “online” or “offline”

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--db_update_arguments¶

Custom arguments to supply to the db-update hooks. Space separated alphanumeric characters only.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

A positive integer (max 100).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--page¶

A positive integer.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--order¶

Either “ASC” or “DESC”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--ids¶

A comma-separated list of user IDs.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--role_ids¶

A comma-separated list of role IDs.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--status¶

Either “active” or “blocked”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--uid_min¶

First uid value to start with.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--uid_max¶

Last uid value to fetch.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--created_min¶

Lowest ‘created’ value (timestamp).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--created_max¶

Highest ‘created’ value (timestamp).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--login_min¶

Lowest ‘login’ value (timestamp).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--login_max¶

Highest ‘login’ value (timestamp).

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--tfa_status¶

Either “active” or “disabled”.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--fields¶

A comma-separated list of Drupal user fields.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--pass¶

The user’s password. (Included in the response, if not provided.)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--status¶

The user’s status, either 0 or 1.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--roles¶

Either a single role name, or an array of role names.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--fields¶

A comma-separated list of fields to retrieve.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--name¶

The name of the user.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--mail¶

The email address of the user.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--pass¶

The user’s password.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--status¶

The user’s status, either 0 or 1.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--roles¶

Single role name, or an array of them.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--tfa_status¶

The user’s TFA status, either 0 or 1.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--stack_id¶

The stack id.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--from¶

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--to¶

Optionally specifies relative or absolute time period to retrieve results until.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sort¶

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--filter¶

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

• Equals: = (%3D)

• Does not equal: != (!%3D)

• Greater than: > (%3E)

• Less than: < (%3C)

• Greater than or equal to: >= (%3E%3D)

• Less than or equal to: <= (%3C%3D)

• Contains substring: =@ (%3D@)

• Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

• filter=field%3Dvalue (field equals ‘value’)

• filter=field%3D@*partialmatch (field ends with ‘partialmatch’)

• filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)

• filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

The maximum number of items to return.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--offset¶

An integer to signify the offset to paginate from.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--from¶

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--to¶

Optionally specifies relative or absolute time period to retrieve results until.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sort¶

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--filter¶

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

• Equals: = (%3D)

• Does not equal: != (!%3D)

• Greater than: > (%3E)

• Less than: < (%3C)

• Greater than or equal to: >= (%3E%3D)

• Less than or equal to: <= (%3C%3D)

• Contains substring: =@ (%3D@)

• Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

• filter=field%3Dvalue (field equals ‘value’)

• filter=field%3D@*partialmatch (field ends with ‘partialmatch’)

• filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)

• filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

The maximum number of items to return.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--offset¶

An integer to signify the offset to paginate from.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--from¶

Specifies relative or absolute time period to retrieve results from. (Default value -7d)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--to¶

Optionally specifies relative or absolute time period to retrieve results until.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--sort¶

A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--filter¶

The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable.

There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are:

• Equals: = (%3D)

• Does not equal: != (!%3D)

• Greater than: > (%3E)

• Less than: < (%3C)

• Greater than or equal to: >= (%3E%3D)

• Less than or equal to: <= (%3C%3D)

• Contains substring: =@ (%3D@)

• Does not contain substring: !@ (!@)

Filters can be combined using OR and AND boolean logic. The OR operator is defined using a comma (,) and the AND operator is defined using a semi-colon (;).

Some examples:

• filter=field%3Dvalue (field equals ‘value’)

• filter=field%3D@*partialmatch (field ends with ‘partialmatch’)

• filter=field%3D@*partialmatch,field%3Dvalue (field ends with ‘partialmatch’ OR field equals ‘value’)

• filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5 (field ends with ‘partialmatch’ OR field equals ‘value’ AND field2 > 5)

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--limit¶

The maximum number of items to return.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL

--offset¶

An integer to signify the offset to paginate from.

• Accept value: yes

• Is value required: yes

• Is multiple: no

• Is negatable: no

• Default: NULL