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 Alerts API

Prisma Cloud generates an alert when it detects a violation in a policy that is included in an active alert rule. You can use the API requests to manage alerts, including listing or viewing, snoozing or dismissing, reopening, or remediating alerts.When retrieving a list of alerts through an API request, you can set filters, time range parameters, or pagination parameters.### PaginationYou can limit the number of items in a response list from API resources that support pagination. Version 2 (V2) of the API requests to list alerts supports pagination and will accept the following request parameters.Request Parameter | Description -----------| -------**limit** | Maximum number of items to return per page. Without pagination, maximum number of items to return in a response.**offset** | Number of items to skip before selecting items to return. Default is zero.**pageToken** | Set to the **nextPageToken** value from the previous response object to return the next page of data.### FiltersAPI requests that use POST methods to request a list of alerts have filter parameters that enable you to narrow your request to alerts that meet a certain criteria.The [List Alert Filters](/prisma-cloud/api/cspm/get-alert-filter-options) requests return the available filters.

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

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

This API exposes 32 operations across 27 paths, and defines 108 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 17 base URLs: https://api.prismacloud.io, https://api2.prismacloud.io, https://api3.prismacloud.io, https://api4.prismacloud.io, https://api.anz.prismacloud.io, https://api.eu.prismacloud.io, https://api2.eu.prismacloud.io, https://api.gov.prismacloud.io, https://api.prismacloud.cn, https://api.ca.prismacloud.io, https://api.sg.prismacloud.io, https://api.uk.prismacloud.io, https://api.ind.prismacloud.io, https://api.jp.prismacloud.io, https://api.fr.prismacloud.io, https://api.dig.security, PATH_TO_CONSOLE.

32 operations 27 paths 108 schemas 16 GET2 PATCH13 POST1 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
Resource Areas
1

Authentication & Security 1

Palo Alto Networks Alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-redlock-auth (x-redlock-auth).

  • x-redlock-auth — The x-redlock-auth value is a JSON Web Token (JWT).

Paths & Operations 32

Across 27 paths, the API surfaces 32 operations — 16 GET, 2 PATCH, 13 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Alerts 32

Prisma Cloud generates an alert when it detects a violation in a policy that is included in an active alert rule. You can use the API requests to manage alerts, including listing…

GET
/filter/alert/suggest
List Alert Filters
get-alert-filter-and-options → 200
POST
/filter/alert/suggest
List Alert Filter Autocomplete Suggestions
get-alert-filter-options body → 200
GET
/alert
List Alerts - GET
get-alerts 27 params → 200400429
POST
/alert
List Alerts - POST
post-alerts 1 param body → 200400429
GET
/v2/alert
List Alerts V2 - GET
get-alerts-v2 29 params → 200400429
POST
/v2/alert
List Alerts V2 - POST
post-alerts-v2 1 param body → 200400429
GET
/alert/policy
List Alert Counts By Policy - GET
get-alerts-grouped 21 params → 200400429
POST
/alert/policy
List Alert Counts By Policy - POST
post-alerts-grouped 1 param body → 200400429
GET
/alert/{id}
Alert Info
get-alert 2 params → 200400404429
POST
/alert/dismiss
Dismiss Alerts
dismiss-alerts body → 200400403404
GET
/alert/dismiss/require_dismissal_note
Is Dismissal Note Required
is-dismissal-note-required → 200403
PUT
/alert/dismiss/require_dismissal_note
Update Dismissal Note Requirement
set-dismissal-note-required body → 200400403
POST
/alert/reopen
Reopen Alerts
reopen-alerts body → 200400403
GET
/alert/count/{status}
Get Alerts Count By Status
get-alert-count 1 param → 200400429
POST
/alert/jobs
Submit Job to List Alerts
submit-job-for-listing-alerts body → 200400429
GET
/alert/jobs/{id}/status
Get Alerts List Job Status
get-alerts-job-status 1 param → 200404
GET
/alert/jobs/{id}/download
Download Alerts List JSON
download-alerts-list-json 1 param → 200400
POST
/alert/csv
Submit Alert CSV Generation Job
submit-an-alert-csv-download-job 1 param body → 200400
GET
/alert/csv/{id}/status
Get Alert CSV Job Status
get-alert-csv-job-status 1 param → 200404
GET
/alert/csv/{id}/download
Download Alert CSV
download-alert-csv 1 param → 200400404
POST
/alert/policy/jobs
Submit Job to List Alerts By Policy
submit-a-job-for-listing-alerts-grouped-by-policy body → 200400429
GET
/alert/policy/jobs/{id}/status
Get Policy Alert Job Status
get-async-policy-alert-job-status 1 param → 200
GET
/alert/policy/jobs/{id}/download
Download Policy Alerts JSON
download-policy-alerts-json 1 param → 200
POST
/alert/remediation
List Alert Remediation Commands
get-alerts-remediation body → 200400405
PATCH
/alert/remediation/{id}
Remediate Alert
perform-remediation-for-alert 2 params → 200400405
POST
/alert/v1/policy
Return policy with alert count
alertPolicyList body → 4002004XX
POST
/alert/v1/aggregate
Group by Policy field
alertAggregation body → 4002004XX
GET
/alert/v1/{id}/graph
Alert Evidence Graph
getAlertEvidenceGraph 1 param → 400200401403412429
POST
/alerts/api/v1/notification/ondemand
Create On Demand Notification
create-Ondemand-Notification body → 201400401403404429
GET
/policy/api/v1/fetch/remediation/{policyId}
Get Policy Remediation
getRemediationForPolicy 3 params → 200400401403429
PATCH
/v1/alerts/id/{id}/status/{status}
Update Alert Status
patch-alerts-id-id-status-status 3 params → 200
GET
/v1/alerts
List DDR Alerts
get-alerts 31 params → 200

