Skip to main content
ZStack
Security & Audit/Security

ScanAgentSafe

Perform a safe CVE scan that handles empty or corrupt rules gracefully.

POST/api/v1/security/cve/scan-safe

Operation ID

ScanAgentSafe

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • agentId
    StringRequired

    Unique identifier of the agent to scan safely

    Example: agent-abc123

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • findings
    List

    Vulnerability findings discovered during the scan

    Example: (nested array)

    • agentId
      String

      Unique identifier of the agent with this finding

      Example: agent-abc123

    • cveId
      String

      CVE identifier for the discovered vulnerability

      Example: CVE-2021-44228

    • severity
      String

      Severity level of the discovered vulnerability

      Example: CVE_SEVERITY_UNSPECIFIED

    • cvssScore
      Long

      CVSS score for the vulnerability finding

      Example: 9.8

    • affectedPackageName
      String

      Name of the package affected by this vulnerability

      Example: log4j-core

    • installedVersion
      String

      Version of the package currently installed on the agent

      Example: 2.14.1

    • fixVersion
      String

      Version that fixes this vulnerability

      Example: 2.17.0

    • isFixed
      Boolean

      Whether the vulnerability has been patched on this agent

      Example: false

    • scannedAt
      String

      Timestamp when this vulnerability was scanned

      Example: 2026-01-15T08:00:00Z

  • scanCompleted
    Boolean

    Whether the scan completed successfully without being aborted

    Example: true

  • packagesScanned
    Integer

    Number of packages evaluated during the scan

    Example: 120

  • note
    String

    Optional note describing scan state or any fallback behavior

    Example: Scan completed with degraded rules set