XQL Language Structure - Reference Guide - Cortex XDR - Cortex - Security Operations

Cortex XDR XQL Language Reference

Product
Cortex XDR
Creation date
2024-02-26
Last date published
2024-05-21
Category
Reference Guide
Abstract

Learn more about the Cortex Query Language structure when creating a query.

Cortex Query Language (XQL) queries usually begin by defining a data source, be it a dataset or a preset. After that, you use zero or more stages to form the XQL query. Each stage is delimited using a pipe (|). The function performed by each stage is identified by the stage keyword that you provide.

Note

Specifying a dataset is not required because Cortex XDR uses xdr_data as the default dataset. If you have more than one dataset or lookup, you can change your default dataset by navigating to SettingsConfigurationsData ManagementDataset Management, right-click on the appropriate dataset, and select Set as default.

In the simplest case, you can specify a dataset using one of the following formats.

  • Hot Storage queries are performed on a dataset using the format dataset = <dataset name>. This is the default option.

    dataset = xdr_data
  • Cold Storage queries are performed using the format cold_dataset = <dataset name>.

    cold_dataset = xdr_data

Note

You can also build a query that investigates data in both a cold dataset and hot dataset in the same query. In addition, as the hot storage dataset format is the default option and represents the fully searchable storage, this format is used throughout this guide. For more information on hot and cold storage, see Dataset Management.

When using the hot storage default format, this returns every xdr_data record contained in your Cortex XDR instance over the time range that you provide to the Query Builder user interface. This can be a large amount of data, which might take a long time to retrieve. You can use a limit stage to specify how many records you want to retrieve.

dataset = xdr_data | limit 5

The records resulting from this query, or the result set, are returned in unsorted order. Every time you run the query, it will probably return a different set of records in no specific order. To create a predictable result set, use other stages to define Sort order, Filter the result set to identify exactly what records you want returned, to create fields containing aggregations , and more.

There is no practical limit to the number of stages that you can specify. See Stages Commands Reference for information on all the supported stages.

In the xdr_data dataset, every user field included in the raw data, for network, authentication, and login events, has an equivalent normalized user field associated with it that displays the user information in the following standardized format:

<company domain>\<username>

For example, the login_data field has the login_data_dst_normalized_user field to display the content in the standardized format. We recommend that you use these normalized_user fields when building your queries to ensure the most accurate results.