Skip to navigation
API ReferenceDomain

Retrieve an NVLink Domain

View as Markdown

Retrieve an NVLink Domain for a Flow-enabled Site. Requires an Infrastructure Provider and the PROVIDER_ADMIN role. Set includeComponents=true to include components.

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
idstringRequiredformat: "\S">=1 character

Case-sensitive NVLink Domain ID

Query parameters

includeComponentsbooleanOptionalDefaults to false
Include component details in the response.
siteIdstringRequiredformat: "uuid"
ID of the Site

Response

OK
idstring

Case-sensitive Domain external ID, equal to its rack group ID.

rackGroupIdstring
Rack group ID, identical to id.
nmxcClusterIdstring or nullformat: "uuid"

NMX-C cluster UUID observed on the group’s switches. Null when no valid observation is available. Conflicting observations are logged and preserve the last valid cluster without interrupting inventory sync.

namestring

Domain display name. Empty for newly inventory-created Domains; inventory sync preserves existing names.

topologystring or null

Common member-rack profile ID without the qualified vendor and optional _NO_POWERSHELF suffix. Null when unavailable, unrecognized, or inconsistent across member racks.

operationStatusstring
Operability phase aggregated across member racks, not the Core lifecycle state.
componentslist of objects or null

Components belonging to this Domain. Null when includeComponents is false; an empty array when requested but none are known.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
504
Gateway Timeout Error