Skip to main content

FQL

List endpoints accept a Falcon Query Language (FQL) filter query parameter. This clone implements a subset. Empty filter matches every record. Invalid syntax, an unknown property, or more than 20 properties → 400.

CrowdStrike’s broader language: Falcon Query Language. This page is only what this API accepts today.

This parser is not CrowdStrike production. It does not call Falcon cloud.

User list: User management. Client list: API clients. Hosts list: Hosts. Alerts list: Alerts. Host groups list: Host groups. Sensors list: Sensors. Installation tokens list: Installation tokens. Prevention policies list: Prevention policies. Response policies list: Response policies. Sensor update policies list: Sensor update policies. Device control policies list: Device control policies. IOC indicators list: IOC indicators. Custom IOA groups and rules lists: Custom IOA. Intel actors list: Intel actors. Intel indicators list: Intel indicators. Spotlight list: Spotlight. Quarantine list: Quarantine. Real Time Response list: Real Time Response. Container images list: Container images. Container vulnerabilities list: Container vulnerabilities. Kubernetes pods list: K8s pods. Kubernetes nodes list: K8s nodes. Kubernetes containers list: K8s containers. Kubernetes deployments list: K8s deployments. Event Streams uses appId, not FQL: Event streams. Kubernetes Protection uses query params, not FQL: Kubernetes. Kubernetes cloud locations use query param clouds, not FQL: K8s locations. Kubernetes AWS accounts use query params ids / status / is_horizon_acct, not FQL: K8s AWS. Kubernetes Azure accounts use query params ids / subscription_id / status / is_horizon_acct, not FQL: K8s Azure. Kubernetes Helm values use query params cluster_name / is_self_managed_cluster, not FQL: K8s helm. CSPM AWS uses query params, not FQL: CSPM AWS. CSPM Azure uses query params, not FQL: CSPM Azure. CSPM GCP uses query params, not FQL: CSPM GCP. Container registries use query and ids, not FQL: Container registries. Container images, container vulnerabilities, Kubernetes pods, Kubernetes nodes, Kubernetes containers, and Kubernetes deployments do use FQL (unlike Kubernetes clusters, Helm, and CSPM).

These curls use Host: crowdstrike-api.localhost against Compose Traefik on :8088. Auth is cookie cs_console from CreateSession or Authorization: Bearer with user-management:read (users) / api-clients:read (clients) / hosts:read (hosts) / alerts:read (alerts) / host-groups:read (host groups) / sensors:read (sensors) / installation-tokens:read (installation tokens) / prevention-policies:read (prevention policies) / response-policies:read (response policies) / sensor-update-policies:read (sensor update policies) / device-control-policies:read (device control policies) / ioc:read (IOC indicators) / custom-ioa:read (Custom IOA groups and rules) / intel:read (Intel actors and Intel indicators) / spotlight-vulnerabilities:read (Spotlight vulnerabilities) / quarantine:read (quarantined files) / real-time-response:read (Real Time Response sessions) / falcon-container-image:read (container images, container vulnerabilities, Kubernetes pods, Kubernetes nodes, Kubernetes containers, and Kubernetes deployments).

Syntax​

FormMeaning
prop:'value'Equality (quoted string)
prop:'value*'Wildcard * in the quoted string
prop:!'x'Negation
+AND
,OR

Maximum 20 property clauses in one filter.

Allowed properties​

CollectionPathProperties
UsersGET /user-management/queries/users/v1email, uid, first_name, last_name
API clientsGET /api-clients/queries/api-clients/v1client_id
HostsGET /devices/queries/devices/v1hostname, status, platform_name
AlertsGET /alerts/queries/alerts/v2status, severity, composite_id, device_id
Host groupsGET /devices/queries/host-groups/v1name
SensorsGET /sensors/queries/installers/v1platform
Installation tokensGET /installation-tokens/queries/tokens/v1label
Prevention policiesGET /policy/queries/prevention/v1name, platform_name, enabled
Response policiesGET /policy/queries/response/v1name, platform_name, enabled
Sensor update policiesGET /policy/queries/sensor-update/v1name, platform_name, enabled
Device control policiesGET /policy/queries/device-control/v1name, platform_name, enabled
IOC indicatorsGET /iocs/queries/indicators/v1type, value, action, severity
Custom IOA groupsGET /ioarules/queries/rule-groups/v1name, platform, enabled
Custom IOA rulesGET /ioarules/queries/rules/v1name, pattern_severity, enabled, rulegroup_id
Intel actorsGET /intel/queries/actors/v1name, slug, status, origin
Intel indicatorsGET /intel/queries/indicators/v1type, indicator, malicious_confidence
SpotlightGET /spotlight/queries/vulnerabilities/v1cve_id, severity, status
QuarantineGET /quarantine/queries/quarantined-files/v1hostname, sha256, state
Real Time ResponseGET /real-time-response/queries/sessions/v1id, aid, hostname
Container imagesGET /container-security/combined/image-assessment/images/v1image_id, registry, repository, tag
Container vulnerabilitiesGET /container-security/combined/vulnerabilities/v1cve_id, severity, image_id, repository
Kubernetes podsGET /container-security/combined/pods/v1cluster_name, pod_name, namespace, pod_id
Kubernetes nodesGET /container-security/combined/nodes/v1cluster_name, node_name, node_uid
Kubernetes containersGET /container-security/combined/containers/v1cluster_name, container_name, namespace, container_id
Kubernetes deploymentsGET /container-security/combined/deployments/v1cluster_name, deployment_name, namespace, deployment_id

