Palo Alto Networks · Schema

ScanStatus

ScanStatus schema from Palo Alto Networks Prisma Cloud Code Security API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
scan_id string Unique scan identifier.
repositoryId string Repository that was scanned.
branch string Branch that was scanned.
status string Current scan status.
startTime string Scan start timestamp.
endTime string Scan completion timestamp.
scanTypes array Types of scans included in this run.
summary object High-level scan result summary. Available after completion.
View JSON Schema on GitHub

JSON Schema

prisma-cloud-code-security-api-scan-status-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ScanStatus",
  "description": "ScanStatus schema from Palo Alto Networks Prisma Cloud Code Security API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/prisma-cloud-code-security-api-scan-status-schema.json",
  "type": "object",
  "properties": {
    "scan_id": {
      "type": "string",
      "description": "Unique scan identifier."
    },
    "repositoryId": {
      "type": "string",
      "description": "Repository that was scanned."
    },
    "branch": {
      "type": "string",
      "description": "Branch that was scanned."
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "completed",
        "failed"
      ],
      "description": "Current scan status."
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "description": "Scan start timestamp."
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "description": "Scan completion timestamp."
    },
    "scanTypes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "iac",
          "sca",
          "secrets",
          "cicd"
        ]
      },
      "description": "Types of scans included in this run."
    },
    "summary": {
      "type": "object",
      "description": "High-level scan result summary. Available after completion.",
      "properties": {
        "filesScanned": {
          "type": "integer"
        },
        "resourcesScanned": {
          "type": "integer"
        },
        "errorsBySeverity": {
          "type": "object",
          "properties": {
            "critical": {
              "type": "integer"
            },
            "high": {
              "type": "integer"
            },
            "medium": {
              "type": "integer"
            },
            "low": {
              "type": "integer"
            },
            "info": {
              "type": "integer"
            }
          }
        }
      }
    }
  }
}