Skip to main content
API Explorer|API Explorer
Security & Audit/Security
POSTSecuritySince 1.0SynchronousAuth Required

ScanAgentSafe

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • agentIdStringRequired

    Unique identifier of the agent to scan safely

    Example: agent-abc123

Responses

200 OK

On success, this API returns the following response structure.

  • findingsList

    Vulnerability findings discovered during the scan

    Example: (nested array)

    • agentIdString

      Unique identifier of the agent with this finding

      Example: agent-abc123

    • cveIdString

      CVE identifier for the discovered vulnerability

      Example: CVE-2021-44228

    • severityString

      Severity level of the discovered vulnerability

      Example: CVE_SEVERITY_UNSPECIFIED

    • cvssScoreLong

      CVSS score for the vulnerability finding

      Example: 9.8

    • affectedPackageNameString

      Name of the package affected by this vulnerability

      Example: log4j-core

    • installedVersionString

      Version of the package currently installed on the agent

      Example: 2.14.1

    • fixVersionString

      Version that fixes this vulnerability

      Example: 2.17.0

    • isFixedBoolean

      Whether the vulnerability has been patched on this agent

      Example: false

    • scannedAtString

      Timestamp when this vulnerability was scanned

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

  • scanCompletedBoolean

    Whether the scan completed successfully without being aborted

    Example: true

  • packagesScannedInteger

    Number of packages evaluated during the scan

    Example: 120

  • noteString

    Optional note describing scan state or any fallback behavior

    Example: Scan completed with degraded rules set

Endpoint

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

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

Operation ID

ScanAgentSafe

Permalink

Request Example

curl -X POST '{host}/api/v1/security/cve/scan-safe' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"agentId":"agent-abc123"}'

Response Example

200
{
  "findings": [
    {}
  ],
  "scanCompleted": true,
  "packagesScanned": 120,
  "note": "Scan completed with degraded rules set"
}

Change History

This API has no change history records yet.

View all change history