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

{'$ref': 'desc/collections/collections.md'}

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

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

Requests are made against 16 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, PATH_TO_CONSOLE.

15 operations 8 paths 12 schemas 3 DELETE6 GET3 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
Resource Areas
1

Authentication & Security 1

Palo Alto Networks Collections 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 15

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

Collections 15

Collections. 5 operations in this definition.

GET
/api/v34.03/collections
Get Collections
get-collections 3 params → 200default
POST
/api/v34.03/collections
Add a New Collection
post-collections body → 200default
DELETE
/api/v34.03/collections/{id}
Delete an Existing Collection
delete-collections-id 1 param → 200default
PUT
/api/v34.03/collections/{id}
Update an Existing Collection
put-collections-id 1 param body → 200default
GET
/api/v34.03/collections/{id}/usages
Get Policies for a Collection
get-collections-id-usages 1 param → 200default
GET
/api/v34.04/collections
Get Collections
get-collections 3 params → 200default
POST
/api/v34.04/collections
Add a New Collection
post-collections body → 200default
DELETE
/api/v34.04/collections/{id}
Delete an Existing Collection
delete-collections-id 1 param → 200default
PUT
/api/v34.04/collections/{id}
Update an Existing Collection
put-collections-id 1 param body → 200default
GET
/api/v34.04/collections/{id}/usages
Get Policies for a Collection
get-collections-id-usages 1 param → 200default
GET
/entitlement/api/v1/collection/{id}
Get Collection by ID
get-collection-by-id 1 param → 4034002004XX429
PUT
/entitlement/api/v1/collection/{id}
Update Collection
update-collection-by-id 1 param body → 4034002004XX429
DELETE
/entitlement/api/v1/collection/{id}
Delete Collection
delete-collection-by-id 1 param → 4034002044XX429
GET
/entitlement/api/v1/collection
Get All Collections
get-all-collections 4 params → 4034002004XX429
POST
/entitlement/api/v1/collection
Create Collection
create-collection body → 4034002014XX429

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are collection.Collection (16 properties), Collection (8 properties), SpringErrorResponse (6 properties), AssetGroup (3 properties). Each schema is shown below with its type and property counts.

string
string
-_collection.Collection
array
-_collection.Usage
array
common.Color
string
Color is a hexadecimal representation of color code value
collection.Usage
object
Usage represents details of a collection being used
2 properties
collection.UsageType
string
UsageType represents a collection usage type
collection.Collection
object
Collection is a collection of resources
16 properties
AssetGroup
object
AssetGroup that are part of Collection
3 properties
PrismaCollectionView
object
2 properties
SpringErrorResponse
object
6 properties 5 required
ErrorDetails
object
2 properties 2 required
Collection
object
Collections Data Model
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-collections-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 Collections 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.