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

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

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

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

Requests are made against a single base URL, PATH_TO_CONSOLE.

18 operations 17 paths 89 schemas 1 DELETE8 GET9 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/
Resource Areas
1

Paths & Operations 18

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

Registry 18

Registry. 10 operations in this definition.

DELETE
/api/v1/registry/webhook/webhook
Delete a Registry Webhook
delete-registry-webhook-webhook → 200default
POST
/api/v1/registry/webhook/webhook
Registry Webhook
post-registry-webhook-webhook body → 200default
GET
/api/v34.03/registry
Get Registry Scan Results
get-registry 18 params → 200default
GET
/api/v34.03/registry/download
Download Registry Scan Results
get-registry-download 18 params → 200default
GET
/api/v34.03/registry/names
Get Registry Image Names
get-registry-names 18 params → 200default
GET
/api/v34.03/registry/progress
View Registry Scan Progress
get-registry-progress 5 params → 200default
POST
/api/v34.03/registry/scan
Start a Registry Scan
post-registry-scan body → 200default
POST
/api/v34.03/registry/scan/select
Scan Registries
post-registry-scan-select body → 200default
POST
/api/v34.03/registry/stop
Stop a Registry Scan
post-registry-stop → 200default
POST
/api/v34.03/registry/stop/{id}
Stop a Registry spec Scan
post-registry-stop-id 1 param → 200default
GET
/api/v34.04/registry
Get Registry Scan Results
get-registry 18 params → 200default
GET
/api/v34.04/registry/download
Download Registry Scan Results
get-registry-download 18 params → 200default
GET
/api/v34.04/registry/names
Get Registry Image Names
get-registry-names 18 params → 200default
GET
/api/v34.04/registry/progress
View Registry Scan Progress
get-registry-progress 5 params → 200default
POST
/api/v34.04/registry/scan
Start a Registry Scan
post-registry-scan body → 200default
POST
/api/v34.04/registry/scan/select
Scan Registries
post-registry-scan-select body → 200default
POST
/api/v34.04/registry/stop
Stop a Registry Scan
post-registry-stop → 200default
POST
/api/v34.04/registry/stop/{id}
Stop a Registry spec Scan
post-registry-stop-id 1 param → 200default

Schemas 89

The contract defines 89 schemas that model the data the API accepts and returns. The most detailed are shared.ImageScanResult_3 (89 properties), shared.ImageScanResult_2 (89 properties), shared.ImageScanResult (87 properties), vuln.Vulnerability_3 (37 properties). Each schema is shown below with its type and property counts.

