xsiam-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@xsiam-mcp run XQL query for recent incidents"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
xsiam-mcp
A Model Context Protocol server for the Palo Alto Cortex XSIAM REST API.
It exposes the entire XSIAM REST API (129 operations across 26 categories — Incidents, Alerts, Endpoints, Response Actions, XQL, Scripts, IOCs/BIOCs, Assets, Datasets, Dashboards, Playbooks, Correlation Rules, and more) as MCP tools, auto-generated from the official OpenAPI spec so coverage stays complete and accurate. On top of that it adds a few composite tools designed for how AI agents actually work.
No Docker. Pure Python, launched over stdio by your MCP client.
Full coverage. One tool per API operation, with resolved JSON Schemas and a ready-to-use request example baked into every tool description.
Agent-friendly.
xsiam_healthto sanity-check auth,xsiam_list_operationsto discover tools by category, andxql_querythat runs an XQL query and polls to completion in a single call.
Install
Using uv (recommended — zero global install):
git clone <this-repo> xsiam-mcp && cd xsiam-mcp
uv venv && uv pip install -e .Or with pip:
pip install -e .Verify the tool catalog was generated (no credentials needed):
uv run xsiam-mcp --count # e.g. "129 generated XSIAM tools (+3 composite)."
uv run xsiam-mcp --list # print all tools grouped by categoryRelated MCP server: Cortex XSIAM MCP Gateway
Configuration
All configuration is via environment variables.
Variable | Required | Description |
| ✅ | The API key secret. |
| ✅ | The numeric key ID (sent as |
| ✅* | Tenant FQDN, e.g. |
| ✅* | Full API gateway URL; overrides |
|
| |
| Comma-separated tag names to expose (default: all). e.g. | |
| Per-request timeout in seconds (default | |
|
|
* Provide either XSIAM_FQDN or XSIAM_BASE_URL.
Getting credentials
In the XSIAM console go to Settings → Configurations → Integrations → API Keys, click New Key, choose Standard or Advanced, assign a role, and save. Copy the API Key (secret) and its ID, and grab the FQDN from the same page.
Standard key → set
XSIAM_AUTH_TYPE=standard(default). The key is sent directly in theAuthorizationheader.Advanced key → set
XSIAM_AUTH_TYPE=advanced. The server generates a nonce + timestamp and sendsAuthorizationas the SHA-256 ofapi_key + nonce + timestamp, per XSIAM's advanced auth scheme.
The API key's assigned role determines which operations succeed. A read-only key will get
403on write operations — that's expected.
MCP client configuration
Claude Desktop / Claude Code (claude_desktop_config.json or .mcp.json)
{
"mcpServers": {
"xsiam": {
"command": "uv",
"args": ["--directory", "/absolute/path/to/xsiam-mcp", "run", "xsiam-mcp"],
"env": {
"XSIAM_API_KEY": "your-api-key-secret",
"XSIAM_API_KEY_ID": "42",
"XSIAM_FQDN": "myco.xdr.us.paloaltonetworks.com",
"XSIAM_AUTH_TYPE": "standard"
}
}
}
}To scope the toolset down (fewer tools = easier for the agent), add e.g.
"XSIAM_TOOLSETS": "Incidents,Response Action,XQL query" to env.
XSIAM_TOOLSETSis a visibility filter — it controls which tools are advertised to the agent to reduce noise. It is not a security boundary: the API key's assigned role is what authorises each call server-side. Scope permissions with the key's role, not this variable.
Usage tips for agents
Call
xsiam_healthfirst to confirm connectivity and auth.Use
xsiam_list_operations(optionally with atagfilter like"incident"or"endpoint") to find the right tool.For data investigation, prefer
xql_query— it starts the query and polls for results in one shot.Every generated tool's description contains a concrete example body. Most list/read endpoints accept
{"request_data": {}}to return everything.
Development
uv pip install -e ".[dev]"
uv run pytest -qThe API surface is defined by src/xsiam_mcp/data/openapi.json. To update
coverage when the XSIAM spec changes, drop in a new spec file — tools regenerate
automatically, no code changes required.
Available Tools
132 toolsactions_file_retrieval_detailsA
File Retrieval Details
View the API required to call in order to download the file retrieved by the Retrieve File API request according to the action ID.
The response contains a file hash you need to download and then unzip to view:
Download the file.
curl -XPOST "https://api-{fqdn}/public_api/v1/download/<api_value>"
-H "x-xdr-auth-id:{API_KEY_ID}"
-H "Authorization:{API_KEY}"
-H 'Content-Type:application/json'
--output /tmp/file.zipUnzip the file:
unzip /tmp/file.zip
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/actions/file_retrieval_details] · Response Action
Example request body:
{
"request_data": {
"group_action_id": "<action ID>"
}
}Inputs: request_data (required).
actions_get_action_statusB
Get Action Status
Retrieve the status of the requested actions according to the action ID.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/actions/get_action_status] · Response Action
Example request body:
{
"request_data": {
"group_action_id": "<action ID>"
}
}Inputs: request_data (required).
alerts_create_alertA
Create a Custom Alert
Create a custom alert.
In addition to the mandatory fields (vendor, product, severity, category), any field that appears in the alert table can be used. In order to use a field from the alert table, use its lower camel case representation. For example: Container ID -> container_id. If the field in the alert table contains a hyphen, replace it with underscore, for example: App - ID -> app_id.
The following fields are recommended for creating an alert:
- remote_ip
- remote_host
- host_name
- group_id
- initiated_by
- initiator_sha256
- target_process_sha256
- cgo_sha256
- file_sha256
- os_parent_cmd
- os_parent_user_name
By using multiple calls of create_alert, you can send up to 600 alerts per minute.
Required role: App Service Account
Required licenses: Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus.
[POST /public_api/v1/alerts/create_alert] · Incidents
Inputs: request_data.
alerts_get_alertsA
Get all Alerts
Get a list of all or filtered alerts. The alerts listed are what remains after alert exclusions are applied by Cortex XSIAM.
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of alerts from the start of the result set. The response indicates whether an PAN NGFW type alert contains a PCAP triggering packet. Use the Retrieve PCAP Packet API to retrieve a list of alert IDs and their associated PCAP data.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/get_alerts] · Incidents
Example request body:
{
"request_data": {
"filters": [
{
"field": "severity",
"operator": "in",
"value": [
"medium",
"high"
]
}
],
"search_from": 0,
"search_to": 5,
"sort": {
"field": "severity",
"keyword": "asc"
}
}
}Inputs: request_data.
alerts_get_alerts_pcapA
Retrieve PCAP Packet
Retrieve a list of alert IDs and the associated PCAP triggering packets of PAN NGFW type alerts returned when running the Get Alerts and Get Extra Incident Data APIs. Maximum result set size is 100.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/get_alerts_pcap] · Incidents
Example request body:
{
"request_data": {
"filters": [
{
"field": "severity",
"operator": "in",
"value": [
"medium",
"high"
]
}
],
"search_from": 0,
"search_to": 5,
"sort": {
"field": "severity",
"keyword": "asc"
}
}
}Inputs: request_data.
alerts_insert_cef_alertsA
Insert CEF Alerts
Upload alerts in CEF format from external alert sources. After you map CEF alert fields to Cortex XDR fields, Cortex XDR displays the alerts in related incidents and views. You can send 600 alerts per minute.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/insert_cef_alerts] · Incidents
Example request body:
{
"request_data": {
"alerts": [
"CEF:0|Check Point|VPN-1 & FireWall-1|Check Point|Log|microsoft-ds|Unknown|act=AcceptdeviceDirection=0 rt=1569---000 spt=5---57 dpt=4---5cs2Label=Rule Name cs2=ADPrimerylayer_name=FW_Device_blackenedSecuritylayer_uuid=07-----fc7-1a5c-71b8c match_id=1---6parent_rule=0rule_action=Accept rule_uid=8----be5cifname=bond2logid=0loguid={0x5d8c5388,0x61,0x29321fac,0xc0000022}origin=1.1.1.1originsicname=CN=DWdeviceBlackend,O=Blackend sequencenum=363version=5dst=1.1.1.1 inzone=External outzone=Internal product=VPN-1 & FireWall-1proto=6service_id=microsoft-ds src=1.1.1.1",
"CEF:0|Check Point|VPN-1 & FireWall-1|Check Point|Log|Log|Unknown|act=AcceptdeviceDirection=0 rt=1569477501000 spt=63088 dpt=5985cs2Label=RuleNamelayer_name=FW_Device_blackenedSecuritylayer_uuid=07693f---e96c71b8c match_id=8----9parent_rule=0rule_action=Acceptrule_uid=ae9---70f-ab1c-1ad552c82369conn_direction=Internal ifname=bond1.12logid=0loguid={0x5d8c537d,0xbb,0x29321fac,0xc0000014}origin=1.1.1.1originsicname=CN=DWdeviceBlackend,O=Blackend sequencenum=899version=5dst=1.1.1.1 product=VPN-1 & FireWall-1 proto=6 src=1.1.1.1"
]
}
}Inputs: request_data.
alerts_insert_parsed_alertsA
Insert Parsed Alerts
Upload alerts from external alert sources in Cortex XSIAM format. Cortex XSIAM displays alerts that are parsed successfully in related incidents and views. You can send 600 alerts per minute. Each request can contain a maximum of 60 alerts.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/insert_parsed_alerts] · Incidents
Example request body:
{
"request_data": {
"alerts": [
{
"product": "VPN & Firewall-1",
"vendor": "<vendor name>",
"local_ip": "<IP address>",
"local_port": "<port>",
"remote_ip": "<IP address>",
"remote_port": "<port>",
"event_timestamp": 1543270652000,
"severity": "Low",
"alert_name": "Alert Name Example",
"alert_description": "Alert Description",
"action_status": "Reported",
"local_ip_v6": "<IPv6 address>",
"remote_ip_v6": "<IPv6 address>"
}
]
}
}Inputs: request_data.
alerts_update_alertsA
Update Alerts
Update one or more alerts. You can update up to 100 alerts per request. Missing fields are ignored.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/update_alerts] · Incidents
Example request body:
{
"request_data": {
"alert_id_list": "<list of ids>",
"update_data": {
"severity": "medium",
"status": "resolved_other",
"comment": "This incident is resolved"
}
}
}Inputs: request_data.
asm_management_remove_asm_dataA
Remove Assets
Remove certificates, domains (paid-level domains and subdomains), and IPv4 address ranges from your inventory. Remove up to 500 certificates, domains, or IP ranges per request.
Removed assets appear the Asset Uploads/Removals table with the status Removed. Within 24 hours of submitting your request, assets are removed from the inventory. Within a few days, related incidents, alerts, and services are also removed. You cannot remove an asset that was uploaded in a previous upload request.
When you remove a paid-level domain, related subdomains are also removed. When you remove an IPv4 range, the individual IPv4 addresses in that range are also removed.
Required role: Instance Admin
Required license: Cortex XSIAM Premium or Cortex XSIAM with ASM add-on
[POST /public_api/v1/asm_management/remove_asm_data] · Asset Management
Example request body:
{
"request_data": {
"asset_type": "domain",
"asset_identifiers": [
"test1.com",
"test2.com"
]
}
}Inputs: request_data (required).
asm_management_upload_asm_dataA
Upload assets to the inventory
Upload domains (paid-level domains (PLD) and subdomains) and IPv4 address ranges. You can upload up to 500 IP address ranges or domains in each request.
You must have Instance Administrator permissions to run this endpoint.
Required license: Cortex XSIAM Premium or Cortex XSIAM with ASM add-on
[POST /public_api/v1/asm_management/upload_asm_data] · Asset management
Example request body:
{
"request_data": {
"request_type": "Addition",
"asset_type": "ip_range",
"asset_identifiers": [
"192.84.12.55-192.84.12.68"
],
"business_units": [
"BU:1",
"BU:2"
]
}
}Inputs: request_data (required).
assets_bulk_update_vulnerability_testsB
Bulk Update Vulnerability Tests
Enable or disable vulnerability tests.
[POST /public_api/v1/assets/bulk_update_vulnerability_tests] · Asset management
Example request body:
{
"request_data": {
"test_names": [
"Apache Solr DataImportHandler Code Injection Vulnerability"
],
"status": "Enabled"
}
}Inputs: request_data.
assets_get_asset_internet_exposureA
Get Internet Exposure
Get Internet exposure asset details according to the asset ID. You can send up to 20 IDs.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/assets/get_asset_internet_exposure] · Asset management
Example request body:
{
"request_data": {
"asm_id_list": [
"<asset_ID>"
]
}
}Inputs: request_data.
assets_get_assets_internet_exposureA
Get all Internet Exposures
Get a list of all your Internet exposure filtered by business units, externally detected providers, externally inferred CVEs, mac addresses, names, IP addresses, whether it has an XDR agent, whether it has active external services, and type.
The maximum result limit is 500 assets.
Note: You can send a request to retrieve either all or filtered results.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/assets/get_assets_internet_exposure] · Asset management
Example request body:
{
"request_data": {
"filters": [
{
"field": "has_xdr_agent",
"operator": "in",
"value": [
"n/a",
false,
true
]
},
{
"field": "has_active_external_services",
"operator": "in",
"value": [
false
]
}
],
"search_from": 0,
"search_to": 500,
"sort": {
"field": "last_observed",
"keyword": "desc"
}
}
}Inputs: request_data.
assets_get_external_ip_address_rangeB
Get External IP Address Range
Get external IP address range details according to the range IDs. You can send up to 100 IDs.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/assets/get_external_ip_address_range] · Asset management
Example request body:
{
"request_data": {
"range_id_list": [
"<range_ID>"
]
}
}Inputs: request_data.
assets_get_external_ip_address_rangesA
Get all External IP Address Ranges
Get a list of all your Internet exposure filtered by business units and organization handles.
The maximum result limit is 1000 ranges.
Note: You can send a request to retrieve either all or filtered results.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/assets/get_external_ip_address_ranges] · Asset management
Example request body:
{
"request_data": {
"filters": [
{
"field": "organization_handles",
"operator": "contains",
"value": "irt"
}
],
"search_from": 0,
"search_to": 500
}
}Inputs: request_data.
assets_get_external_serviceA
Get External Service
Get service details according to the service ID. You can send up to 20 IDs.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise, Cortex XSIAM Enterprise Plus or Cortex XSIAM Premium
[POST /public_api/v1/assets/get_external_service] · Asset management
Example request body:
{
"request_data": {
"service_id_list": [
"<service_ID>"
]
}
}Inputs: request_data (required).
assets_get_external_servicesA
Get All Services
Get a complete or filtered list of all your external services.
The maximum result limit is 500.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise, Cortex XSIAM Enterprise Plus or Cortex XSIAM Premium
[POST /public_api/v1/assets/get_external_services] · Asset management
Example request body:
{
"request_data": {
"filters": [
{
"field": "discovery_type",
"operator": "in",
"value": [
"colocated_on_ip"
]
}
]
}
}Inputs: request_data (required).
assets_get_external_websiteB
Get Website Details
Get details about specific websites based on website IDs. You can submit up to 20 website IDs.
Required license: Cortex XSIAM Premium or Cortex XSIAM with ASM Add-on
[POST /public_api/v1/assets/get_external_website] · Asset management
Inputs: request_data (required).
assets_get_external_websitesA
Get All Websites
Get a complete or filtered list of your public-facing websites.
Required license: Cortex XSIAM Premium or Cortex XSIAM with ASM Add-on
[POST /public_api/v1/assets/get_external_websites] · Asset management
Inputs: request_data (required).
assets_get_external_websites_last_external_assessmentA
Get Websites Last Assessment
Gets the time and status of the last update of websites data in Cortex. A status of "true" indicates the websites data update was successful.
[POST /public_api/v1/assets/get_external_websites/last_external_assessment] · Asset management
Inputs: request_data (required).
assets_get_vulnerability_testsA
Get Vulnerability Tests
Get a complete or filtered list of vulnerability tests. Results include details about each test, including the number of services confirmed vulnerable.
[POST /public_api/v1/assets/get_vulnerability_tests] · Asset management
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "contains",
"value": "apache"
}
]
}
}Inputs: request_data (required).
audits_agents_reportsA
Get Audit Agent Report
Get agent event reports.
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/audits/agents_reports] · Audit log
Example request body:
{
"request_data": {
"filters": [
{
"field": "trapsversion",
"operator": "in",
"value": [
"<version value>",
"<version value>"
]
},
{
"field": "timestamp",
"operator": "gte",
"value": 0
},
{
"field": "domain",
"operator": "in",
"value": [
"WORKGROUP"
]
}
],
"sort": {
"field": "timestamp",
"keyword": "asc"
}
}
}Inputs: request_data.
audits_management_logsB
Get Audit Management Log
Get audit management logs.
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of incidents from the start of the result set.
[POST /public_api/v1/audits/management_logs] · Audit log
Example request body:
{
"request_data": {
"search_from": 0,
"search_to": 19,
"sort": {
"field": "email",
"keyword": "ASC"
},
"filters": [
{
"field": "type",
"operator": "in",
"value": [
"AUTH"
]
},
{
"field": "sub_type",
"operator": "in",
"value": [
"login"
]
},
{
"field": "result",
"operator": "in",
"value": [
"SUCCESS"
]
},
{
"field": "timestamp",
"operator": "lte",
"value": 1565074114053
}
]
}
}Inputs: request_data.
authentication_settings_createA
Create authentication settings for IdP SSO or metadata URL
Create authentication settings for IdP SSO or metadata URL. You must include either the metadata_url field or all of the following fields: idp_sso_url, idp_issuer, and idp_certificate.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/authentication-settings/create] · Authentication settings
Example request body:
{
"request_data": {
"name": "str",
"default_role": "",
"is_account_role": false,
"domain": " ",
"mappings": {
"email": "str",
"firstname": "str",
"lastname": "str",
"group_name": "str"
},
"advanced_settings": {
"relay_state": " ",
"idp_single_logout_url": " ",
"service_provider_public_cert": " ",
"service_provider_private_key": " ",
"authn_context_enabled": " ",
"force_authn": false
},
"idp_sso_url": " ",
"idp_certificate": " ",
"idp_issuer": " ",
"metadata_url": " "
}
}Inputs: request_data (required).
authentication_settings_deleteA
Delete authentication settings by domain
Delete all authentication settings for the specified domain.
**Note: ** The first configuration on the tenant is the default configuration and cannot be deleted.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/authentication-settings/delete] · Authentication settings
Example request body:
{
"request_data": {
"domain": "str"
}
}Inputs: request_data.
authentication_settings_get_metadataA
Get IdP metadata
Get the metadata for all IdPs.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/authentication-settings/get/metadata] · Authentication settings
Example request body:
{
"request_data": {}
}Inputs: request_data.
authentication_settings_get_settingsA
Get authentication settings for all configured domains
Get all the authentication settings for every configured domain in the tenant.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/authentication-settings/get/settings] · Authentication settings
Example request body:
{
"request_data": {}
}Inputs: request_data.
authentication_settings_updateB
Update authentication settings
Update existing authentication settings. To update the default domain, include empty value for both current_domain_value and new_domain_value.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/authentication-settings/update] · Authentication settings
Example request body:
{
"request_data": {
"name": "str",
"default_role": "",
"is_account_role": false,
"domain": " ",
"mappings": {
"email": "str",
"firstname": "str",
"lastname": "str",
"group_name": "str"
},
"advanced_settings": {
"relay_state": " ",
"idp_single_logout_url": " ",
"service_provider_public_cert": " ",
"service_provider_private_key": " ",
"authn_context_enabled": " ",
"force_authn": false
},
"idp_sso_url": " ",
"idp_certificate": " ",
"idp_issuer": " ",
"metadata_url": " "
}
}Inputs: request_data (required).
bioc_deleteA
Delete BIOCs
Delete BIOCs selected by filter.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/bioc/delete] · BIOCs
Example request body:
{
"request_data": {
"extended_view": false,
"filters": [
{
"field": "severity",
"operator": "EQ",
"value": "SEV_020_LOW"
}
]
}
}Inputs: request_data (required).
bioc_getA
Get BIOCs
Return a list of BIOCs. You can return all BIOCs or filter results. You can also return extended results with all details included.- The response is concatenated using AND condition (OR is not supported).
The maximum result set size is >100.
Offset is the zero-based number of incidents from the start of the result set.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/bioc/get] · BIOCs
Example request body:
{
"request_data": {
"extended_view": false
}
}Inputs: request_data (required).
bioc_insertA
Insert or update BIOCs
Insert new BIOCs or update existing BIOCs.
Note: The BIOC rule_id is tenant specific and can't be used across tenants. Inserting BIOCs with the same rule_id as an existing BIOC on that tenant will overwrite the existing BIOC.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/bioc/insert] · BIOCs
Example request body:
{
"request_data": [
{
"name": "TestBIOC",
"type": "EXECUTION",
"severity": "SEV_020_LOW",
"comment": "",
"status": "ENABLED",
"is_xql": false,
"indicator": {
"runOnCGO": true,
"investigationType": "FILE_EVENT",
"investigation": {
"FILE_EVENT": {
"filter": {
"AND": [
{
"OR": [
{
"SEARCH_FIELD": "event_sub_type",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "1",
"isExtended": false
},
{
"SEARCH_FIELD": "event_sub_type",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "2",
"isExtended": false
},
{
"SEARCH_FIELD": "event_sub_type",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "3",
"isExtended": false
},
{
"SEARCH_FIELD": "event_sub_type",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "5",
"isExtended": false
},
{
"SEARCH_FIELD": "event_sub_type",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "6",
"isExtended": false
}
]
},
{
"SEARCH_FIELD": "action_file_name",
"SEARCH_TYPE": "EQ",
"SEARCH_VALUE": "aaaaaa",
"EXTRA_FIELDS": [],
"isExtended": false
}
]
}
}
}
},
"mitre_tactic_id_and_name": [
""
],
"mitre_technique_id_and_name": [
""
]
}
]
}Inputs: request_data (required).
correlations_deleteB
Delete Correlation Rules
Delete correlation rules selected by filter.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/correlations/delete] · Correlation Rules
Example request body:
{
"request_data": {
"extended_view": false,
"filters": [
{
"field": "rule_id",
"operator": "EQ",
"value": 28
}
]
}
}Inputs: request_data (required).
correlations_getA
Get Correlation Rules
Return a list of correlation rules. You can return all correlation rules or filter results. You can also return extended results with all details included.
The response is concatenated using AND condition (OR is not supported).
The maximum result set size is >100.
Offset is the zero-based number of incidents from the start of the result set.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/correlations/get] · Correlation Rules
Example request body:
{
"request_data": {
"extended_view": false
}
}Inputs: request_data (required).
correlations_insertA
Insert or update Correlation Rules
Insert new Correlation Rules or update existing Correlation Rules.
Note: The Correlation Rule id is tenant specific and can't be used across tenants. Inserting Correlation Rules with the same id as an existing Correlation Rule on that tenant will overwrite the existing Correlation Rule.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/correlations/insert] · Correlation Rules
Example request body:
{
"request_data": [
{
"id": 28,
"name": "Test",
"severity": "SEV_030_MEDIUM",
"xql_query": "dataset = xdr_data | fields event_type, action_process_username, uuid, action_boot_time | comp values(*) as * by action_process_username\n",
"is_enabled": "ENABLED",
"description": "RTESRTESTestret",
"alert_name": "Test",
"alert_category": "DISCOVERY",
"alert_description": "Test",
"alert_fields": {},
"execution_mode": "REAL_TIME",
"search_window": "1 hours",
"simple_schedule": "10 minutes",
"timezone": "Asia/Jerusalem",
"crontab": "*/10 * * * *",
"suppression_enabled": true,
"suppression_duration": "1 hours",
"suppression_fields": [
"event_type"
],
"dataset": "alerts",
"mitre_defs": {
"TA0005 - Defense Evasion": [
"T1014 - Rootkit"
]
},
"investigation_query_link": "dataset = xdr_data | fields event_type, action_process_username, uuid, action_boot_time | comp values(*) as * by action_process_username",
"drilldown_query_timeframe": "ALERT",
"mapping_strategy": "AUTO"
}
]
}Inputs: request_data (required).
dashboards_deleteA
Delete dashboards
Delete the dashboards retrieved by the Get dashboards API.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/dashboards/delete] · Dashboards
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"value": "Incident by Severity",
"operator": "EQ"
},
{
"field": "source",
"value": "John Doe",
"operator": "EQ"
}
]
}
}Inputs: request_data (required).
dashboards_getA
Get dashboards
Get dashboard details by filtering based on the dashboard name, dashboard ID, time the dashboard was generated, or dashboard source.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/dashboards/get] · Dashboards
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"value": "This is a cool dashboard",
"operator": "EQ"
},
{
"field": "source",
"value": "Vitaly Fintushal",
"operator": "EQ"
}
]
}
}Inputs: request_data (required).
dashboards_insertA
Insert or update dashboards
Add or update the dashboards retrieved by the Get dashboards API.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/dashboards/insert] · Dashboards
Example request body:
{
"request_data": {
"dashboards_data": [
{
"name": "temp",
"description": null,
"status": "ENABLED",
"layout": [
{
"id": "row-9847",
"data": [
{
"key": "incidentsBySeverity",
"data": {
"type": "Pie",
"width": 25,
"height": 451
}
},
{
"key": "xql_17083686713115",
"data": {
"type": "Custom XQL",
"width": 25,
"height": 451,
"phrase": "dataset = xdr_data ",
"time_frame": {
"relativeTime": 86400000
},
"viewOptions": {
"type": "table",
"commands": []
}
}
},
{
"key": "incidentsByAssignment",
"data": {
"type": "Bar",
"width": 25,
"height": 451
}
},
{
"key": "incidentsHistory",
"data": {
"type": "Timeline",
"width": 25,
"height": 451,
"time_frame": {
"relativeTime": 86400000
},
"alerts_or_incidents": "incident"
}
}
]
},
{
"id": "row-2618",
"data": [
{
"key": "topIncidentsByAlertSeverity",
"data": {
"type": "Table",
"width": 50,
"height": 408
}
},
{
"key": "hostsBySeverity",
"data": {
"type": "Table",
"width": 50,
"height": 408
}
}
]
},
{
"id": "row-776",
"data": [
{
"key": "incidentsByAssigneeOverTime",
"data": {
"type": "Timeline",
"width": 100,
"height": 250,
"time_frame": {
"relativeTime": 2592000000
}
}
}
]
}
],
"default_dashboard_id": 1,
"global_id": "aaebad58d7f84452abe650cf34b80d64",
"metadata": {
"params": []
}
}
],
"widgets_data": [
{
"widget_key": "xql_17083686713115",
"title": "papi_widget_test2",
"creation_time": 1713089132145,
"description": null,
"data": {
"phrase": "dataset = xdr_data ",
"time_frame": {
"relativeTime": 86400000
},
"viewOptions": {
"type": "table",
"commands": []
}
},
"support_time_range": true,
"additional_info": {
"query_tables": [
"xdr_data"
],
"query_uses_library": false
},
"creator_mail": "user@company.com"
}
]
}
}Inputs: request_data.
dataset_define_datasetA
Define an XQL user dataset
Define an XQL user dataset based on an existing BigQuery table created by the user.
Note: BigQuery table must be an existing table under public_access_user.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus.
These APIs are only applicable from within the XSIAM Notebook environment.
[POST /public_api/v1/dataset/define_dataset] · XQL user datasets
Inputs: request_data.
dataset_delete_datasetB
Delete an XQL user dataset
Delete an XQL user dataset that was created by the Cortex SDK.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus.
These APIs are only applicable from within the XSIAM Notebook environment.
[POST /public_api/v1/dataset/delete_dataset] · XQL user datasets
Inputs: request_data.
dataset_get_created_datasetsA
Get created XQL user datasets
Retrieve a list of all XQL user datasets created using the Cortex SDK.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus.
These APIs are only applicable from within the XSIAM Notebook environment.
[POST /public_api/v1/dataset/get_created_datasets] · XQL user datasets
Inputs: no named parameters.
device_control_get_violationsA
Get Violations
Gets a list of device control violations filtered by selected fields. You can retrieve up to 100 violations.
When filtering by multiple fields:
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/device_control/get_violations] · Endpoint Management
Example request body:
{
"request_data": {
"filters": [
{
"field": "type",
"operator": "in",
"value": [
"disk drivE"
]
}
],
"search_to": 1
}
}Inputs: request_data.
distributions_createA
Create distributions
Create an installation package. This is an async call that returns the distribution ID; it does not mean that the creation succeeded. To confirm the package has been created, check the status of the distribution by running the Get Distribution Status API.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/distributions/create] · Endpoint Management
Example request body:
{
"request_data": {
"name": "<installation package name>",
"platform": "windows",
"package_type": "standalone",
"agent_version": "<agent version>"
}
}Inputs: request_data (required).
distributions_deleteA
Delete agent installation packages
Delete an agent installation package. The distribution ID is required and can be found in the Create distributions API response or in the Agent Installations screen in the Cortex Console.
**Note: ** Once you delete an installation package, it prevents new agents using the package, including VDI, from registering.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/distributions/delete] · Endpoint Management
Example request body:
{
"request_data": {
"distribution_id": "1223"
}
}Inputs: request_data.
distributions_get_dist_urlA
Get Distribution URL
Get the distribution URL for downloading the installation package.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/distributions/get_dist_url] · Endpoint Management
Example request body:
{
"request_data": {
"distribution_id": "<distribution ID>",
"package_type": "x86"
}
}Inputs: request_data (required).
distributions_get_statusA
Get Distribution status
Check the status of the installation package.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/distributions/get_status] · Endpoint Management
Example request body:
{
"request_data": {
"distribution_id": "<distribution ID>"
}
}Inputs: request_data (required).
distributions_get_versionsA
Get Distribution version
Get a list of all the agent versions to use for creating a distribution list.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/distributions/get_versions] · Endpoint Management
Inputs: no named parameters.
endpoints_abort_scanA
Cancel Scan Endpoints
Cancel the scan of selected endpoints. A scan can only be aborted if the selected endpoints are in Pending or in Progress status.
When filtering by multiple fields:
Response is concatenated using AND condition (OR is not supported).
Offset is the zero-based number of endpoints from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/abort_scan] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
},
{
"field": "dist_name",
"operator": "in",
"value": [
"WinInstaller"
]
},
{
"field": "group_name",
"operator": "in",
"value": [
"test"
]
},
{
"field": "scan_status",
"operator": "in",
"value": [
"none",
"pending",
"in_progress",
"pending_cancellation",
"aborted",
"success"
]
},
{
"field": "group_name",
"operator": "in",
"value": [
"test"
]
}
]
}
}Inputs: request_data (required).
endpoints_deleteA
Delete Endpoints
Delete selected endpoints in the Cortex XDR app. You can delete up to 1000 endpoints.
Note: Endpoints are deleted from the Cortex XDR app web interface, however they still exist in the database.
When filtering by multiple fields:
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 1000.
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/delete] · Endpoint Management
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
}
]
}
}Inputs: request_data.
endpoints_file_retrievalA
Retrieve File
Retrieve files from selected endpoints. You can retrieve up to 20 files, from no more than 10 endpoints.
Response is concatenated using AND condition (OR is not supported).
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/file_retrieval] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID 1>",
"<endpoint ID 2>",
"<endpoint ID 3>"
]
}
],
"files": {
"windows": [
"C:\\<file path>\\test.txt"
]
}
}
}Inputs: request_data (required).
endpoints_get_endpointA
Get Endpoint
Gets a list of filtered endpoints.
The response is concatenated using AND condition (OR is not supported).
The maximum result set size is 100.
Offset is the zero-based number of endpoints from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/get_endpoint] · Endpoint Management
Example request body:
{
"request_data": {
"search_from": 0,
"search_to": 1,
"sort": {
"field": "endpoint_id",
"keyword": "ASC"
},
"filters": [
{
"field": "group_name",
"operator": "in",
"value": [
"Test-Group-01"
]
},
{
"field": "endpoint_status",
"operator": "in",
"value": [
"disconnected"
]
},
{
"field": "dist_name",
"operator": "in",
"value": [
"papi-test"
]
},
{
"field": "scan_status",
"operator": "in",
"value": [
"none",
"pending",
"in_progress",
"pending_cancellation",
"aborted",
"success",
"canceled",
"error"
]
}
]
}
}Inputs: request_data.
endpoints_get_endpointsA
Get all Endpoints
Gets a list of all of your endpoints. The response is concatenated using AND condition (OR is not supported).
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/get_endpoints] · Endpoint Management
Inputs: no named parameters.
endpoints_get_policyA
Get Policy
Get the policy name for a specific endpoint.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/get_policy] · Endpoint Management
Example request body:
{
"request_data": {
"endpoint_id": "<endpoint ID>"
}
}Inputs: request_data (required).
endpoints_isolateA
Isolate Endpoints
Isolate one or more endpoints in a single request. Request is limited to 1000 endpoints.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/isolate] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID 1>",
"<endpoint ID 2>",
"<endpoint ID 3>"
]
}
]
}
}Inputs: request_data (required).
endpoints_quarantineB
Quarantine Files
Quarantine file on selected endpoints. You can select up to 1000 endpoints.
Note: A success response means that the request reached the defined endpoints, however if the file was not found there, no quarantine action will take place. To ensure if the file has been quarantined, check the Cortex XDR Action Center.
When filtering by multiple fields:
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 1000.
Offset is the zero-based number of incidents from the start of the result set.
[POST /public_api/v1/endpoints/quarantine] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
}
],
"file_path": "C:\\<file path>\\test_x64.msi",
"file_hash": "<hash value>"
}
}Inputs: request_data (required).
endpoints_restoreB
Restore File
Restore a quarantined file on a requested endpoints. When filtering by multiple fields:
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/restore] · Response Action
Example request body:
{
"request_data": {
"file_hash": "<hash value>",
"incident_id": 302
}
}Inputs: request_data (required).
endpoints_scanA
Scan Endpoints
Run a scan on selected endpoints.
Response is concatenated using AND condition (OR is not supported).
Offset is the zero-based number of incidents from the start of the result set.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/scan] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
},
{
"field": "dist_name",
"operator": "in",
"value": [
"WinInstaller"
]
},
{
"field": "group_name",
"operator": "in",
"value": [
"test"
]
},
{
"field": "scan_status",
"operator": "in",
"value": [
"none",
"pending",
"in_progress",
"pending_cancellation",
"aborted",
"success"
]
},
{
"field": "group_name",
"operator": "in",
"value": [
"test"
]
}
]
}
}Inputs: request_data (required).
endpoints_unisolateA
Unisolate Endpoints
Reverse the isolation of one or more endpoints in single request.
Note: You can only send a request with either endpoint_id to unisolate one endpoint or with filters to unisolate more than one endpoint. An error is raised if you try to use both endpoint_id and the filters.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/unisolate] · Response Action
Example request body:
{
"request_data": {
"filters": [
{
"field": "dist_name",
"operator": "IN",
"value": [
"MG"
]
}
]
}
}Inputs: request_data (required).
endpoints_update_agent_nameA
Set an Endpoint Alias
Set or modify an Alias field for your endpoints.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/endpoints/update_agent_name] · Endpoint Management
Example request body:
{
"context": {
"lcaas_id": "<tenant_id>"
},
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<distribution_id"
]
}
],
"alias": "<alias_name>"
}
}Inputs: request_data.
entries_getA
Get War Room entries
Get the War Room entries for a specific incident or alert. You can filter by timestamp, ID, and tags. You can also choose which type of entries you want to retrieve (notes, chat, attachments...). The response depends on what type of entry you choose to retrieve.
[POST /public_api/v1/entries/get] · Incidents
Example request body:
{
"id": "INCIDENT-1",
"filter": {
"firstID": "q3452345",
"lastID": "50577055-a7f3-4328-8eec-5ff8433e21e6@2",
"pagesize": 4,
"fromTime": "2024-11-24T09:14:14Z",
"categories": [
"tags"
],
"tags": [
"amir100",
"amir200"
]
}
}Inputs: id, filter.
entries_insertA
Add War Room entries
Add an entry to the incident or alert War Room, including data. Note: This endpoint only adds entries to existing War Rooms; it does not create them. Ensure that the War Room already exists before making this request.
[POST /public_api/v1/entries/insert] · Incidents
Example request body:
{
"Id": "1",
"data": "!Print value=1000"
}Inputs: id, data.
featured_fields_replace_ad_groupsA
Replace Featured Active Directory Groups
Replace the featured active directory groups and organizational units listed in your environment.
Note: Running this API will delete all existing active directory groups.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/featured_fields/replace_ad_groups] · Incidents
Example request body:
{
"request_data": {
"fields": [
{
"value": "domain/administrators-group",
"type": "group",
"comment": "Administrators-group is a featured AD group"
},
{
"value": "dev",
"type": "OU"
}
]
}
}Inputs: request_data (required).
featured_fields_replace_hostsA
Replace Featured Hosts
Replace the featured hosts listed in your environment.
Note: Running this API will delete all existing host names.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/featured_fields/replace_hosts] · Incidents
Example request body:
{
"request_data": {
"fields": [
{
"value": "ADMIN-PC",
"comment": "ADMIN-PC is a featured host"
},
{
"value": "CEO-PC"
}
]
}
}Inputs: request_data (required).
featured_fields_replace_ip_addressesA
Replace Featured IP Addresses
Replace the featured IP addresses listed in your environment.
Note: Running this API will delete all existing IP addresses.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/featured_fields/replace_ip_addresses] · Incidents
Example request body:
{
"request_data": {
"fields": [
{
"value": "1.2.3.4",
"comment": "A single featured IP"
},
{
"value": "192.111.1.0-192.111.1.255",
"comment": "Featured IP range"
},
{
"value": "7.7.7.7/16",
"comment": "Featured CIDR"
}
]
}
}Inputs: request_data (required).
featured_fields_replace_usersA
Replace Featured Users
Replace the featured users listed in your environment.
Note: Running this API will delete all existing user names.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/featured_fields/replace_users] · Incidents
Example request body:
{
"request_data": {
"fields": [
{
"value": "Administrator",
"comment": "Administrator is a featured user"
},
{
"value": "System"
}
]
}
}Inputs: request_data (required).
get_attack_surface_rulesC
Get All Attack Surface Rules
Get all or a subset of attack surface rules.
Required license: Cortex XSIAM Premium or Cortex XSIAM with ASM add-on
[POST /public_api/v1/get_attack_surface_rules] · Attack Surface Rules
Inputs: request_data (required).
get_risk_scoreA
Get Risk Score
Retrieve the risk score of a specific user or endpoint in your environment, along with the reason for the score.
Required license: Cortex XSIAM Premium or Identity Threat Module
[POST /public_api/v1/get_risk_score] · System management
Example request body:
{
"request_data": {
"id": "<user or endpoint ID>"
}
}Inputs: request_data (required).
get_risky_hostsA
Get Risky Hosts
Retrieve a list of endpoints with the highest risk score in your environment along with the reason for each score.
Required license: Cortex XSIAM Premium or Identity Threat Module
[POST /public_api/v1/get_risky_hosts] · System management
Inputs: no named parameters.
get_risky_usersA
Get Risky Users
Retrieve a list of users with the highest risk score in your environment along with the reason affecting each score.
Required license: Cortex XSIAM Premium or Identity Threat Module
[POST /public_api/v1/get_risky_users] · System management
Inputs: no named parameters.
get_triage_presetsB
Get triage presets
Get all triage preset information including triage name, platform, description, created by, and triage type.
Required license: Cortex XSIAM Premium or Forensics add-on
[POST /public_api/v1/get_triage_presets] · Response Action
Example request body:
{
"request_data": {}
}Inputs: request_data.
hash_exceptions_allowlistA
Allow List Files
Add files which do not exist in the allow or block lists to an allow list.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/hash_exceptions/allowlist] · Response Action
Example request body:
{
"request_data": {
"hash_list": [
"032196FB1A---DFCF69E5D553F0",
"365296EB1B---FCF29E5D553E4",
"365296EB1B---FCF69E3D553E4",
"365296EB1B---FCF69E5D553D4",
"365296EB1B---FCF79E5D553D4"
],
"comment": "test",
"incident_id": 5
}
}Inputs: request_data (required).
hash_exceptions_blocklistB
Block List Files
Add files which do not exist in the allow or block lists to a block list. You can view the block list in the UI at Incident Response > Action Center > Block List.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/hash_exceptions/blocklist] · Response Action
Example request body:
{
"request_data": {
"hash_list": [
"032196FB1A---DFCF69E5D553F0",
"365296EB1B---FCF69E7D553E4",
"365296EB1B---FCF69E5D523E4",
"365296EB1B---FCF69E5D553D4",
"365296EB1B---FCF63E5D553D4"
],
"comment": "test",
"incident_id": 5
}
}Inputs: request_data (required).
healthcheckB
System Health Check
Perform a health check of your Cortex XSIAM environment.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[GET /public_api/v1/healthcheck] · System management
Inputs: no named parameters.
incidents_get_incident_extra_dataA
Get Extra Incident Data
Get extra data fields of a specific incident including alerts and key artifacts.
Cortex XDR displays in the APIs response whether a PAN NGFW type alert contains a PCAP triggering packet. Use the Retrieve PCAP Packet API to retrieve a list of alert IDs and their associated PCAP data.
Note: The API includes a limit rate of 10 API requests per minute.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/incidents/get_incident_extra_data] · Incidents
Example request body:
{
"request_data": {
"incident_id": "<incident ID>",
"alerts_limit": 5
}
}Inputs: request_data (required).
incidents_get_incidentsA
Get Incidents
Get a list of incidents filtered by a list of incident IDs, modification time, or creation time. This includes all incident types and severities, including correlation-generated incidents.
The response is concatenated using AND condition (OR is not supported).
The maximum result set size is >100.
Offset is the zero-based number of incidents from the start of the result set.
Note: You can send a request to retrieve either all or filtered results.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/incidents/get_incidents] · Incidents
Example request body:
{
"request_data": {
"filters": [
{
"field": "incident_id_list",
"operator": "in",
"value": [
"<incident ID>",
"<incident ID>"
]
}
],
"search_from": 0,
"search_to": 100,
"sort": {
"field": "creation_time",
"keyword": "desc"
}
}
}Inputs: request_data.
incidents_update_incidentA
Update an Incident
Update one or more fields of a specific incident. Missing fields are ignored. Note:
assigned_user_mailfield is validated by Cortex XSIAM to confirm the provided assignee email address belongs to a user that exists in the same Cortex XSIAM tenant.To unassign an incident pass
noneor"assigned_user_mail": "".To remove a manually set severity pass
noneor"manual_severity": "".
[POST /public_api/v1/incidents/update_incident] · Incidents
Inputs: request_data.
indicators_deleteB
Delete Indicators (IOCs)
Delete IOCs selected by filter.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/indicators/delete] · IOCs
Example request body:
{
"request_data": {
"extended_view": false,
"filters": [
{
"field": "rule_id",
"operator": "EQ",
"value": 57
}
]
}
}Inputs: request_data (required).
indicators_getA
Get Indicators (IOCs)
Get a list of IOCs. You can return all IOCs or filter results. You can also return extended results with all details included.
The response is concatenated using AND condition (OR is not supported).
The maximum result set size is >100.
Offset is the zero-based number of incidents from the start of the result set.
UI navigation: XSIAM > Detection & Threat Intel > Detection Rules > IOC.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/indicators/get] · IOCs
Example request body:
{
"request_data": {
"extended_view": false,
"filters": [
{
"field": "rule_id",
"operator": "IN",
"value": [
57
]
}
]
}
}Inputs: request_data (required).
indicators_insertA
Insert or update IOCs
Insert new IOCs or update existing IOCs.
Note: The IOC rule_id is tenant specific and can't be used across tenants. Inserting IOCs with the same rule_id as an existing IOC on that tenant will overwrite the existing IOC.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/indicators/insert] · IOCs
Example request body:
{
"request_data": [
{
"indicator": "virus1.exe",
"type": "FILENAME",
"severity": "SEV_040_HIGH",
"expiration_date": 1234567891234,
"default_expiration_enabled": false,
"comment": "teststeststsetestste"
},
{
"indicator": "test.exe",
"type": "FILENAME",
"severity": "SEV_030_MEDIUM",
"expiration_date": 1234567891234,
"default_expiration_enabled": true
}
]
}Inputs: request_data (required).
indicators_insert_csvA
Insert Simple Indicators, CSV
Upload IOCs in CSV format that you retrieved from external threat intelligence sources.
Note: Cortex XDR does not scan historic data, but rather only new incoming data.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/indicators/insert_csv] · Rules
Example request body:
{
"request_data": "indicator,type,severity,expiration_date, comment,reputation,reliability,class,vendor.name,vendor.reputation, vendor.reliability\n B2c74bf609159f27dd89a829501ec34d6596d8b39a2cce7add73a8207088817a, HASH,HIGH,1587054895000,This is an example IOC,BAD,D,Malware,IBM, GOOD,B\n A2c74bf609159f27dd89a829501ec34d6596d8b39a2cce7add73a8207088817a, HASH,LOW,1587054895000,This is an example IOC,GOOD,D,Malware,PANW, BAD,A\n"
}Inputs: request_data (required), validate.
indicators_insert_jsonsA
Insert Simple Indicators, JSON
Upload IOCs as JSON objects that you retrieved from external threat intelligence sources.
Note: Cortex XSIAM does not scan historic data, rather only new incoming data.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/indicators/insert_jsons] · Rules
Example request body:
{
"request_data": [
{
"indicator": "<hash_value>",
"type": "HASH",
"comment": "test",
"reputation": "GOOD",
"reliability": "D",
"vendors": [
{
"vendor_name": "V1",
"reliability": "A",
"reputation": "GOOD"
},
{
"vendor_name": "V2",
"reliability": "A",
"reputation": "SUSPICIOUS"
}
],
"class": "Malware"
}
],
"validate": true
}Inputs: request_data (required), validate.
integrations_syslog_createA
Create a syslog integration
Create a new syslog integration.
You must have View/Edit Alert Notification permissions to run this endpoint.
[POST /public_api/v1/integrations/syslog/create] · Syslog servers
Example request body:
{
"request_data": {
"name": "Test PAPI",
"address": "34.24.11.16",
"port": "1234",
"protocol": "TLS",
"facility": "FAC_USER",
"security_info": {
"certificate_name": "wf-verdict-service.key.pem",
"ignore_cert_errors": false,
"certificate_content": "<binary string of the cert>"
}
}
}Inputs: request_data (required).
integrations_syslog_deleteA
Delete all or filtered syslog integrations
Delete all the syslog integrations or the ones who match the filter criteria.
You must have View/Edit Alert Notification permissions to run this endpoint.
[POST /public_api/v1/integrations/syslog/delete] · Syslog servers
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "EQ",
"value": "Test PAP"
}
]
}
}Inputs: request_data (required).
integrations_syslog_getA
Get all or filtered syslog servers
Get a complete or filtered list of syslog servers.
You must have View Alert Notification permissions to run this endpoint.
[POST /public_api/v1/integrations/syslog/get] · Syslog servers
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"operator": "EQ",
"value": "Test PAP"
}
]
}
}Inputs: request_data (required).
integrations_syslog_testA
Test syslog integration
Tests a syslog integration's validity.
You must have View Alert Notification permissions to run this endpoint.
[POST /public_api/v1/integrations/syslog/test] · Syslog servers
Example request body:
{
"request_data": {
"syslog_id": "123456789",
"name": "Test PAPI",
"address": "34.24.11.16",
"port": "1234",
"protocol": "TLS",
"facility": "FAC_USER",
"security_info": {
"certificate_name": "wf-verdict-service.key.pem",
"ignore_cert_errors": false,
"certificate_content": "<binary string of the cert>"
}
}
}Inputs: request_data (required).
integrations_syslog_updateB
Update a syslog integration
Update the details of the specified syslog integration.
You must have View/Edit Alert Notification permissions to run this endpoint.
[POST /public_api/v1/integrations/syslog/update] · Syslog servers
Example request body:
{
"request_data": {
"syslog_id": "123456789",
"name": "Test PAPI",
"address": "35.27.11.16",
"port": "1234",
"protocol": "TLS",
"facility": "FAC_USER",
"security_info": {
"certificate_name": "wf-verdict-service.key.pem",
"ignore_cert_errors": false,
"certificate_content": "<binary string of the cert>"
}
}
}Inputs: request_data (required).
playbooks_deleteA
Delete a playbook
Delete a playbook by filtering based on its name or ID.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/playbooks/delete] · Playbooks
Example request body:
{
"request_data": {
"filters": {
"field": "name",
"value": "Phishingplaybook"
}
}
}Inputs: request_data (required).
playbooks_getA
Get a playbook
Get a playbook by filtering based on its name or ID. The playbook's YAML is returned in a ZIP file.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/playbooks/get] · Playbooks
Example request body:
{
"request_data": {
"filters": {
"field": "name",
"value": "Phishingplaybook"
}
}
}Inputs: request_data (required).
playbooks_insertA
Insert or update playbooks
Add or update a playbook by passing the YAML in a ZIP file.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/playbooks/insert] · Playbooks
Inputs: no named parameters.
quarantine_statusA
Get Quarantine Status
Retrieve the quarantine status for specified files.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/quarantine/status] · Response Action
Example request body:
{
"request_data": {
"files": [
{
"endpoint_id": "<endpoint ID>",
"file_path": "C:\\<file path>\\test_x64.msi",
"file_hash": "<hash value>"
}
]
}
}Inputs: request_data (required).
rbac_get_rolesA
Get Roles
Retrieve information about one or more roles created in your environment.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/rbac/get_roles] · System management
Example request body:
{
"request_data": {
"role_names": [
"Role1",
"Role2"
]
}
}Inputs: request_data.
rbac_get_user_groupA
Get User Groups
Retrieve a list of the current user emails associated with one or more user groups in your environment.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/rbac/get_user_group] · System management
Example request body:
{
"request_data": {
"group_names": [
"Group1",
"Group2"
]
}
}Inputs: request_data (required).
rbac_get_usersA
Get Users
Retrieve a list of the current users in your environment.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/rbac/get_users] · System management
Inputs: no named parameters.
rbac_set_user_roleA
Set a User Role
Add or remove one or more users from a role.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/rbac/set_user_role] · System management
Example request body:
{
"request_data": {
"user_emails": [
"user1@acme.com",
"user2@acme.com"
],
"role_name": "Role1"
}
}Inputs: request_data.
scheduled_queries_deleteA
Delete a scheduled query
Delete scheduled queries.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scheduled_queries/delete] · Scheduled Queries
Example request body:
{
"request_data": [
"qc_1683461522_18780",
"qc_1677754986_6539",
"avram"
]
}Inputs: request_data (required).
scheduled_queries_insertA
Insert or update scheduled queries
Insert new scheduled queries or update existing scheduled queries.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scheduled_queries/insert] · Scheduled Queries
Example request body:
{
"request_data": [
{
"query_definition_name": "test_debug_avram_api",
"xql": "dataset = xdr_data | limit 10",
"timeframe": {
"relativeTime": 46400000
},
"schedule": {
"trigger_type": "date",
"run_date": 4677621540000
}
}
]
}Inputs: request_data (required).
scheduled_queries_listA
Get scheduled queries
Return a list of scheduled queries. You can return all scheduled queries or filter results. You can also return extended results with all details included.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scheduled_queries/list] · Scheduled Queries
Example request body:
{
"request_data": {
"extended_view": "True",
"list_ids": [
"qc_1683029855_18777",
"qc_1678276807_6621"
],
"filters": [
{
"field": "query_def_id",
"operator": "EQ",
"value": "qc_1683029855_18777"
}
]
}
}Inputs: request_data (required).
scripts_deleteB
Delete a script
Delete a script by filtering based on its name or ID.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scripts/delete] · Scripts
Example request body:
{
"request_data": {
"filters": {
"field": "name",
"value": "PhishingScript"
}
}
}Inputs: request_data (required).
scripts_getA
Get a script
Get a script by filtering based on its name or ID. The script's YAML is returned in a ZIP file.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scripts/get] · Scripts
Example request body:
{
"request_data": {
"filters": {
"field": "name",
"value": "Phishingplaybook"
}
}
}Inputs: request_data (required).
scripts_get_script_codeA
Get Script Code
Get the code of a specific script in the script library.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_script_code] · Script execution
Example request body:
{
"request_data": {
"script_uid": "<unique ID>"
}
}Inputs: request_data (required).
scripts_get_script_execution_resultsC
Get Script Execution Results
Retrieve the results of a script execution action.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_script_execution_results] · Script execution
Example request body:
{
"request_data": {
"action_id": "<action ID>"
}
}Inputs: request_data (required).
scripts_get_script_execution_results_filesB
Get Script Execution Result Files
Get the files retrieved from a specific endpoint during a script execution.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_script_execution_results_files] · Script execution
Example request body:
{
"request_data": {
"action_id": "<action ID>",
"endpoint_id": "<endpoint ID>"
}
}Inputs: request_data (required).
scripts_get_script_execution_statusA
Get Script Execution Status
Retrieve the status of a script execution action.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_script_execution_status] · Script execution
Example request body:
{
"request_data": {
"action_id": "<action ID>"
}
}Inputs: request_data (required).
scripts_get_script_metadataB
Get Script Metadata
Get the full definitions of a specific script in the scripts library.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_script_metadata] · Script execution
Example request body:
{
"request_data": {
"script_uid": "<unique ID>"
}
}Inputs: request_data (required).
scripts_get_scriptsC
Get Scripts
Get a list of scripts available in the scripts library.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/get_scripts] · Script execution
Example request body:
{
"request_data": {
"filters": [
{
"field": "is_high_risk",
"operator": "in",
"value": [
"false"
]
}
]
}
}Inputs: request_data (required).
scripts_insertA
Insert or update a script
Update or add a script by passing the YAML in a ZIP file.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/scripts/insert] · Scripts
Inputs: no named parameters.
scripts_run_scriptA
Run Script
Initiate a new endpoint script execution action using a script from the script library. The script can be run on up to 1000 endpoints.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/run_script] · Script execution
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
}
],
"script_uid": "<unique ID>",
"parameters_values": {
"x": "param input as returned in Get Script Metadata",
"y": 4
}
}
}Inputs: request_data (required).
scripts_run_snippet_code_scriptB
Run Snippet Code Script
Initiate a new endpoint script execution action using provided snippet code. Cortex XDR supports sending your request in Base64.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/scripts/run_snippet_code_script] · Script execution
Example request body:
{
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<endpoint ID>"
]
}
],
"snippet_code": "print (\"7\")"
}
}Inputs: request_data (required).
system_get_tenant_infoB
Get Tenant Info
Get your tenant license information.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/system/get_tenant_info] · System management
Inputs: request_data.
tags_agents_assignC
Assign Tags
Assign one or more tags to one or more endpoints.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/tags/agents/assign] · Endpoint Management
Example request body:
{
"context": {
"lcaas_id": "<tenant_id>"
},
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<distribution_id"
]
}
],
"tag": "<tag_name>"
}
}Inputs: request_data.
tags_agents_removeA
Remove Tags
Remove one or more tags from one or more endpoints.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/tags/agents/remove] · Endpoint Management
Example request body:
{
"context": {
"lcaas_id": "<tenant_id>"
},
"request_data": {
"filters": [
{
"field": "endpoint_id_list",
"operator": "in",
"value": [
"<distribution_id"
]
}
],
"tag": "<tag_name>"
}
}Inputs: request_data.
triage_endpointA
Initiate Forensics Triage
Initiate forensics triage for the specified agents.
Maximum of 10 concurrent triage actions at a time.
Specified agents must have Forensics License enabled.
Specified agents must be the same OS, Windows or macOS, but not a mixture of both.
Specified configuration must have type "Online = True".
Required license: Cortex XSIAM Premium or
[POST /public_api/v1/triage_endpoint] · Endpoint Management
Inputs: request_data (required).
v1_alerts_get_alerts_multi_eventsA
Get Alerts Multi-Events v1
**Note: ** This endpoint is legacy. Use the Get Alerts Multi-Events v2 endpoint.
Get a list of alerts with multiple events.
Response is concatenated using AND condition (OR is not supported).
Maximum result set size is 100.
Offset is the zero-based number of alerts from the start of the result set. Cortex XDR displays in the APIs response whether an PAN NGFW type alert contains a PCAP triggering packet. Use the Retrieve PCAP Packet API to retrieve a list of alert IDs and their associated PCAP data.
Note: You can send a request to retrieve either all or filtered results.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/alerts/get_alerts_multi_events] · Incidents
Example request body:
{
"request_data": {
"filters": [
{
"field": "severity",
"operator": "in",
"value": [
"medium",
"high"
]
}
],
"search_from": 0,
"search_to": 5,
"sort": {
"field": "severity",
"keyword": "asc"
}
}
}Inputs: request_data.
v2_alerts_get_alerts_multi_eventsA
Get Alerts Multi-Events v2
Get a list of alerts with multiple events.
The response is concatenated using AND condition (OR is not supported).
The maximum result set size is 100.
Offset is the zero-based number of alerts from the start of the result set.
Cortex XDR displays in the API response whether a PAN NGFW type alert contains a PCAP triggering packet. Use the Retrieve PCAP Packet API to retrieve a list of alert IDs and their associated PCAP data.
Note: You can send a request to retrieve either all or filtered results.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v2/alerts/get_alerts_multi_events] · Incidents
Example request body:
{
"request_data": {
"filters": [
{
"field": "severity",
"operator": "in",
"value": [
"medium",
"high"
]
}
]
}
}Inputs: request_data (required).
widgets_deleteA
Delete widgets
Delete the widgets retrieved by the Get widgets API.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/widgets/delete] · Widgets
Example request body:
{
"request_data": {
"filters": [
{
"field": "title",
"value": "Widget A",
"operator": "EQ"
},
{
"field": "created_by",
"value": "John Doe",
"operator": "EQ"
}
]
}
}Inputs: request_data (required).
widgets_getA
Get widgets
Get widget details by filtering based on the widget title and widget creator.
Note: The endpoint only returns XQL widgets and not predefined widgets.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/widgets/get] · Widgets
Example request body:
{
"request_data": {
"filters": [
{
"field": "name",
"value": "This is a cool widget",
"operator": "EQ"
},
{
"field": "created_by",
"value": "John Doe",
"operator": "EQ"
}
]
}
}Inputs: request_data (required).
widgets_insertA
Insert or update widgets
Update or add the widgets retrieved by the Get widgets API.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/v1/widgets/insert] · Widgets
Example request body:
{
"request_data": [
{
"widgets_data": [
{
"widget_key": "xql_1646052681403",
"title": "Widget A",
"creation_time": 1653303166334,
"description": null,
"data": {
"phrase": "cold_dataset = endpoints",
"time_frame": {
"relativeTime": 86400000
},
"viewOptions": {
"type": "table",
"commands": []
}
},
"support_time_range": true,
"additional_info": {
"query_tables": [
"endpoints"
],
"query_uses_library": false
},
"creator_mail": "user@company.com"
}
]
},
{
"widgets_data": [
{
"widget_key": "xql_1346826725701",
"title": "Widget B",
"creation_time": 1653302483610,
"description": null,
"data": {
"phrase": "dataset = endpoints ",
"time_frame": {
"relativeTime": 86400000
},
"viewOptions": {
"type": "table",
"commands": []
},
"gridRawStorageInfo": {
"sort": null,
"coldefs": {},
"rowHeight": "{\"rowHeight\":\"regular\",\"gridRowsHeight\":\"medium-row\"}",
"columnWidth": null
}
},
"support_time_range": true,
"additional_info": {
"query_tables": [
"endpoints"
],
"query_uses_library": false
},
"creator_mail": "user@company.com"
}
]
}
]
}Inputs: request_data.
xql_add_datasetB
Add Dataset
Add a dataset of type lookup with the specified name and schema.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/add_dataset] · Dataset Management
Inputs: request_data.
xql_delete_datasetA
Delete a dataset
Delete a dataset with the specified name. The following dataset types can be deleted: Lookup, Raw, User, Snapshot, and Correlation. You can only delete a dataset with dependencies by setting force to TRUE.
Note: The System dataset and other protected datasets cannot be deleted.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v2/xql/delete_dataset] · Dataset Management
Example request body:
{
"dataset_name": "users",
"force": "yes"
}Inputs: request_data.
xql_get_datasetsC
Get all datasets
Retrieve a list of all the datasets and their properties.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/get_datasets] · Dataset Management
Inputs: request_data.
xql_get_query_resultsA
Get XQL query results
Retrieve results of an executed XQL query API.
Note: This endpoint only works on XQL queries initiated by /public_api/v1/xql/start_xql_query/.
Maximum result set size is 1000. The API does not support pagination, therefore, you can set values to determine the result size limitation and how to wait for the results. To view response with greater than 1000 results you must call Get XQL query results Stream.
For more information on how to run XQL queries, see Running XQL query APIs.
Note
To ensure you don't surpass your quota, Cortex XSIAM allows you to run up to four API queries in parallel.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/get_query_results] · XQL query
Example request body:
{
"request_data": {
"query_id": "061880b4867446_4356_inv",
"pending_flag": true,
"limit": 100,
"format": "json"
}
}Inputs: request_data (required).
xql_get_query_results_streamA
Get XQL query results Stream
Retrieve XQL query results with more than 1000 results.
Note: This endpoint only works on XQL queries initiated by /public_api/v1/xql/start_xql_query/.
Response is returned as chunked (Transfer-Encoding: chunked). To retrieve a compressed gzipped response (Content-Encoding: gzip), in your header add Accept-Encoding: gzip.
For more information on how to run XQL queries, see Running XQL query APIs.
Note
To ensure you don't surpass your quota, Cortex XSIAM allows you to run up to four API queries in parallel.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/get_query_results_stream] · XQL query
Example request body:
{
"request_data": {
"stream_id": "563c5e24-===-9a1f8139d3c5",
"is_gzip_compressed": true
}
}Inputs: request_data (required).
xql_get_quotaA
Get XQL query Quota
Retrieve the amount of query quota available and used.
Note: This endpoint only works on XQL queries initiated by /public_api/v1/xql/start_xql_query/.
For more information on how to run XQL queries, see Running XQL query APIs.
Note
To ensure you don't surpass your quota, Cortex XSIAM allows you to run up to four API queries in parallel.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/get_quota] · XQL query
Example request body:
{
"request_data": {}
}Inputs: no named parameters.
xql_library_deleteA
Delete XQL Queries
Delete XQL queries. You can filter by list of query names or by list of query tags.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/xql_library/delete] · Query Library
Example request body:
{
"request_data": {
"xql_query_names": [
"test_ql11",
"test_ql2",
"test_ql33"
],
"xql_query_tags": [
"tag1",
"tag2",
"tag3"
]
}
}Inputs: request_data (required).
xql_library_getB
Get XQL Queries
Retrieve a detailed list of XQL query libraries. You can filter by list of query names or by list of query tags.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/xql_library/get] · Query Library
Example request body:
{
"request_data": {
"xql_query_names": [
"test_ql11",
"test_ql2",
"test_ql33"
],
"xql_query_tags": [
"tag1",
"tag2",
"tag3"
]
}
}Inputs: request_data (required).
xql_library_insertA
Insert or update XQL queries
Insert new XQL queries or update existing XQL queries.
Note: You should use unique xql_query_name for each XQL query on a given tenant.
You must have Instance Administrator permissions to run this endpoint.
[POST /public_api/xql_library/insert] · Query Library
Example request body:
{
"request_data": {
"xql_queries_override": true,
"xql_queries": [
{
"xql_query": "dataset = xdr_data |limit 1",
"xql_query_name": "test_ql1"
},
{
"xql_query": "dataset = xdr_data |limit 2",
"xql_query_name": "test_ql11"
},
{
"xql_query": "dataset = xdr_data |limit 2",
"xql_query_name": "test_ql11"
}
],
"xql_query_tags": [
"tag1",
"tag101"
]
}
}Inputs: request_data (required).
xql_lookups_add_dataA
Add or update data in a lookup dataset
Add or update data in a lookup dataset.
When updating data, any field not specified in the data field, but specified on at least one of the rows, will be set to None.
The /public_api/xql/lookups/add_data/ endpoint does not support concurrent edits. Sending concurrent calls to this endpoint can cause data to be unintentionally overwritten or deleted. To allow sufficient time for each API call to complete its operation before initiating another one, assume that 1000 entries can be added per API every 10 seconds.
**Note: **
The maximum size of a lookup dataset is 50 MB. Attemping to exceed this limit will fail.
Requests time out after three minutes.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/lookups/add_data] · Lookup Datasets
Inputs: request_data.
xql_lookups_get_dataA
Get data from a lookup dataset
Get data from a lookup dataset according to the specified filter fields. All lookup entries matching any of the filter blocks are returned. To match a filter block, a lookup entry must match all the specified fields as if there were an AND operator between them. If no filters are specified, return all lookup entries.
Note:
The maximum number of entries returned is 10,000.
Requests time out after three minutes.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/lookups/get_data] · Lookup Datasets
Inputs: request_data.
xql_lookups_remove_dataA
Remove data from a lookup dataset
Remove data from a dataset based on the specified parameters. If any one of the filter sets are not found, the API does not delete any data.
The /public_api/xql/lookups/remove_data/ endpoint does not support concurrent edits. Sending concurrent calls to this endpoint can cause data to be unintentionally overwritten or deleted. To allow sufficient time for each API call to complete its operation before initiating another one, assume that 1000 entries can be added per API every 10 seconds.
Note:
All lookup entries matching any of the filter blocks are deleted. To match a filter block, a lookup entry must match all the specified fields as if there were an
ANDoperator between them.Requests time out after three minutes.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/lookups/remove_data] · Lookup Datasets
Inputs: request_data.
xql_queryA
Run an XQL query end-to-end in a single call: starts the query, polls until results are ready, and returns them. This wraps xql/start_xql_query + xql/get_query_results so you don't have to poll manually. Prefer this for ad-hoc data investigation.
Example: {"query": "dataset = xdr_data | fields event_id, event_type | limit 10", "time_frame": {"relativeTime": 86400000}}
Inputs: query (required), tenant_ids, time_frame, max_wait_seconds.
xql_start_xql_queryB
Start an XQL query
Execute an XQL query.
For more information on how to run XQL queries, see Running XQL query APIs.
Note
To ensure you don't surpass your quota, Cortex XSIAM allows you to run up to four API queries in parallel.
Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus
[POST /public_api/v1/xql/start_xql_query] · XQL query
Example request body:
{
"request_data": {
"query": "dataset=xdr_data | fields event_id, event_type, event_sub_type | limit 3",
"tenants": [],
"timeframe": {
"from": 1598907600000,
"to": 1599080399000
}
}
}Inputs: request_data (required).
xsiam_healthA
Check connectivity and credentials against the XSIAM tenant. Calls the tenant-info endpoint and reports whether auth works. Run this first to confirm the server is configured correctly.
Inputs: no named parameters.
xsiam_list_operationsA
Discovery tool. Returns the catalog of all available XSIAM operations grouped by category (OpenAPI tag), with each tool's name and summary. Use this to find the right tool before calling it. Optionally filter by a tag substring.
Inputs: tag.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 132 tools
Most tools are clearly differentiated by resource and action, but a few close pairs (healthcheck vs xsiam_health, dataset_* vs xql_* dataset tools, v1/v2 alert variants) could cause misselection.
The naming is mostly snake_case with a domain prefix, but the ordering of action and resource varies (e.g., incidents_update_incident vs tags_agents_assign), and some tools have version prefixes or standalone names (healthcheck, get_risk_score), creating inconsistency.
With 132 tools, the server is far beyond the recommended range and poses a significant navigation burden for agents, even with a discovery tool.
The tool set comprehensively covers the major XSIAM domains including incidents, alerts, endpoints, assets, XQL, scripts, and configuration, with only minor lifecycle gaps (e.g., no incident creation) that are reasonable given the platform.
Maintenance
Related MCP Connectors
Enrich, search, assess, and manage threat intelligence through 80+ typed MCP tools.
Your org's AI agents, tasks, runs, search, and brain files as MCP tools and resources.
Remote MCP for 1,500+ APIs. Vault-managed credentials; OAuth or API key. Search, load, and execute.
Single-connection MCP gateway discovering and executing 490+ verified MCP & A2A tools.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI agents to interact with Splunk SIEM and TheHive SOAR through a unified MCP interface, providing 12 tools for alert triage, case management, and security operations.MIT
- FlicenseNot gradedqualityBmaintenanceEnables governed agent access to Cortex XSIAM security operations APIs, including XQL log search, issues, cases, endpoints, and assets, with dataset authorization and optional identity-based access control.-
- FlicenseNot gradedqualityDmaintenanceEnables Claude or any MCP-compatible client to execute cybersecurity workflows like incident response, cloud audits, and pentests by calling tools with 323 prompts across 8 categories.1-
- FlicenseAqualityBmaintenanceExposes eSentire Atlas API (Findings, Ticketing, MVS) and Threat Intelligence feeds (IP Watch, Advanced/STIX) as MCP tools, enabling security operations and threat intelligence queries through natural language.29-