The identity and technical contract details declared by the specification.
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
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
-_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
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
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
shared.Image
object
Image represents a container image
13 properties
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Palo Alto Networks publishes across the network.