Skip to navigation
API ReferenceExpected Rack Group

Retrieve all Expected Rack Groups

View as Markdown

Retrieve all Expected Rack Groups.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also retrieve Expected Rack Groups if they have an account with the Site’s Infrastructure Provider (siteId query parameter is required for Tenants).

Authentication

AuthorizationBearer
export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired
Name of the Org

Query parameters

siteIdstringOptionalformat: "uuid"
ID of the Site to filter Expected Rack Groups by
includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional1-21474836
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptionalDefaults to CREATED_ASC

Ordering for pagination query. Defaults to CREATED_ASC, with ID ascending as the tie-breaker.

Response headers

X-PaginationstringOptional
Pagination result in JSON format

Response

OK
idstringOptionalRead-onlyformat: "uuid"

Unique identifier (UUID) for the Expected Rack Group

rackGroupIdstringOptionalRead-only

Operator-supplied identifier for the rack group (opaque string; UUID syntax is not required). Unique within a Site.

siteIdstringOptionalRead-onlyformat: "uuid"
ID of the Site the Expected Rack Group belongs to
siteobject or nullOptional

Site details when requested through includeRelation; otherwise null.

topologystringOptional

External group-level NVLink topology identifier.

protocolstring or nullOptional
Rack fabric protocol. Null only for declarations created before protocol became required.
rackslist of objectsOptional

Ordered racks and their devices. Arrays are always present, including empty lists. Rack IDs and device identity tuples are unique across the group, with case-sensitive comparison.

namestringOptional

Human-readable name of the Expected Rack Group

descriptionstringOptional

Human-readable description of the Expected Rack Group

labelsmap from strings to stringsOptional

User-defined key-value pairs for organizing and categorizing Expected Rack Groups. Well-known keys (chassis.*, location.*) are used to convey chassis identity and physical location.

createddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Rack Group was created
updateddatetimeOptionalRead-only
ISO 8601 datetime when the Expected Rack Group was last updated

Errors

400
Bad Request Error
403
Forbidden Error