Get Global Scan Settings
GET/api/v32.07/settings/scan
x-prisma-cloud-target-env: {"permission":"systemOperations"}
Returns the global settings for image, host, container, and registry scanning.
cURL Request
Refer to the following example cURL request:
$ curl -k \
-u <USER> \
-H 'Content-Type: application/json' \
-X GET \
"https://<CONSOLE>/api/v<VERSION>/settings/scan"
Responses
- 200
- default
ScanSettings are global settings for image/host/container and registry scanning
- application/json
- Schema
- Example (from schema)
Schema
AgentlessScanPeriodMS is the agentless scan period in ms - validated for minimum 1 hour or disabled with zero.
CloudPlatformsScanPeriodMS is the cloud platforms scan period in ms - validated for minimum 1 hour or disabled with zero.
ContainersScanPeriodMS is the container scan period in ms - validated for minimum 1 hour or disabled with zero.
ExtractArchive indicates whether to search within archive during scan is enabled.
ImageScanPeriodMS is the image scan period in ms - validated for minimum 1 hour or disabled with zero.
IncludeJsDependencies indicates whether to include packages from the "dependencies".
RegistryScanPeriodMS is the registry scan period in ms - validated for minimum 1 hour or disabled with zero.
RegistryScanRetentionDays is the number of days to keep deleted registry images.
ScanRunningImages indicates only images that are used by containers should be used.
ServerlessScanPeriodMS is the serverless vulnerability scan period in ms - validated for minimum 1 hour or disabled with zero.
ShowInfraContainers indicates infra containers should be shown.
ShowNegligibleVulnerabilities indicates whether to display negligible vulnerabilities (low severity or will not be fixed).
SystemScanPeriodMS is the host scan period in ms - validated for minimum 1 hour or disabled with zero.
TASDropletsScanPeriodMS is the TAS scan period in ms - validated for minimum 1 hour or disabled with zero.
VMScanPeriodMS is the VM image scan period in ms - validated for minimum 1 hour or disabled with zero.
{
"agentlessScanPeriodMs": 0,
"cloudPlatformsScanPeriodMs": 0,
"containersScanPeriodMs": 0,
"extractArchive": true,
"imagesScanPeriodMs": 0,
"includeJsDependencies": true,
"registryScanPeriodMs": 0,
"registryScanRetentionDays": 0,
"scanRunningImages": true,
"serverlessScanPeriodMs": 0,
"showInfraContainers": true,
"showNegligibleVulnerabilities": true,
"systemScanPeriodMs": 0,
"tasDropletsScanPeriodMs": 0,
"vmScanPeriodMs": 0
}