Skip to main content
ZStack
Security & Audit/Security

RecordInventory

Record agent software inventory for vulnerability scanning.

POST/api/v1/security/agents/{agentId}/inventory

Operation ID

RecordInventory

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

Path Parameters

  • agentId
    StringRequired

    Unique identifier of the agent submitting inventory

Body Fields

  • agentId
    StringRequired

    Unique identifier of the agent

    Example: agent-abc123

  • collectedAt
    StringRequired

    Timestamp when the inventory was collected

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

  • osName
    StringRequired

    Operating system name on the agent host

    Example: Ubuntu

  • osVersion
    StringRequired

    Operating system version on the agent host

    Example: 22.04

  • packages
    ListRequired

    List of packages installed on the agent host

    Example: (nested array)

    • name
      String

      Name of the installed package

      Example: log4j-core

    • version
      String

      Installed version of the package

      Example: 2.14.1

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.