Add CLI Scan Result
POST/api/v30.00/scans
x-prisma-cloud-target-env: {"permission":"monitorCI","saas":true,"self-hosted":true}
x-public: true
AddCLIScanResult adds a CLI scan result
Request
- application/json
Body
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
ID of the scan result.
CI build.
Scan compliance failure summary.
entityInfo object
ImageScanResult holds the result of an image scan
Secrets are paths to embedded secrets inside the image Note: capital letter JSON annotation is kept to avoid converting all images for backward-compatibility support.
Image identifier (image ID or repo:tag).
Agentless indicates that the host was scanned with the agentless scanner.
allCompliance object
AllCompliance contains data regarding passed compliance checks
compliance object[]
Compliance are all the passed compliance checks.
Rules applied on the package.
Names of the distro binary package names (packages which are built from the source of the package).
Indicates if the vulnerability has a block effect (true) or not (false).
Additional information regarding the root cause for the vulnerability.
Indicates if this is a CRI-specific vulnerability (true) or not (false).
Indicates if the vulnerability is a custom vulnerability (e.g., openscap, sandbox) (true) or not (false).
CVE ID of the vulnerability (if applied).
CVSS score of the vulnerability.
Description of the vulnerability.
Specifies the time of discovery for the vulnerability.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
exploits object[]
Exploits represents the exploits data found for a CVE
Possible values: [poc,in-the-wild]
ExploitKind represents the kind of the exploit
Link is a link to information about the exploit.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
Date/time when the vulnerability was fixed (in Unix time).
Link to the vendor's fixed-version information.
Specifies the serverless layer ID in which the vulnerability was discovered.
Number of grace days left for a vulnerability, based on the configured grace period. Nil if no block vulnerability rule applies.
ID of the violation.
Date/time of the image layer to which the CVE belongs.
Vendor link to the CVE.
Name of the package that caused the vulnerability.
Version of the package that caused the vulnerability (or null).
Date/time when the vulnerability was published (in Unix time).
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Textual representation of the vulnerability's severity.
Vendor status for the vulnerability.
Possible values: [PCI,HIPAA,NIST SP 800-190,GDPR,DISA STIG]
List of templates with which the vulnerability is associated.
Description of the violation.
Compliance title.
Indicates if this is a Twistlock-specific vulnerability (true) or not (false).
Possible values: [container,image,host_config,daemon_config,daemon_config_files,security_operations,k8s_master,k8s_worker,k8s_federation,linux,windows,istio,serverless,custom,docker_stig,openshift_master,openshift_worker,application_control_linux]
Type represents the vulnerability type
Textual representation of the metric values used to score the vulnerability.
vulnTagInfos object[]
Tag information for the vulnerability.
Color is a hexadecimal representation of color code value
Tag comment in a specific vulnerability context.
Name of the tag.
Enabled indicates whether passed compliance checks is enabled by policy.
Indicates that this image was scanned by an App-Embedded Defender.
applications object[]
Products in the image.
Indicates that the app was installed as an OS package.
Total number of vulnerabilities for this application.
Image layer to which the application belongs - layer creation time.
Name of the application.
Path of the detected application.
Service indicates whether the application is installed as a service.
Version of the application.
Image’s base image name. Used when filtering the vulnerabilities by base images.
binaries object[]
Binaries in the image.
Indicates if the binary was installed from a package manager and modified/replaced (true) or not (false).
Total number of CVEs for this specific binary.
Third-party package files which are used by the binary.
ID of the serverless layer in which the package was discovered.
Md5 hashset of the binary.
Indicates if this binary is not related to any package (true) or not (false).
Name of the binary.
Relative path of the binary inside the container.
Path for searching packages used by the binary.
Names of services which use the binary.
Version of the binary.
cloudMetadata object
CloudMetadata is the metadata for an instance running in a cloud provider (AWS/GCP/Azure)
Cloud account ID.
AWS execution environment (e.g. EC2/Fargate).
Image name.
labels object[]
Cloud provider metadata labels.
Label key.
Source name (e.g., for a namespace, the source name can be 'twistlock').
Possible values: [namespace,deployment,aws,azure,gcp,oci]
ExternalLabelSourceType indicates the source of the labels
Time when the label was fetched.
Value of the label.
Instance name.
Possible values: [aws,azure,gcp,alibaba,oci,others]
CloudProvider represents the cloud provider
Instance region.
Unique ID of the resource.
Server-defined URL for the resource.
Instance type.
Azure unique vm ID.
VMImageID holds the VM image ID.
Possible values: [AKS,ECS,EKS,GKE,Kubernetes]
ClusterType is the cluster type
Cluster names.
Collections to which this result applies.
complianceDistribution object
Distribution counts the number of vulnerabilities per type
.
.
.
.
.
complianceIssues object[]
All the compliance issues.
Rules applied on the package.
Names of the distro binary package names (packages which are built from the source of the package).
Indicates if the vulnerability has a block effect (true) or not (false).
Additional information regarding the root cause for the vulnerability.
Indicates if this is a CRI-specific vulnerability (true) or not (false).
Indicates if the vulnerability is a custom vulnerability (e.g., openscap, sandbox) (true) or not (false).
CVE ID of the vulnerability (if applied).
CVSS score of the vulnerability.
Description of the vulnerability.
Specifies the time of discovery for the vulnerability.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
exploits object[]
Exploits represents the exploits data found for a CVE
Possible values: [poc,in-the-wild]
ExploitKind represents the kind of the exploit
Link is a link to information about the exploit.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
Date/time when the vulnerability was fixed (in Unix time).
Link to the vendor's fixed-version information.
Specifies the serverless layer ID in which the vulnerability was discovered.
Number of grace days left for a vulnerability, based on the configured grace period. Nil if no block vulnerability rule applies.
ID of the violation.
Date/time of the image layer to which the CVE belongs.
Vendor link to the CVE.
Name of the package that caused the vulnerability.
Version of the package that caused the vulnerability (or null).
Date/time when the vulnerability was published (in Unix time).
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Textual representation of the vulnerability's severity.
Vendor status for the vulnerability.
Possible values: [PCI,HIPAA,NIST SP 800-190,GDPR,DISA STIG]
List of templates with which the vulnerability is associated.
Description of the violation.
Compliance title.
Indicates if this is a Twistlock-specific vulnerability (true) or not (false).
Possible values: [container,image,host_config,daemon_config,daemon_config_files,security_operations,k8s_master,k8s_worker,k8s_federation,linux,windows,istio,serverless,custom,docker_stig,openshift_master,openshift_worker,application_control_linux]
Type represents the vulnerability type
Textual representation of the metric values used to score the vulnerability.
vulnTagInfos object[]
Tag information for the vulnerability.
Color is a hexadecimal representation of color code value
Tag comment in a specific vulnerability context.
Name of the tag.
Number of compliance issues.
Compliance risk score for the image.
Specifies the time of creation for the latest version of the image.
Full name of the distribution.
ECS cluster name.
Description of an error that occurred during image health scan.
externalLabels object[]
Kubernetes external labels of all containers running this image.
Label key.
Source name (e.g., for a namespace, the source name can be 'twistlock').
Possible values: [namespace,deployment,aws,azure,gcp,oci]
ExternalLabelSourceType indicates the source of the labels
Time when the label was fetched.
Value of the label.
files object[]
Files in the container.
Hash sum of the file using md5.
Path of the file.
Hash sum of the file using SHA-1.
Hash sum of the file using SHA256.
firewallProtection object
ProtectionStatus describes the status of the WAAS protection
Enabled indicates if WAAS proxy protection is enabled (true) or not (false).
Possible values: [,Observation,Protection]
OutOfBandMode holds the app firewall out-of-band mode
Ports indicates http open ports associated with the container.
Supported indicates if WAAS protection is supported (true) or not (false).
TLSPorts indicates https open ports associated with the container.
unprotectedProcesses object[]
UnprotectedProcesses holds the processes that support HTTP/HTTPS without WAAS protection.
Port is the process port.
Process is the process name.
TLS is the port TLS indication.
Specifies the time of the scan for the first version of the image. This time is preserved even after the version update.
history object[]
Docker image history.
Indicates if this layer originated from the base image (true) or not (false).
Date/time when the image layer was created.
Indicates if this instruction didn't create a separate layer (true) or not (false).
ID of the layer.
Docker file instruction and arguments used to create this layer.
Size of the layer (in bytes).
Holds the image tags.
vulnerabilities object[]
Vulnerabilities which originated from this layer.
Rules applied on the package.
Names of the distro binary package names (packages which are built from the source of the package).
Indicates if the vulnerability has a block effect (true) or not (false).
Additional information regarding the root cause for the vulnerability.
Indicates if this is a CRI-specific vulnerability (true) or not (false).
Indicates if the vulnerability is a custom vulnerability (e.g., openscap, sandbox) (true) or not (false).
CVE ID of the vulnerability (if applied).
CVSS score of the vulnerability.
Description of the vulnerability.
Specifies the time of discovery for the vulnerability.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
exploits object[]
Exploits represents the exploits data found for a CVE
Possible values: [poc,in-the-wild]
ExploitKind represents the kind of the exploit
Link is a link to information about the exploit.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
Date/time when the vulnerability was fixed (in Unix time).
Link to the vendor's fixed-version information.
Specifies the serverless layer ID in which the vulnerability was discovered.
Number of grace days left for a vulnerability, based on the configured grace period. Nil if no block vulnerability rule applies.
ID of the violation.
Date/time of the image layer to which the CVE belongs.
Vendor link to the CVE.
Name of the package that caused the vulnerability.
Version of the package that caused the vulnerability (or null).
Date/time when the vulnerability was published (in Unix time).
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Textual representation of the vulnerability's severity.
Vendor status for the vulnerability.
Possible values: [PCI,HIPAA,NIST SP 800-190,GDPR,DISA STIG]
List of templates with which the vulnerability is associated.
Description of the violation.
Compliance title.
Indicates if this is a Twistlock-specific vulnerability (true) or not (false).
Possible values: [container,image,host_config,daemon_config,daemon_config_files,security_operations,k8s_master,k8s_worker,k8s_federation,linux,windows,istio,serverless,custom,docker_stig,openshift_master,openshift_worker,application_control_linux]
Type represents the vulnerability type
Textual representation of the metric values used to score the vulnerability.
vulnTagInfos object[]
Tag information for the vulnerability.
Color is a hexadecimal representation of color code value
Tag comment in a specific vulnerability context.
Name of the tag.
hostDevices object[]
Map from host network device name to IP address.
Network device IPv4 address.
Network device name.
HostRuntimeEnabled indicates if any runtime rule applies to the host.
Name of the host that was scanned.
hosts object
ImageHosts is a fast index for image scan results metadata per host
property name* shared.ImageHost
ImageHost holds information about image scan result per host
AccountID is the cloud account ID the image is associated with.
Agentless indicates if the image was scanned as part of an agentless scan.
AgentlessScanID is the ID of the agentless scan in which the result was received.
AppEmbedded indicates if the host is an app embedded host.
Cluster is the cluster on which the image is deployed.
Modified is the last scan time.
Namespaces are the namespaces on which the image is deployed.
Image ID.
image object
Image represents a container image
Date/time when the image was created.
Combined entrypoint of the image (entrypoint + CMD).
Image environment variables.
Indicates if health checks are enabled (true) or not (false).
history object[]
Holds the image history.
Indicates if this layer originated from the base image (true) or not (false).
Date/time when the image layer was created.
Indicates if this instruction didn't create a separate layer (true) or not (false).
ID of the layer.
Docker file instruction and arguments used to create this layer.
Size of the layer (in bytes).
Holds the image tags.
vulnerabilities object[]
Vulnerabilities which originated from this layer.
Rules applied on the package.
Names of the distro binary package names (packages which are built from the source of the package).
Indicates if the vulnerability has a block effect (true) or not (false).
Additional information regarding the root cause for the vulnerability.
Indicates if this is a CRI-specific vulnerability (true) or not (false).
Indicates if the vulnerability is a custom vulnerability (e.g., openscap, sandbox) (true) or not (false).
CVE ID of the vulnerability (if applied).
CVSS score of the vulnerability.
Description of the vulnerability.
Specifies the time of discovery for the vulnerability.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
exploits object[]
Exploits represents the exploits data found for a CVE
Possible values: [poc,in-the-wild]
ExploitKind represents the kind of the exploit
Link is a link to information about the exploit.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
Date/time when the vulnerability was fixed (in Unix time).
Link to the vendor's fixed-version information.
Specifies the serverless layer ID in which the vulnerability was discovered.
Number of grace days left for a vulnerability, based on the configured grace period. Nil if no block vulnerability rule applies.
ID of the violation.
Date/time of the image layer to which the CVE belongs.
Vendor link to the CVE.
Name of the package that caused the vulnerability.
Version of the package that caused the vulnerability (or null).
Date/time when the vulnerability was published (in Unix time).
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Textual representation of the vulnerability's severity.
Vendor status for the vulnerability.
Possible values: [PCI,HIPAA,NIST SP 800-190,GDPR,DISA STIG]
List of templates with which the vulnerability is associated.
Description of the violation.
Compliance title.
Indicates if this is a Twistlock-specific vulnerability (true) or not (false).
Possible values: [container,image,host_config,daemon_config,daemon_config_files,security_operations,k8s_master,k8s_worker,k8s_federation,linux,windows,istio,serverless,custom,docker_stig,openshift_master,openshift_worker,application_control_linux]
Type represents the vulnerability type
Textual representation of the metric values used to score the vulnerability.
vulnTagInfos object[]
Tag information for the vulnerability.
Color is a hexadecimal representation of color code value
Tag comment in a specific vulnerability context.
Name of the tag.
ID of the image.
labels object
Image labels.
Image filesystem layers.
Image os type.
Image repo digests.
Image repo tags.
Image user.
Base working directory of the image.
installedProducts object
InstalledProducts contains data regarding products running in environment TODO #34713: Swarm support was deprecated in Joule, remove swarm node/manager boolean (and related compliance) in Lagrange
Agentless indicates whether the scan was performed with agentless approach.
Apache indicates the apache server version, empty in case apache not running.
AWSCloud indicates whether AWS cloud is used.
CRI indicates whether the container runtime is CRI (and not docker).
Docker represents the docker daemon version.
DockerEnterprise indicates whether the enterprise version of Docker is installed.
HasPackageManager indicates whether package manager is installed on the OS.
K8sAPIServer indicates whether a kubernetes API server is running.
K8sControllerManager indicates whether a kubernetes controller manager is running.
K8sEtcd indicates whether etcd is running.
K8sFederationAPIServer indicates whether a federation API server is running.
K8sFederationControllerManager indicates whether a federation controller manager is running.
K8sKubelet indicates whether kubelet is running.
K8sProxy indicates whether a kubernetes proxy is running.
K8sScheduler indicates whether the kubernetes scheduler is running.
Kubernetes represents the kubernetes version.
Openshift indicates whether openshift is deployed.
OpenshiftVersion represents the running openshift version.
OSDistro specifies the os distribution.
Serverless indicates whether evaluated on a serverless environment.
SwarmManager indicates whether a swarm manager is running.
SwarmNode indicates whether the node is part of an active swarm.
instances object[]
Details about each occurrence of the image (tag + host).
.
.
.
.
.
.
IsARM64 indicates if the architecture of the image is aarch64.
Endpoint of the Kubernetes API server.
Image labels.
Image's filesystem layers. Each layer is a SHA256 digest of the filesystem diff See: https://windsock.io/explaining-docker-image-ids/.
Indicates if the image OS is covered in the IS (true) or not (false).
k8s namespaces of all the containers running this image.
Name of the OS distribution.
OS distribution release.
OS distribution version.
PackageCorrelationDone indicates that the correlation to OS packages has been done.
Indicates if the package manager is installed for the OS.
packages object[]
Packages which exist in the image.
pkgs object[]
List of packages.
Indexes of the top binaries which use the package.
Names of the distro binary packages (packages which are built on the source of the package).
Total number of CVEs for this specific package.
files object[]
List of package-related files and their hashes. Only included when the appropriate scan option is set.
Hash sum of the file using md5.
Path of the file.
Hash sum of the file using SHA-1.
Hash sum of the file using SHA256.
ID of the serverless layer in which the package was discovered.
GoPkg indicates this is a Go package (and not module).
JarIdentifier holds an additional identification detail of a JAR package.
Image layer to which the package belongs (layer creation time).
License information for the package.
Name of the package.
OSPackage indicates that a python/java package was installed as an OS package.
Full package path (e.g., JAR or Node.js package path).
Package version.
Possible values: [nodejs,gem,python,jar,package,windows,binary,nuget,go]
PackageType describes the package type
PullDuration is the time it took to pull the image.
PushTime is the image push time to the registry.
IBM cloud namespace to which the image belongs.
RegistryType indicates the registry type where the image is stored.
Digests of the image. Used for content trust (notary). Has one digest per tag.
repoTag object
ImageTag represents an image repository and its associated tag or registry digest
Image digest (requires V2 or later registry).
ID of the image.
Registry name to which the image belongs.
Repository name to which the image belongs.
Image tag.
RhelRepositories are the (RPM) repositories IDs from which the packages in this image were installed Used for matching vulnerabilities by Red Hat CPEs.
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Scanner build date that published the image.
ScanDuration is the total time it took to scan the image.
ScanID is the ID of the scan.
Specifies the time of the last scan of the image.
Scanner version that published the image.
startupBinaries object[]
Binaries which are expected to run when the container is created from this image.
Indicates if the binary was installed from a package manager and modified/replaced (true) or not (false).
Total number of CVEs for this specific binary.
Third-party package files which are used by the binary.
ID of the serverless layer in which the package was discovered.
Md5 hashset of the binary.
Indicates if this binary is not related to any package (true) or not (false).
Name of the binary.
Relative path of the binary inside the container.
Path for searching packages used by the binary.
Names of services which use the binary.
Version of the binary.
Stopped indicates whether the host was running during the agentless scan.
tags object[]
Tags associated with the given image.
Image digest (requires V2 or later registry).
ID of the image.
Registry name to which the image belongs.
Repository name to which the image belongs.
Image tag.
SHA256 of the image's last layer that is the last element of the Layers field.
trustResult object
ImageResult represents an aggregated image trust result
groups object[]
Trust groups which apply to the image.
Name of the group.
Indicates if the rule is currently disabled (true) or not (false).
Image names or IDs (e.g., docker.io/library/ubuntu:16.04 / SHA264@...).
Filesystem layers. The image is trusted if its layers have a prefix of the trusted groups layer in the same order.
Datetime when the rule was last modified.
Name of the rule.
Free-form text.
User who created or last modified the rule.
Previous name of the rule. Required for rule renaming.
hostsStatuses object[]
Image trust status on each host. Can be set to "trusted" or "untrusted".
Host name.
Possible values: [trusted,untrusted]
Status is the trust status for an image
Possible values: [trusted,untrusted]
Status is the trust status for an image
Indicates if the image is a Twistlock image (true) or not (false).
Possible values: [image,ciImage,container,host,agentlessHost,registry,serverlessScan,ciServerless,vm,tas,ciTas,cloudDiscovery,serverlessRadar,serverlessAutoDeploy,hostAutoDeploy,codeRepo,ciCodeRepo]
ScanType represents the scanning type performed
vulnerabilities object[]
CVE vulnerabilities of the image.
Rules applied on the package.
Names of the distro binary package names (packages which are built from the source of the package).
Indicates if the vulnerability has a block effect (true) or not (false).
Additional information regarding the root cause for the vulnerability.
Indicates if this is a CRI-specific vulnerability (true) or not (false).
Indicates if the vulnerability is a custom vulnerability (e.g., openscap, sandbox) (true) or not (false).
CVE ID of the vulnerability (if applied).
CVSS score of the vulnerability.
Description of the vulnerability.
Specifies the time of discovery for the vulnerability.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
exploits object[]
Exploits represents the exploits data found for a CVE
Possible values: [poc,in-the-wild]
ExploitKind represents the kind of the exploit
Link is a link to information about the exploit.
Possible values: [,exploit-db,exploit-windows,cisa-kev]
ExploitType represents the source of an exploit
Date/time when the vulnerability was fixed (in Unix time).
Link to the vendor's fixed-version information.
Specifies the serverless layer ID in which the vulnerability was discovered.
Number of grace days left for a vulnerability, based on the configured grace period. Nil if no block vulnerability rule applies.
ID of the violation.
Date/time of the image layer to which the CVE belongs.
Vendor link to the CVE.
Name of the package that caused the vulnerability.
Version of the package that caused the vulnerability (or null).
Date/time when the vulnerability was published (in Unix time).
riskFactors object
RiskFactors maps the existence of vulnerability risk factors
Textual representation of the vulnerability's severity.
Vendor status for the vulnerability.
Possible values: [PCI,HIPAA,NIST SP 800-190,GDPR,DISA STIG]
List of templates with which the vulnerability is associated.
Description of the violation.
Compliance title.
Indicates if this is a Twistlock-specific vulnerability (true) or not (false).
Possible values: [container,image,host_config,daemon_config,daemon_config_files,security_operations,k8s_master,k8s_worker,k8s_federation,linux,windows,istio,serverless,custom,docker_stig,openshift_master,openshift_worker,application_control_linux]
Type represents the vulnerability type
Textual representation of the metric values used to score the vulnerability.
vulnTagInfos object[]
Tag information for the vulnerability.
Color is a hexadecimal representation of color code value
Tag comment in a specific vulnerability context.
Name of the tag.
Total number of vulnerabilities.
vulnerabilityDistribution object
Distribution counts the number of vulnerabilities per type
.
.
.
.
.
Image's CVE risk score.
wildFireUsage object
Usage holds wildfire usage stats, period for the usage varies with context
Bytes is the total number of bytes uploaded to the WildFire API.
Queries is the number of queries to the WildFire API.
Uploads is the number of uploads to the WildFire API.
CI job name.
Indicates if the scan passed (true) or failed (false).
Time of the scan.
Scanner version.
Scan vulnerability failure summary.
Responses
- 200
- default
OK