Skip to main content
GET
List Nodes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

siteId
string | null

Filter to nodes at this inventory site.

clusterId
string | null

Filter to nodes ACTIVE-assigned to this inventory cluster.

search
string | null

Case-insensitive substring match against node name.

offset
integer
default:0

Number of items to skip.

Required range: x >= 0
limit
integer
default:50

Max items to return (1-100).

Required range: 1 <= x <= 100

Response

Successful Response

data
InventoryNodeSummary · object[]
required
total_count
integer
default:0

Total number of items available in the dataset

offset
integer
default:0

Number of items to skip before starting to collect the result set

Required range: x >= 0
limit
integer
default:100

Maximum number of items to return

Required range: x >= 0
status
string | null

Response status