CrowdStrike
App · 25 actions
Investigate Falcon hosts, alerts, incidents and vulnerabilities, and manage host groups.
Actions
| Action | What it does |
|---|---|
| Create host groups | Create Host Groups by specifying details about the group to create |
| Delete host groups | Delete a set of Host Groups by specifying their IDs |
| Get alerts | Get all Alerts given their composite ids. |
| Get behaviors | DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. |
| Get CrowdScores | DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. |
| Get host groups | Retrieve a set of Host Groups by specifying their IDs |
| Get host online state | Get the online status for one or more hosts by specifying each host’s unique ID. |
| Get hosts | Get details on one or more hosts by providing host IDs as a query parameter. |
| Get incidents | DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. |
| Get remediations | Get details on remediations by providing one or more IDs |
| Get roles | Get info about a role |
| Get users | Get info about users including their name, UID, CID and whether they are external by providing user UUIDs |
| Get vulnerabilities | Get details on vulnerabilities by providing one or more IDs |
| List hidden hosts | Search for hidden hosts in your environment by platform, hostname, IP, and other criteria. |
| List host group members | Search for members of a Host Group in your environment by providing an FQL filter and paging details. |
| List host groups | Search for Host Groups in your environment by providing an FQL filter and paging details. |
| List hosts | Search for hosts in your environment by platform, hostname, IP, and other criteria. |
| List role IDs | Show role IDs for all roles available in your customer account. |
| Query alert IDs | Get all Alerts ids that match a given query. |
| Query behavior IDs | DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. |
| Query host IDs | Deprecated: Please use the CombinedDevicesByFilter endpoint. |
| Query incident IDs | DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. |
| Query user IDs | List user IDs for all users in your customer account, including external users who have roles assigned in your customer account. |
| Query vulnerability IDs | Search for Vulnerabilities in your environment by providing an FQL filter and paging details. |
| Update host groups | Update Host Groups by specifying the ID of the group and details to update |
Create host groups
Create Host Groups by specifying details about the group to create
Inputs
- Groups
groupslistRequired - Groups.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Delete host groups
Delete a set of Host Groups by specifying their IDs
Inputs
- IDS
idslistRequired - The IDs of the Host Groups to delete
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get alerts
Get all Alerts given their composite ids.
Inputs
- Include hidden
include_hiddentrue/false - allows previously hidden alerts to be retrieved
- IDS
idslistRequired - Ids.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get behaviors
DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026.
Inputs
- IDS
idslistRequired - Ids.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get CrowdScores
DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026.
Inputs
- Filter
filtertext - Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
- Offset
offsetnumber - Starting index of overall result set from which to return ids.
- Limit
limitnumber - The maximum records to return. [1-2500]At least 1.
- Sort
sorttext - The property to sort on, followed by a dot (.), followed by the sort direction, either "asc" or "desc".One of:
adjusted_score.asc,adjusted_score.desc,score.asc,score.desc,timestamp.asc,timestamp.desc.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get host groups
Retrieve a set of Host Groups by specifying their IDs
Inputs
- IDS
idslistRequired - The IDs of the Host Groups to return
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get host online state
Get the online status for one or more hosts by specifying each host’s unique ID.
Inputs
- IDS
idslistRequired - The unique ID of the host to get the online status of.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get hosts
Get details on one or more hosts by providing host IDs as a query parameter.
Inputs
- IDS
idslistRequired - The host agentIDs used to get details on
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get incidents
DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026.
Inputs
- IDS
idslistRequired - Ids.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get remediations
Get details on remediations by providing one or more IDs
Inputs
- IDS
idslistRequired - One or more remediation IDs (max: 400).
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get roles
Get info about a role
Inputs
- Cid
cidtext - Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
- IDS
idslistRequired - ID of a role. Find a role ID from queriesRolesV1.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get users
Get info about users including their name, UID, CID and whether they are external by providing user UUIDs
Inputs
- IDS
idslistRequired - Ids.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Get vulnerabilities
Get details on vulnerabilities by providing one or more IDs
Inputs
- IDS
idslistRequired - One or more vulnerability IDs (max: 400). Find vulnerability IDs with queryVulnerabilities
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}List hidden hosts
Search for hidden hosts in your environment by platform, hostname, IP, and other criteria. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Offset
offsettext - The offset to page from, provided from the previous call as the "next" value, for the next result set. For the first call, do not supply an offset.
- Limit
limitnumber - The maximum records to return. [1-10000]At least 1.
- Sort
sorttext - The property to sort by (e.g. status.desc or hostname.asc). If not specified, the default sort will be device_id.asc. This should be supplied for each consecutive call.One of:
config_id_platform,hostname,device_policies.data-protection.applied,device_policies.remote_response.policy_id,external_ip,device_policies.ztl.applied,device_policies.system-tray.applied,device_policies.mobile.applied,managed_apps.automox.version,email, and 188 more. - Filter
filtertext - The filter expression that should be used to limit the results. This should be supplied for each consecutive call.
- Fields
fieldstext - The fields to return, comma delimited if specifying more than one field. For example: fields=hostname,device_id would return device records only containing the hostname and device_id
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}List host group members
Search for members of a Host Group in your environment by providing an FQL filter and paging details. Gets one page; to see more, run it again with the next page it gives.
Inputs
- ID
idtext - The ID of the Host Group to search for members of
- Filter
filtertext - The filter expression that should be used to limit the results
- Offset
offsetnumber - The offset to start retrieving records fromAt least 0.
- Limit
limitnumber - The maximum records to return. [1-5000]From 1 to 5000.
- Sort
sorttext - The property to sort by
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}List host groups
Search for Host Groups in your environment by providing an FQL filter and paging details. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Filter
filtertext - The filter expression that should be used to limit the results
- Offset
offsetnumber - The offset to start retrieving records fromAt least 0.
- Limit
limitnumber - The maximum records to return. [1-5000]From 1 to 5000.
- Sort
sorttext - The property to sort byOne of:
created_by.asc,created_by.desc,created_timestamp.asc,created_timestamp.desc,group_type.asc,group_type.desc,modified_by.asc,modified_by.desc,modified_timestamp.asc,modified_timestamp.desc,name.asc,name.desc.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}List hosts
Search for hosts in your environment by platform, hostname, IP, and other criteria. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Offset
offsettext - The offset to page from, provided from the previous call as the "next" value, for the next result set. For the first call, do not supply an offset.
- Limit
limitnumber - The maximum records to return. [1-10000]At least 1.
- Sort
sorttext - The property to sort by (e.g. status.desc or hostname.asc). If not specified, the default sort will be device_id.asc. This should be supplied for each consecutive call.One of:
config_id_platform,hostname,device_policies.data-protection.applied,device_policies.remote_response.policy_id,external_ip,device_policies.ztl.applied,device_policies.system-tray.applied,device_policies.mobile.applied,managed_apps.automox.version,email, and 188 more. - Filter
filtertext - The filter expression that should be used to limit the results. This should be supplied for each consecutive call.
- Fields
fieldstext - The fields to return, comma delimited if specifying more than one field. For example: fields=hostname,device_id would return device records only containing the hostname and device_id
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}List role IDs
Show role IDs for all roles available in your customer account. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Cid
cidtext - Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
- User uuid
user_uuidtext - User UUID to get available roles for. Empty User UUID would returns all roles IDs available for customer.
- Target action
target_actiontext - Actionable purpose of the query
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query alert IDs
Get all Alerts ids that match a given query. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Include hidden
include_hiddentrue/false - allows previously hidden alerts to be retrieved
- Offset
offsetnumber - The first detection to return, where 0 is the latest detection. Use with the offset parameter to manage pagination of results.
- Limit
limitnumber - The maximum number of detections to return in this response (default: 100; max: 10000). Use this parameter together with the offset parameter to manage pagination of the results.From 0 to 10000.
- Sort
sorttext - Sort parameter takes the form . Direction can be either asc (ascending) or desc (descending) order. For example: status|asc or status|desc. The sorting fields can be any keyword field that is part of #domain.Alert except for the text based fields. Most commonly used fields are status, cid, aggregate_id, timestamp, created_timestamp, updated_timestamp, assigned_to_name, assigned_to_uid, assigned_to_uuid, show_in_ui, tactic_id, tactic, technique, technique_id, pattern_id, product, comment, tags If the fields are missing from the Alerts, the service will fallback to its default ordering
- Filter
filtertext - Filter Alerts using a query in Falcon Query Language (FQL).Filter fields can be any keyword field that is part of #domain.Alert An asterisk wildcard * includes all results. Empty value means to not filter on anything. Most commonly used filter fields that supports exact match: cid, id, aggregate_id, product, type, pattern_id, platform ... Most commonly used filter fields that supports wildcard (*): assigned_to_name, assigned_to_uuid, tactic_id, technique ... Most commonly filter fields that supports range comparisons (>, =, <=): severity, created_timestamp, timestamp, updated_timestamp... All filter fields and operations support negation (!).
- Q
qtext - Search all alert metadata for the provided string
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query behavior IDs
DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Filter
filtertext - Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
- Offset
offsetnumber - Starting index of overall result set from which to return ids.
- Limit
limitnumber - The maximum records to return. [1-500]At least 1.
- Sort
sorttext - The property to sort on, followed by a dot (.), followed by the sort direction, either "asc" or "desc".One of:
alert_ids.asc,alert_ids.desc,cmdline.asc,cmdline.desc,detection_ids.asc,detection_ids.desc,display_name.asc,display_name.desc,domain.asc,domain.desc, and 4 more.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query host IDs
Deprecated: Please use the CombinedDevicesByFilter endpoint. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Offset
offsettext - The offset to page from, provided from the previous scroll call, for the next result set. For the first call, do not supply an offset.
- Limit
limitnumber - The maximum records to return. [1-10000]At least 1.
- Sort
sorttext - The property to sort by (e.g. status.desc or hostname.asc)
- Filter
filtertext - The filter expression that should be used to limit the results
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query incident IDs
DECOMMISSIONED: DEPRECATED: the incidentapi will be removed in March 2026. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Sort
sorttext - The property to sort on, followed by a dot (.), followed by the sort direction, either "asc" or "desc".One of:
assigned_to.asc,assigned_to.desc,assigned_to_name.asc,assigned_to_name.desc,end.asc,end.desc,modified_timestamp.asc,modified_timestamp.desc,name.asc,name.desc, and 8 more. - Filter
filtertext - Optional filter and sort criteria in the form of an FQL query. For more information about FQL queries, see our FQL documentation in Falcon.
- Offset
offsetnumber - Starting index of overall result set from which to return ids.
- Limit
limitnumber - The maximum records to return. [1-500]At least 1.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query user IDs
List user IDs for all users in your customer account, including external users who have roles assigned in your customer account. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Filter
filtertext - Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, direct_assigned_cids, factors, first_name, has_temporary_roles, last_name, name, non_ancestor_assigned_cids, status, temporarily_assigned_cids, uid, uuid, associated_cids
- Offset
offsetnumber - The offset to start retrieving records fromAt least 0.
- Limit
limitnumber - The maximum records to return. [1-500]From 1 to 500.
- Sort
sorttext - The property to sort byOne of:
cid_name,cid_name|asc,cid_name|desc,created_at,created_at|asc,created_at|desc,first_name,first_name|asc,first_name|desc,has_temporary_roles, and 20 more. - User type
user_typetext - Filter results by user type (internal or external). Omit to return all users.One of:
internal,external.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Query vulnerability IDs
Search for Vulnerabilities in your environment by providing an FQL filter and paging details. Gets one page; to see more, run it again with the next page it gives.
Inputs
- After
aftertext - A pagination token used with the limit parameter to manage pagination of results. On your first request, don't provide an after token. On subsequent requests, provide the after token from the previous response to continue from that place in the results.
- Limit
limitnumber - The number of items to return in this response (default: 100, max: 400). Use with the after parameter to manage pagination of results.From 1 to 400.
- Sort
sorttext - Sort vulnerabilities by their properties. Available sort options: updated_t imestamp|asc/desc closed_timestamp|asc updated_timestamp|asc/desc rule.name|asc/desc rule.recommendation_id|asc/desc . Can be used in a format |asc for ascending order or |desc for descending order.
- Filter
filtertextRequired - Filter items using a query in Falcon Query Language (FQL). Wildcards * and empty filter values are unsupported. Available filter fields that supports match (~): N/A Available filter fields that supports exact match: aid, cid, last_seen_within, status, cve.id, cve.is_cisa_kev, cve.remediation_level, cve.cps_rating, cve.exprt_rating, cve.exploit_status_to_include, cve.severity, cve.base_score, cve.types, host_info.asset_criticality, host_info.asset_roles, host_info.internet_exposure, host_info.tags, host_info.groups, host_info.product_type_desc, host_info.platform_name, suppression_info.is_suppressed, suppression_info.reason, host_info.instance
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}Update host groups
Update Host Groups by specifying the ID of the group and details to update
Inputs
- Groups
groupslistRequired - Groups.
Outputs
Result.
dataobject- The complete service response; record and list fields retain their API names.
has_moretrue/false- Whether the API reports another page.
next_cursortext- Pass to the pagination field for the next page, when Has more is true.
Example output
{
"data": {
"errors": [],
"meta": {},
"resources": []
},
"has_more": false,
"next_cursor": null
}