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

RecordInventory

Record agent software inventory for vulnerability scanning.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • agentIdStringRequired

    Unique identifier of the agent submitting inventory

Body Fields

  • agentIdStringRequired

    Unique identifier of the agent

    Example: agent-abc123

  • collectedAtStringRequired

    Timestamp when the inventory was collected

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

  • osNameStringRequired

    Operating system name on the agent host

    Example: Ubuntu

  • osVersionStringRequired

    Operating system version on the agent host

    Example: 22.04

  • packagesListRequired

    List of packages installed on the agent host

    Example: (nested array)

    • nameString

      Name of the installed package

      Example: log4j-core

    • versionString

      Installed version of the package

      Example: 2.14.1

Responses

200 OK

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

Endpoint

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

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

Operation ID

RecordInventory

Permalink

Request Example

curl -X POST '{host}/api/v1/security/agents/{agentId}/inventory' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"agentId":"agent-abc123","collectedAt":"2026-01-15T08:00:00Z","osName":"Ubuntu","osVersion":"22.04","packages":"(nested array)","runningServices":"item1,item2","agentVersion":"1.2.3"}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history