Get inventory report

View as Markdown
Get an agent-source-specific inventory report in JSON or CSV format. agentType=inband preserves the existing GPU/OS inventory shape; agentType=oob returns the shared report fields plus nodeName, bmcHostname, and bmcIP. 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). JSON responses include the preferred location and verification-check fields plus the deprecated geoLocation/integrityCheck aliases for backward compatibility. CSV and signed ZIP report columns are unchanged.

Query parameters

pageintegerOptionalDefaults to 0

Page number (0-indexed). 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.

agentTypeenumOptionalDefaults to inband

Inventory source: inband (default) or oob. The JSON and CSV fields are source-specific.

Allowed values:
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)

sortByenumOptional

Field to sort by. In-band fields: hostname, gpuType, gpuCount, publicIP, privateIP. OOB fields: nodeName, bmcHostname, bmcIP. Shared fields: nodeUUID, nodeGroup, computeZone, verificationCheck, location. integrityCheck and geoLocation remain deprecated aliases. Defaults to hostname for inband and bmcHostname for oob.

orderenumOptionalDefaults to desc

Sort order (asc, desc)

Allowed values:

Response

OOB JSON response (agentType=oob). CSV responses use a source-specific header; signed CSV returns application/zip.

models.InbandInventoryReportResponseobject
OR
models.OobInventoryReportResponseobject

Errors

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