vulnerability.ExploitType
string
ExploitType represents the source of an exploit
shared.ImageTag
object
ImageTag represents an image repository and its associated tag or registry digest
5 properties
common.NetworkDeviceIP
object
NetworkDeviceIP represents a network device name and address pair
2 properties
common.ACIMetadata
object
1 property
shared.FileDetails
object
FileDetails contains file details as the file path, hash checksum
5 properties
vuln.SecretType
string
SecretType represents a secret type
-_shared.RegistryScanProgress
array
vulnerability.RiskFactors
object
RiskFactors maps the existence of vulnerability risk factors
shared.ImageInstance
object
ImageInstance represents an image on a single host
6 properties
shared.PkgsTimes
object
PkgsTimes are the compressed layer times for pkgs of the specific type
2 properties
trust.Status
string
Status is the trust status for an image
agentless.ImageScanResultErrCode
integer
ImageScanResultErrCode represents the asset status error
shared.Progress
object
Progress displays the scan progress
12 properties
shared.ImageHosts
object
ImageHosts is a fast index for image scan results metadata per host
shared.RegistryScanRequest
object
RegistryScanRequest represents a registry scan request
5 properties
common.ClusterType
string
ClusterType is the cluster type
shared.CompressedLayerTimes
object
CompressedLayerTimes represent the compressed layer times of the image apps and pkgs
2 properties
shared.ImageHistory
object
ImageHistory represent a layer in the image's history
8 properties
waas.OutOfBandMode
string
OutOfBandMode holds the app firewall out-of-band mode
cred.Credential
object
Credential specifies the authentication data of an external provider
25 properties
int
integer
types.RegistryWebhookRequest
object
RegistryWebhookRequest is a registry scanning webhook request. Schema supports multiple webhook providers: https://docs.docker.com/docker-hub/webhooks/ https:/…
5 properties
shared.InstalledProducts
object
InstalledProducts contains data regarding products running in environment TODO 34713: Swarm support was deprecated in Joule, remove swarm node/manager boolean…
24 properties
int64
integer
-_shared.RegistryScanRequest
array
types.ArtifactoryWebhookRequest
object
ArtifactoryWebhookRequest is an artifactory webhook request Artifactory doesn't have native webhook support, instead it comes as a plugin https://github.com/jf…
common.AzureMetadata
object
2 properties
vulnerability.ExploitKind
string
ExploitKind represents the kind of the exploit
shared.ScanResultType
string
ScanResultType represents a cloud scan result type
common.CloudProvider
string
CloudProvider specifies the cloud provider name
vuln.AllCompliance
object
AllCompliance contains data regarding passed compliance checks
2 properties
vuln.Secret
object
Secret represents a secret found on the scanned workload
12 properties
vuln.WildFireMalware
object
WildFireMalware holds the data for WildFire malicious MD5
3 properties
vuln.Vulnerability
object
Vulnerability is a general schema for vulnerabilities (e.g., for compliance or packages)
37 properties
vuln.Distribution
object
Distribution counts the number of vulnerabilities per type
5 properties
shared.GitlabRegistrySpec
object
GitlabRegistrySpec represents a specification for registry scanning in GitLab
5 properties
common.ExternalLabelSourceType
string
ExternalLabelSourceType indicates the source of the labels
shared.Binary
object
Binary represents a detected binary file (ELF)
12 properties
-_string
array
trust.ImageResult
object
ImageResult represents an aggregated image trust result
2 properties
shared.ImageHost
object
ImageHost holds information about image scan result per host
9 properties
shared.RegistrySpecification
object
RegistrySpecification contains information for connecting to local/remote registry
26 properties
vuln.Application
object
Application represents a detected application
10 properties
secrets.SecretScanMetrics
object
SecretScanMetrics represents metrics collected during secret scan
10 properties
shared.RegistryScanProgress
object
RegistryScanProgress represents the registry scan progress
4 properties
vuln.ComplianceTemplate
string
ComplianceTemplate represents the compliance template
common.CloudRunMetadata
object
2 properties
vulnerability.Type
string
Type represents the vulnerability type
common.ExternalLabel
object
ExternalLabel holds an external label with a source and timestamp
5 properties
vulnerability.ExploitData
object
ExploitData holds information about an exploit
3 properties
string
string
shared.JFrogRepoType
string
JFrogRepoType represents the type of JFrog Artifactory repository
common.Secret
object
Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
2 properties
shared.ScanType
string
ScanType displays the components for an ongoing scan
waas.ProtectionStatus
object
ProtectionStatus describes the status of the WAAS protection
6 properties
cred.OCICred
object
OCICred are additional parameters required for OCI credentials
2 properties
trust.Group
object
Group represents a group of images
9 properties
packages.Type
string
Type describes the package type
vuln.TagInfo
object
TagInfo is the tag info in a specific vulnerability context
3 properties
vulnerability.Exploits
array
Exploits represents the exploits data found for a CVE
cred.Type
string
Type specifies the credential type
wildfire.Usage
object
Usage holds wildfire usage stats, period for the usage varies with context
3 properties
common.CloudMetadata
object
CloudMetadata is the metadata for a cloud provider managed asset (e.g., as part of AWS/GCP/Azure/OCI)
15 properties
waas.UnprotectedProcess
object
UnprotectedProcess holds unprotected processes alongside the port
3 properties
common.Color
string
Color is a hexadecimal representation of color code value
cred.AzureSPInfo
object
AzureSPInfo contains the Azure credentials needed for certificate based authentications
4 properties
shared.Packages
object
Packages is a collection of packages
2 properties
common.GCPCloudMetadata
object
1 property
shared.RegistryOSType
string
RegistryOSType specifies the registry images base OS type
cred.TemporaryToken
object
TemporaryToken is a temporary session token for cloud provider APIs AWS - https://docs.aws.amazon.com/IAM/latest/UserGuide/idcredentialstemp.html GCP - https:/…
5 properties
shared.ImageScanResult
object
ImageScanResult holds the result of an image scan
87 properties
trust.HostStatus
object
HostStatus represents an image trust status on a host
2 properties
cred.AzureMIType
string
shared.Image
object
Image represents a container image
13 properties
int16
integer
shared.Package
object
Package stores relevant package information
22 properties
-_shared.ImageScanResult
array
shared.InstalledProducts_2
object
InstalledProducts contains data regarding products running in environment TODO 34713: Swarm support was deprecated in Joule, remove swarm node/manager boolean…
25 properties
vuln.Vulnerability_2
object
Vulnerability is a general schema for vulnerabilities (e.g., for compliance or packages)
37 properties
vulnerability.VulnerabilityDataSource
object
VulnerabilityDataSource identifies the source of a specific vulnerability attribute. Example: CVSS from NVD, Severity from RedHat.
2 properties
vulnerability.VulnerabilitySource
integer
VulnerabilitySource represents the authority that provided vulnerability-related data (severity, CVSS, links).
vulnerability.VulnerabilityAttribute
integer
VulnerabilityAttribute represents a specific vulnerability property whose value may come from different sources
shared.ImageScanResult_2
object
ImageScanResult holds the result of an image scan
89 properties
vulnerability.VulnerabilityDataSources
array
VulnerabilityDataSources is a slice of VulnerabilityDataSource that implements the sql.Scanner and driver.Valuer interfaces
shared.Package_2
object
Package stores relevant package information
21 properties
shared.InstalledProducts_3
object
InstalledProducts contains data regarding products running in environment TODO 34713: Swarm support was deprecated in Joule, remove swarm node/manager boolean…
25 properties
vuln.Vulnerability_3
object
Vulnerability is a general schema for vulnerabilities (e.g., for compliance or packages)
37 properties
shared.ImageScanResult_3
object
ImageScanResult holds the result of an image scan
89 properties
shared.Package_3
object
Package stores relevant package information
21 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

palo-alto-networks-registry-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 Registry 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.