Get inventory report

View as Markdown
Get inventory report in JSON or CSV format. Default response is JSON. For CSV download, set format=csv. For a signed CSV bundle (CSV plus a cosign-verifiable signature, packaged as a zip), set format=csv and signed=true. Each node includes enrolledAt (original enrollment time, preserved across re-enrollment) and removedAt (soft-delete time for removed nodes, manual and auto-removed alike; absent for active nodes).

Query parameters

pageintegerOptionalDefaults to 0

Page number (Not used for CSV format)

pageSizeintegerOptionalDefaults to 10

Page size (Not used for CSV format)

formatenumOptionalDefaults to json

Response format (json or csv)

Allowed values:
signedbooleanOptionalDefaults to false

Sign the CSV with NVIDIA’s signing key and return a zip containing the CSV plus a .sig.bundle (cosign-verifiable Sigstore bundle). Only valid with format=csv.

computeZoneIdslist of stringsOptional
Filter by computezone IDs. Empty means all computezones
nodeGroupIdslist of stringsOptional
Filter by nodegroup IDs. Empty means all nodegroups
tagslist of stringsOptional
Filter by tags. Empty means all tags
startTimestringOptional

Start time for filtering nodes active during period (RFC3339 format, e.g., 2024-01-01T00:00:00Z)

endTimestringOptional

End time for filtering nodes active during period (RFC3339 format, e.g., 2024-12-31T23:59:59Z)

sortByenumOptionalDefaults to hostname
Field to sort by
orderenumOptionalDefaults to desc

Sort order (asc, desc)

Allowed values:

Response

JSON response (default). For CSV download, use format=csv query parameter. For signed CSV, use format=csv&signed=true (returns application/zip).

models.InventoryReportResponseobject
OR
string

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
499
Client Closed Request Error
500
Internal Server Error
503
Service Unavailable Error