uid is the user id (seed analyst is user-local-analyst). Users also accept sort as field.asc or field.desc on those same four fields.

Examples​

Users whose email starts with analyst:

email:'analyst*'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/user-management/queries/users/v1?filter=email:%27analyst*%27'

AND (email prefix and first name):

email:'a*'+first_name:'Ada'

OR (two email prefixes):

email:'a*',email:'b*'

API client by id:

client_id:'cs-local-read'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/api-clients/queries/api-clients/v1?filter=client_id:%27cs-local-read%27'

Hosts whose hostname starts with win:

hostname:'win*'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/devices/queries/devices/v1?filter=hostname:%27win*%27'

Host groups whose name starts with win:

name:'win*'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/devices/queries/host-groups/v1?filter=name:%27win*%27'

Windows sensor installers:

platform:'windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/sensors/queries/installers/v1?filter=platform:%27windows%27'

Installation tokens whose label starts with Default:

label:'Default*'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/installation-tokens/queries/tokens/v1?filter=label:%27Default*%27'

Windows prevention policies:

platform_name:'Windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/policy/queries/prevention/v1?filter=platform_name:%27Windows%27'

Windows response policies:

platform_name:'Windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/policy/queries/response/v1?filter=platform_name:%27Windows%27'

Windows sensor update policies:

platform_name:'Windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/policy/queries/sensor-update/v1?filter=platform_name:%27Windows%27'

Windows device control policies:

platform_name:'Windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/policy/queries/device-control/v1?filter=platform_name:%27Windows%27'

Domain IOC indicators:

type:'domain'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/iocs/queries/indicators/v1?filter=type:%27domain%27'

Windows Custom IOA groups:

platform:'windows'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/ioarules/queries/rule-groups/v1?filter=platform:%27windows%27'

FANCY BEAR Intel actor:

slug:'fancy-bear'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/intel/queries/actors/v1?filter=slug:%27fancy-bear%27'

Domain Intel indicators:

type:'domain'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/intel/queries/indicators/v1?filter=type:%27domain%27'

High Spotlight vulnerabilities:

severity:'high'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/spotlight/queries/vulnerabilities/v1?filter=severity:%27high%27'

Windows quarantined files:

hostname:'lab-win-1'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/quarantine/queries/quarantined-files/v1?filter=hostname:%27lab-win-1%27'

Windows Real Time Response sessions:

hostname:'win-dc-01'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/real-time-response/queries/sessions/v1?filter=hostname:%27win-dc-01%27'

Container image in lab/api:

repository:'lab/api'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/image-assessment/images/v1?filter=repository:%27lab/api%27'

Combined container vulnerability in lab/api:

repository:'lab/api'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/vulnerabilities/v1?filter=repository:%27lab/api%27'

Kubernetes pod on lab-eks-1:

cluster_name:'lab-eks-1'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/pods/v1?filter=cluster_name:%27lab-eks-1%27'

Kubernetes node on lab-eks-1:

cluster_name:'lab-eks-1'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/nodes/v1?filter=cluster_name:%27lab-eks-1%27'

Kubernetes container on lab-eks-1:

cluster_name:'lab-eks-1'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/containers/v1?filter=cluster_name:%27lab-eks-1%27'

Kubernetes deployment on lab-eks-1:

cluster_name:'lab-eks-1'
curl -sS -H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/container-security/combined/deployments/v1?filter=cluster_name:%27lab-eks-1%27'

Bearer (users, user-management:read):

TOKEN='<access_token>'
curl -sS -H 'Host: crowdstrike-api.localhost' \
-H "Authorization: Bearer ${TOKEN}" \
'http://127.0.0.1:8088/user-management/queries/users/v1?filter=email:%27analyst*%27'

Not FQL → 400:

curl -sS -o /dev/null -w '%{http_code}\n' \
-H 'Host: crowdstrike-api.localhost' -b cookies.txt \
'http://127.0.0.1:8088/user-management/queries/users/v1?filter=not-fql'