Schemas 108

The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are AlertFilterSuggestion (36 properties), PolicyRiskScoreModel (27 properties), AlertModel (27 properties), PolicyRiskScoreModel_2 (27 properties). Each schema is shown below with its type and property counts.

RemediationAction
object
Action for remediation for data policy.
2 properties
RuleModel
object
Model for Rule
10 properties 4 required
FilterSuggestionModel
object
Model for Filter Suggestions
2 properties 1 required
AttributionEventModel
object
Model for AttributionEvent
3 properties
RemediationCliModel
object
Model for Remediation Command
4 properties
TargetTagModel
object
Model for Target Tag
2 properties
AlertRuleNotificationConfigModel
object
Model for Alert Rule Notification Config
17 properties
RelativeTimeRangeConfigModel
HistoryModel
object
Model for History
2 properties
ToNowTimeRangeConfigModel
TimeRangeConfigModel
object
See the [Time Range Model](/prisma-cloud/api/cspm/api-time-range-model) for details.
1 property 1 required
RelativeTimeDurationModel
object
Model for RelativeTimeDuration
2 properties
AbsoluteTimeRangeConfigModel
RequireDismissalNoteConfigModel
object
Model for Require Dismissal Note Config
1 property
FilterSuggestion
object
Model for FilterSuggestion
3 properties
ComplianceMetadataModel
object
Model for ComplianceMetadata
12 properties
FilterModel
AsyncJob
object
Model for AsyncJob
9 properties
PolicyModel
object
Model for Policy
25 properties 4 required
CountModel
object
Model used for just count
1 property
TargetFilterModel
object
Model for Target Filter
6 properties
AlertFilterSuggestion
object
Model for AlertFilterSuggestion
36 properties
UIFilterModel
object
Model for UIFilter
3 properties
ScoreModel
object
Model for Score
2 properties
JsonNode
object
21 properties
RuleCriteria
object
Criteria for Rule
3 properties
AlertsLookupKeyModel
object
Model for AlertsLookupKey
3 properties 1 required
AlertStatusChangeRequestModel
object
Model for Alert Status Change Request
5 properties 1 required
PolicyRiskScoreModel
object
Model for Policy Risk Score
27 properties 4 required
WeekDay
object
2 properties
RemediationModel
object
Model for Remediation
3 properties
ResourceListIdsCollection
object
Model for holding the lists resource list ids by resource list type
1 property
AlertModel
object
Model for Alert
27 properties
ParsedTableFilter
object
Model for parsed table filter
8 properties
RiskDetailModel
object
Model for Risk Detail
4 properties
BaseFilterModel
object
Model for Filter
9 properties
ConnectionDetail
object
17 properties
PagedResultsAlertModel
object
6 properties
CloudResourceModel
object
Model for Cloud Resource
21 properties
AlertAttributionModel
object
Model for AlertAttribution
3 properties
InvestigateOptions
object
Model for InvestigateOptions
3 properties
AlertRulePolicyFilter
object
Model for Alert Rule Policy Filter
5 properties
PolicyScanConfigModel
object
Model for Policy Scan Config
17 properties 2 required
NameValueIntegerString
object
2 properties
TimeModel
object
Model for Time
2 properties
CountDetails
object
2 properties
AbsoluteTimeRangeConfig
object
UIFilter
object
3 properties
FindingNodeMetadata
object
Finding Node Metadata
9 properties 5 required
FindingBuildTimeRemediationMetadata
object
21 properties
PolicyPageResponse
object
3 properties
PolicyFilter
object
6 properties
ComplianceMetadata
object
Compliance Standards
15 properties
CloudNetworkNode
object
Represents a network node
9 properties 3 required
EdgeMetadata
object
Edge Metadata
1 property 1 required
VulnerabilityNode
object
1 required
FindingNode
object
1 required
CapabilityNodeMetadata
object
Capability Node Metadata
2 properties 1 required
GroupPageResponse
object
4 properties
VulnerabilityMetadata
object
Vulnerability Node Metadata
5 properties 5 required
GraphEdge
object
5 properties 2 required
AlertEvidenceGraph
object
The resource specific graph
2 properties
PolicyVO
object
Policy data with alert count
14 properties
TimeRangeConfigModel_2
object
Model for TimeRangeConfig
4 properties 1 required
CloudNetworkGraph
object
Represents the associated network graph for this finding
2 properties
SpringErrorResponse
object
6 properties 5 required
FindingRemediationDetails
object
Represents the RemediationDetails for this finding
2 properties
Path
object
The associated paths in the network graph
1 property
GraphAlertEvidenceGraph
object
The list of graphs representing a primary asset and its associations
1 property
ToNowTimeRangeConfig
object
DataTypes
object
Data Sensitivity datatypes
3 properties
RelativeTimeRangeConfig
object
IAMPermissionsResponse
object
Permission graph items
11 properties
AssetGraphs
object
2 properties 1 required
GroupsResponse
object
List of groups for selected group by field
13 properties
NodeDataType
object
The nodes associated with this network graph
2 properties
AssetNode
object
2 required
FromNowTimeRangeConfig
object
CloudNetworkGraphResponse
object
The cloud network graphs
2 properties
CapabilityNode
object
2 required
PrimaryAssetNode
object
2 required
RelativeTimeDuration
object
2 properties
AssetNodeMetadata
object
Primary Asset Node Metadata
5 properties 3 required
FindingRuntimeRemediationMetadaa
object
1 property
Node
object
A dictionary of the node identifier and the associated node
2 properties
ErrorDetails
object
2 properties 2 required
IAMPermissionGraph
object
Represents the associated permission graph for this finding
1 property
Time
object
2 properties
OnDemandNotificationConfig
object
6 properties 3 required
OnDemandNotificationConfigRequest
object
3 properties 2 required
NotificationResponse
object
4 properties
ErrorResponse
object
1 property 1 required
SuccessfulEvents
object
5 properties
Error
object
4 properties 2 required
Translation
object
3 properties 1 required
FilterModel_2
object
Model for Filter
9 properties
PolicyModel_2
object
Model for Policy
25 properties 4 required
PolicyRiskScoreModel_2
object
Model for Policy Risk Score
27 properties 4 required
AlertModel_2
object
Model for Alert
24 properties
PolicyWithRemediation
object
9 properties
ScriptRemediation
object
The suggested Terraform-based remediation steps
5 properties
ManualRemediation
object
The manual remediation steps to be taken
4 properties
PolicyWithRemediationResponse
object
1 property
AiRemediation
object
3 properties
AssetLabelDashboardDTO
object
2 properties
AlertDTO
object
20 properties
UpdateAlertStatusResponseDTO
object
3 properties
LabelDashboardDTO
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-alerts-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 Alerts 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.