How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Palo Alto Networks Incidents API

Incident management and investigation.

Palo Alto Networks Incidents API is one of 820 APIs that Palo Alto Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Incidents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 17 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api-{fqdn}/public_api/v1, https://{xsoar-server}, https://api.dlp.paloaltonetworks.com/v4, https://api.{region}.dlp.paloaltonetworks.com/v1, https://api.stratacloud.paloaltonetworks.com/aiops/bpa/v1, https://api.aperture.paloaltonetworks.com.

20 operations 17 paths 29 schemas 9 GET8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{firewall}/api/
Authentication
API Key, API Key, API Key, API Key, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Palo Alto Networks Incidents API declares 6 security schemes for authenticating requests. An API key is passed in the header as x-xdr-hmac-v2 (xdrAuth). An API key is passed in the header as x-xdr-hmac-v2 (xpanseAuth). An API key is passed in the header as x-xdr-hmac-v2 (xsiamAuth). An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP bearer tokens (JWT) (oauth2Bearer).

  • xdrAuth — Cortex XDR uses a custom HMAC-SHA256 authentication scheme. Each request requires four headers: x-xdr-auth-id (API key ID), x-xdr-nonce (64-character random st…
  • xpanseAuth — Cortex Xpanse uses a custom HMAC-SHA256 authentication scheme with RBAC API key pairs. Include four headers: x-xdr-auth-id (API key ID), x-xdr-nonce (64-charac…
  • xsiamAuth — Cortex XSIAM uses a custom HMAC-SHA256 authentication scheme. Include four headers on each request: x-xdr-auth-id (API key ID number), x-xdr-nonce (64-characte…
  • apiKey — Cortex XSOAR API key. Generate from Settings Integrations API Keys in the XSOAR console. Pass the key directly as the Authorization header value (no Bearer pre…
  • bearerAuth — OAuth 2.0 bearer token obtained from the Palo Alto Networks SASE authentication service using the client credentials flow.
  • oauth2Bearer — OAuth 2.0 Bearer token for SASE platform authentication. Obtain using the clientcredentials grant with your SASE service account client ID and client secret.

Paths & Operations 20

Across 17 paths, the API surfaces 20 operations — 9 GET, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Incidents 20

Incident management and investigation.

POST
/incidents/get_incidents
Palo Alto Networks List Incidents
getIncidents body → 200400401403500
POST
/incidents/get_incident_extra_data
Palo Alto Networks Get Incident Details
getIncidentExtraData body → 200400401404
POST
/incidents/update_incident
Palo Alto Networks Update Incident
updateIncident body → 200400401404
POST
/incident_management/get_incidents
Palo Alto Networks Get Attack Surface Incidents
getIncidents body → 200400401403
POST
/incident_management/update_incident
Palo Alto Networks Update Attack Surface Incident
updateIncident body → 200400401404
POST
/incident
Palo Alto Networks Create Incident
createIncident body → 200400401500
GET
/incidents/search
Palo Alto Networks Search Incidents (GET)
searchIncidentsGet 5 params → 200400401
POST
/incidents/search
Palo Alto Networks Search Incidents (POST)
searchIncidentsPost body → 200400401
GET
/incident/{id}
Palo Alto Networks Get Incident
getIncident 1 param → 200401404
POST
/incident/update
Palo Alto Networks Update Incident
updateIncident body → 200400401404
GET
/incidents
Palo Alto Networks List DLP Incidents
listIncidents 6 params → 200400401403500
GET
/incidents/{incident_id}
Palo Alto Networks Get DLP Incident by ID
getIncident 1 param → 200401403404500
PUT
/incidents/{incident_id}
Palo Alto Networks Update DLP Incident
updateIncident 1 param body → 200400401403404500
GET
/incidents/{incident_id}/snippets
Palo Alto Networks Get Incident Content Snippets
getIncidentSnippets 1 param → 200401403404500
GET
/email-incidents
Palo Alto Networks List Email Incidents
listEmailIncidents 5 params → 200400401403500
GET
/email-incidents/{id}
Palo Alto Networks Get Email Incident Details
getEmailIncident 1 param → 200401403404500
PUT
/email-incidents/{id}/verdict
Palo Alto Networks Update Email Incident Verdict
updateEmailIncidentVerdict 1 param body → 200400401403404500
GET
/api/incidents
Palo Alto Networks List Incidents
listIncidents 7 params → 200400401403500
GET
/api/incidents/{id}
Palo Alto Networks Get Incident Details
getIncident 1 param → 200401403404500
PUT
/api/incidents/{id}
Palo Alto Networks Update Incident
updateIncident 1 param body → 200400401403404500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Incident (21 properties), Incident_3 (20 properties), DLPIncident (18 properties), Alert (17 properties). Each schema is shown below with its type and property counts.

IncidentDetail
Alert
object
A Cortex XDR alert representing a single detection event.
17 properties
ErrorResponse
object
1 property
Incident
object
A Cortex XDR incident grouping related alerts.
21 properties
Filter
object
A filter criterion for querying XDR resources.
3 properties 3 required
SortOrder
object
Sorting specification for result sets.
2 properties
ErrorResponse_2
object
1 property
Filter_2
object
A filter criterion for querying Xpanse resources.
3 properties 3 required
AsmIncident
object
An attack surface incident representing a confirmed exposure requiring remediation.
14 properties
SortOrder_2
object
Sorting specification for result sets.
2 properties
ErrorResponse_3
object
1 property
Incident_2
object
A XSIAM incident correlating related alerts into a unified investigation.
15 properties
Filter_3
object
A filter criterion for querying XSIAM resources.
3 properties 3 required
SortOrder_3
object
Sorting specification for result sets.
2 properties
CreateIncidentRequest
object
10 properties 1 required
UpdateIncidentRequest
object
9 properties 1 required
IncidentSearchResponse
object
3 properties
ErrorResponse_4
object
5 properties
IncidentSearchRequest
object
5 properties
Incident_3
object
A Cortex XSOAR incident representing a security event under investigation.
20 properties
ContentSnippet
object
5 properties
ErrorResponse_5
object
2 properties
DLPIncident
object
18 properties
EmailDLPIncident
object
15 properties
ErrorResponse_6
object
2 properties
Incident_4
object
13 properties
ErrorResponse_7
object
3 properties
Incident_5
object
13 properties
ErrorResponse_8
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-incidents-api-openapi.yml Raw ↑

Other APIs Palo Alto Networks publishes across the network.

PAN-OS XML API
PAN-OS OpenConfig API
Panorama API
AutoFocus API (Deprecated)
Prisma SASE Service Status API
Cross-Platform Service Status API
SASE Authentication Service API
Expedition API (Deprecated)
VM-Series Licensing API
Palo Alto Networks 5G Deregistered Trend API
Palo Alto Networks 5G Network Interconnects and Bandwidth API
Palo Alto Networks 5G Registered Trend API
Where this information came from

This is an independent, third-party profile of Palo Alto Networks Incidents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.