Sign in
admin-inventory

List Nodes

List inventory nodes with their site/cluster/tenant/node-type assignment.

The import command uses this to preflight hostname collisions and to report drift. It passes names without siteId to find hostnames that are already registered at another site.

get/api/admin/inventory/nodes

Query parameters

siteIdstring nullable

Filter to nodes at this inventory site.

Filter to nodes at this inventory site.

clusterIdstring nullable

Filter to nodes ACTIVE-assigned to this inventory cluster.

Filter to nodes ACTIVE-assigned to this inventory cluster.

namesstring[] nullable

Exact node names to return. Repeat the parameter for each name (max 200).

Exact node names to return. Repeat the parameter for each name (max 200).

searchstring nullable

Case-insensitive substring match against node name or id.

Case-insensitive substring match against node name or id.

offsetinteger

Number of items to skip.

Number of items to skip.

limitinteger

Max items to return (1-100).

Max items to return (1-100).

Response

Successful Response

total_countinteger

Total number of items available in the dataset

offsetinteger

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

limitinteger

Maximum number of items to return

statusstring nullable

Response status

Changes