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

You can use the Resource Query Language (RQL) to perform configuration checks across cloud services as well as gain real-time insights into user and network events to gain security visibility and create policy guardrails in your cloud environment. See the [Prisma Cloud documentation](https://docs.paloaltonetworks.com/prisma/prisma-cloud.html) for more information.

Palo Alto Networks Search 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 Search. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against 15 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.

19 operations 19 paths 54 schemas 3 GET16 POST

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 Search 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 19

Across 19 paths, the API surfaces 19 operations — 3 GET, 16 POST. Each is listed below with its method, path, parameters, and response codes.

Search 19

You can use the Resource Query Language (RQL) to perform configuration checks across cloud services as well as gain real-time insights into user and network events to gain securit…

POST
/search/config
Perform Config Search
search-config body → 200400404500
POST
/search
Perform Network Search
search-network body → 200400404500
POST
/search/event
Perform Event Search
search-events body → 200400404500
POST
/search/event/aggregate
Aggregated Event Search
search-events-aggregated body → 200400
POST
/search/event/filtered
Filter Event Search Results
search-events-filtered body → 200400
POST
/search/event/page
Get The Next Event Search Page
search-events-page body → 200500
GET
/search/event/raw/{id}
Get Raw Event Data
search-events-raw 1 param → 200404500
POST
/search/suggest
Autocomplete Search
search-suggest body → 200
GET
/search/alert
Search Alerts by ID
search-for-alert-by-id 1 param → 200404500
POST
/search/config/page
Get The Next Config Search Page
search-config-page body → 200500
POST
/search/event/filtered/download
Download Event Search CSV
search-events-csv body → 200400
POST
/search/config/jobs
Submit Search Config CSV Generation Job
submit-an-search-config-csv-download-job body → 200202400500
GET
/search/config/jobs/{id}/download
Download Async Config Search CSV
async-search-config-csv 1 param → 200202400404500
POST
/search/api/v1/config
Perform Config Search by Query
search-config-by-query body → 200400404
POST
/search/api/v1/config/async
Perform Asynchronous Config Search
search-config-async-csv-download body → 200202400404
POST
/search/api/v1/config/download
Download Config Search as CSV
search-config-csv-download body → 200400403404
POST
/search/api/v2/config
Perform Config Search V2
search-config-v2 body → 200400404
POST
/search/api/v2/config/{id}
Perform Config Search by Search Id V2
search-config-by-search-id-v2 1 param body → 200400404
POST
/search/api/v1/config/{id}
Perform Config Search by Search Id
search-config-by-search-id 1 param body → 200400404

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are AuditEvent_2 (40 properties), AuditEvent (40 properties), ResourceMetaModelV3 (30 properties), AggregateAuditEvent (29 properties). Each schema is shown below with its type and property counts.

UserAgentOs
object
3 properties
SortAuditEventSortField
object
2 properties
SearchResponseModelListAggregateAuditEvent
object
17 properties 2 required
SortConfigRuleSortField
object
2 properties
SearchResponseModel
object
17 properties 2 required
ConfigRulePageParams
object
3 properties
ResourceMetaModel
object
Model containing resource metadata
29 properties
PagedResultsResourceMetaModel
object
6 properties
RelativeTimeRangeConfigModel
ToNowTimeRangeConfigModel
ResourceIdBean
object
Model for Resource ID Bean
9 properties
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
SearchResponseModelPagedResultsResourceMetaModel
object
17 properties 2 required
ConfigRuleSearchParams
object
8 properties
AutocompleteInfo
object
Model for AutocompleteInfo
6 properties
SearchModel
object
16 properties 2 required
UIFilterModel
object
Model for UIFilter
3 properties
AggregateAuditEvent
object
29 properties
SearchResponseModelPagedResultsAuditEvent
object
17 properties 2 required
RRNModel
object
Model for RRN
6 properties
SearchResponseModelListObject
object
17 properties 2 required
PagedResultsAuditEvent
object
6 properties
ConfigCsvJobResponseModel
object
Response Model for CreateConfigRuleSearchCsvDownloadJob
4 properties
AuditEventSearchParamsModel
object
Audit event search parameters model
8 properties
UserAgentBrowser
object
3 properties
AuditEventPageParams
object
2 properties
AuditEvent
object
40 properties
TimeModel
object
Model for Time
2 properties
ConfigSearchBySearchIdV1Request
object
5 properties
ConfigSearchAsyncDownloadV1Response
object
6 properties
ConfigSearchByQueryV2Request
object
8 properties 1 required
SortAuditEventSortField_2
object
2 properties
SortConfigRuleSortField_2
object
2 properties
SearchResponseModelListAggregateAuditEvent_2
object
17 properties 2 required
SearchResponseModel_2
object
17 properties 2 required
ConfigRulePageParams_2
object
4 properties
ResourceMetaModel_2
object
Model containing resource metadata
29 properties
CsvMessageModel
object
Model for CsvMessage
3 properties
ResourceIdBean_2
object
Model for Resource ID Bean
9 properties
TimeRangeConfigModel_2
object
Model for TimeRangeConfig
2 properties
SearchResponseModelPagedResultsResourceMetaModel_2
object
17 properties 2 required
ConfigRuleSearchParams_2
object
9 properties
SearchModel_2
object
16 properties 2 required
ConfigSearchV1ResponseResourceMetaModel
object
7 properties
SearchResponseModelPagedResultsAuditEvent_2
object
17 properties 2 required
ConfigSearchByQueryWithDownloadV1Request
object
4 properties 1 required
SearchResponseModelListObject_2
object
17 properties 2 required
ConfigSearchV1ResponseResourceMetaModelV3
object
7 properties
AuditEvent_2
object
40 properties
ConfigSearchBySearchIdV2Request
object
5 properties
ConfigSearchByQueryV1Request
object
8 properties 1 required
ResourceMetaModelV3
object
Model containing resource metadata
30 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-search-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 Search 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.