shared.ScanSettings

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/main/json-schema/palo-alto-networks-shared-scan-settings-schema.json",
  "title": "shared.ScanSettings",
  "description": "ScanSettings are global settings for image/host/container and registry scanning",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/palo-alto-networks-settings-api-openapi.yml#/components/schemas/shared.ScanSettings",
  "properties": {
    "agentlessScanPeriodMs": {
      "description": "AgentlessScanPeriodMS is the agentless scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "cloudPlatformsScanPeriodMs": {
      "description": "CloudPlatformsScanPeriodMS is the cloud platforms scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "containersScanPeriodMs": {
      "description": "ContainersScanPeriodMS is the container scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "extractArchive": {
      "description": "ExtractArchive indicates whether to search within archive during scan is enabled.\n",
      "type": "boolean"
    },
    "imagesScanPeriodMs": {
      "description": "ImageScanPeriodMS is the image scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "includeJsDependencies": {
      "description": "IncludeJsDependencies indicates whether to include packages from the \"dependencies\".\n",
      "type": "boolean"
    },
    "registryScanPeriodMs": {
      "description": "RegistryScanPeriodMS is the registry scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "registryScanRetentionDays": {
      "description": "RegistryScanRetentionDays is the number of days to keep deleted registry images.\n",
      "type": "integer"
    },
    "scanRunningImages": {
      "description": "ScanRunningImages indicates only images that are used by containers should be used.\n",
      "type": "boolean"
    },
    "serverlessScanPeriodMs": {
      "description": "ServerlessScanPeriodMS is the serverless vulnerability scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "showInfraContainers": {
      "description": "ShowInfraContainers indicates infra containers should be shown.\n",
      "type": "boolean"
    },
    "showNegligibleVulnerabilities": {
      "description": "ShowNegligibleVulnerabilities indicates whether to display negligible vulnerabilities (low severity or will not be fixed).\n",
      "type": "boolean"
    },
    "systemScanPeriodMs": {
      "description": "SystemScanPeriodMS is the host scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "tasDropletsScanPeriodMs": {
      "description": "TASDropletsScanPeriodMS is the TAS scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    },
    "vmScanPeriodMs": {
      "description": "VMScanPeriodMS is the VM image scan period in ms - validated for minimum 1 hour or disabled with zero.\n",
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}