/systems/{id}/inventory - Get system inventory history

GET /systems/{id}/inventory

Bearer auth

Get paginated inventory history for a specific system. Supports date range filtering.

Path parameters

id string Required

System ID

Query parameters

page integer

Page number

Minimum value is 1. Default value is 1.
page_size integer

Items per page

Minimum value is 1, maximum value is 100. Default value is 20.
from_date string(date-time)

Filter records from this date (RFC3339 format)
to_date string(date-time)

Filter records up to this date (RFC3339 format)

Responses

200 application/json

Inventory history retrieved successfully
Hide response attributes Show response attributes object
- code integer
- message string
- data object
  
  Hide data attributes Show data attributes object
  
  records array[object]
  
  A snapshot of a system's inventory data at a point in time
  
  Hide records attributes Show records attributes object
  
  id integer(int64)
  
  Auto-incrementing record ID
  
  system_id string
  
  ID of the system that sent the inventory
  
  timestamp string(date-time)
  
  When the inventory was collected on the system
  
  data object
  
  Complete raw inventory JSON. Contains the full system inventory payload (facts, modules, nodes, network, etc.). The structure varies by system type and can contain hundreds of fields.
  
  data_hash string
  
  SHA-256 hash of the inventory data for deduplication
  
  data_size integer(int64)
  
  Size of the inventory data in bytes
  
  processed_at string(date-time) | null
  
  When diff processing completed for this record. Null if not yet processed.
  
  has_changes boolean
  
  Whether changes were detected compared to the previous inventory
  
  change_count integer
  
  Number of significant changes detected
  
  created_at string(date-time)
  
  When the record was created in the database
  
  updated_at string(date-time)
  
  When the record was last updated
  
  pagination object
  
  Hide pagination attributes Show pagination attributes object
  
  page integer
  
  Current page number
  
  Minimum value is 1.
  
  page_size integer
  
  Number of items per page
  
  Minimum value is 1, maximum value is 100.
  
  total_count integer
  
  Total number of items
  
  Minimum value is 0.
  
  total_pages integer
  
  Total number of pages
  
  Minimum value is 0.
  
  has_next boolean
  
  Whether there is a next page
  
  has_prev boolean
  
  Whether there is a previous page
  
  next_page integer | null
  
  Next page number if available
  
  prev_page integer | null
  
  Previous page number if available
  
  sort_by string | null
  
  Field used for sorting
  
  sort_direction string | null
  
  Sort direction
  
  Values are asc or desc.
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
404 application/json

Resource not found
Hide response attributes Show response attributes object
- code integer
  
  HTTP error code
- message string
  
  Error message
- data object
  
  Hide data attributes Show data attributes object
  
  type string
  
  Type of error
  
  Values are validation_error or external_api_error.
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  key string
  
  Field name that failed validation
  
  message string
  
  Error code or message
  
  value string
  
  Value that failed validation
  
  details
  
  Additional error details

GET /systems/{id}/inventory

curl \
 --request GET 'https://collect.your-domain.com/api/systems/sys_123456789/inventory' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "code": 200,
  "message": "inventory history retrieved successfully",
  "data": {
    "records": [
      {
        "id": 42,
        "system_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "timestamp": "2026-02-20T14:30:00Z",
        "data": {
          "facts": {
            "distro": {
              "name": "NethServer",
              "version": "8.2.0"
            },
            "memory": {
              "total_bytes": 17179869184
            },
            "network": {
              "hostname": "ns8.example.com",
              "public_ip": "203.0.113.10"
            }
          }
        },
        "data_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "data_size": 24576,
        "processed_at": "2026-02-20T14:31:00Z",
        "has_changes": true,
        "change_count": 5,
        "created_at": "2026-02-20T14:30:05Z",
        "updated_at": "2026-02-20T14:31:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "page_size": 20,
      "total_count": 156,
      "total_pages": 8,
      "has_next": true,
      "has_prev": false,
      "next_page": 2,
      "prev_page": 42,
      "sort_by": "name",
      "sort_direction": "asc"
    }
  }
}

Response examples (401)

{
  "code": 401,
  "message": "invalid token",
  "data": {}
}

Response examples (403)

{
  "code": 403,
  "message": "insufficient permissions",
  "data": {}
}

Response examples (404)

{
  "code": 400,
  "message": "validation failed",
  "data": {
    "type": "validation_error",
    "errors": [
      {
        "key": "username",
        "message": "required",
        "value": "string"
      }
    ]
  }
}

/systems/{id}/inventory - Get system inventory history

Path parameters

Query parameters

Responses

Documentation preview