/systems/{id}/inventory/changes - Get inventory changes summary

GET /systems/{id}/inventory/changes

Get an aggregated summary of all inventory changes for a specific system. Returns counts grouped by category and severity, not a paginated list.

Path parameters

  • id string Required

    System ID

Responses

  • 200 application/json

    Changes summary retrieved successfully. Returns null when no inventory is available (not an error condition).

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object

      Aggregated changes summary, or null if no inventory exists

      Hide data attributes Show data attributes object
      • system_id string

        ID of the system

      • total_changes integer

        Total number of changes across all inventory snapshots

      • recent_changes integer

        Number of changes in the most recent period

      • last_inventory_time string(date-time)

        Timestamp of the most recent inventory record

      • has_critical_changes boolean

        Whether any critical-severity changes exist

      • has_alerts boolean

        Whether any unresolved alerts exist for this system

      • changes_by_category object

        Count of changes grouped by category

        Hide changes_by_category attribute Show changes_by_category attribute object
        • * integer Additional properties
      • changes_by_severity object

        Count of changes grouped by severity

        Hide changes_by_severity attribute Show changes_by_severity attribute object
        • * integer Additional properties
  • 401 application/json

    Unauthorized - invalid or missing token

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
  • 403 application/json

    Forbidden - insufficient permissions

    Hide response attributes Show response attributes object
    • code integer
    • message string
    • data object | null
GET /systems/{id}/inventory/changes
curl \
 --request GET 'https://api.your-domain.com/api/systems/sys_123456789/inventory/changes' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "code": 200,
  "message": "changes summary retrieved successfully",
  "data": {
    "system_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "total_changes": 42,
    "recent_changes": 5,
    "last_inventory_time": "2026-02-20T14:30:00Z",
    "has_critical_changes": false,
    "has_alerts": true,
    "changes_by_category": {
      "os": 10,
      "network": 8,
      "hardware": 5,
      "security": 3
    },
    "changes_by_severity": {
      "low": 20,
      "high": 5,
      "medium": 15,
      "critical": 2
    }
  }
}
Response examples (401)
{
  "code": 401,
  "message": "invalid token",
  "data": {}
}
Response examples (403)
{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}

Documentation preview

will expire on March 11 at 09:31

This is a preview of your version @2026-03-04.