---
title: "Retrieve an NVLink Domain"
method: GET
path: "/v2/org/{org}/nico/domain/nvlink/{id}"
tags: ["Domain"]
---

# Retrieve an NVLink Domain

`GET /v2/org/{org}/nico/domain/nvlink/{id}`

## Request

- Base URL: `https://nico-rest-api.nico.svc.cluster.local`
- URL: `https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/domain/nvlink/{id}`
- Auth: HTTP bearer

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

## Query parameters

- `includeComponents` boolean
- `siteId` string, uuid, required

## Response `200`

OK

- NVLinkDomain: NVLink Domain inventory and its components.
  - `id` string, required: Case-sensitive Domain external ID, equal to its rack group ID.
  - `rackGroupId` string, required: Rack group ID, identical to id.
  - `nmxcClusterId` string, uuid, nullable, required: 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.
  - `name` string, required: Domain display name. Empty for newly inventory-created Domains; inventory sync preserves existing names.
  - `topology` string, nullable, required: Common member-rack profile ID without the qualified vendor and optional _NO_POWERSHELF suffix. Null when unavailable, unrecognized, or inconsistent across member racks.
  - `operationStatus` string, required: Operability phase aggregated across member racks, not the Core lifecycle state.
  - `components` RackComponent[], nullable, required: Components belonging to this Domain. Null when includeComponents is false; an empty array when requested but none are known.
    - `id` string: Component ID
    - `rackId` string: ID of the Rack this component belongs to
    - `type` string: Type of the component (e.g. Compute, NVSwitch, PowerShelf)
    - `name` string: Name of the component
    - `serialNumber` string: Serial number of the component
    - `manufacturer` string: Manufacturer of the component
    - `model` string: Model of the component
    - `description` string: Description of the component (JSON string)
    - `firmwareVersion` string: Firmware version of the component
    - `slotId` integer: Slot ID of the component within the rack
    - `trayIdx` integer: Tray index of the component
    - `hostId` integer: Host ID of the component
    - `bmcs` BMCInfo[]: BMC (Baseboard Management Controller) entries for the component
      - `type` string: BMC type (e.g. BmcTypeHost, BmcTypeDpu)
      - `macAddress` string: MAC address of the BMC
      - `ipAddress` string: IP address of the BMC
    - `powerState` string: Current power state of the component
    - `operationStatus` 'Unknown' | 'Initializing' | 'Ready' | 'InUse' | 'Error' | 'Deleting': Flow-derived operability phase of the component
    - `leakStatus` 'Unknown' | 'NoLeak' | 'Leaking': Whether the component is considered leaking coolant
    - `leakHandlingStatus` 'Unknown' | 'None' | 'ShuttingDown' | 'Down' | 'Failed': Flow's leakage-handling status. Unknown means Flow could not determine the status; None means no supported handling task exists; ShuttingDown means a forced-shutdown task is waiting, pending, or running; Down means it completed; and Failed means the latest supported handling task failed or was terminated. Down describes handling progress, not the component's current power state.
    - `health` AggregateHealth, required: Describes an aggregate hardware health report and its probe results and alerts
      - `source` string, required: Describes how the health report was generated
      - `observedAt` string, date-time, nullable, required: Date/time when health report was generated
      - `successes` HealthProbeSuccess[], required: Results from successful health probes for the resource
        - `id` string, required: Health probe identifier
        - `target` string, nullable, required: Specific component targeted by health probe
      - `alerts` HealthProbeAlert[], required: Results from failed health probes for the resource
        - `id` string, required: Health probe identifier
        - `target` string, nullable, required: Specific component targeted by health probe
        - `inAlertSince` string, date-time, nullable, required: Date/time since the alert has been in effect
        - `message` string, required: Details of the failed health probe result
        - `tenantMessage` string, nullable, required: Information provided by Tenant, if any
        - `classifications` string[], required: Classifications for this alert, category or impact

## Other responses

- `400`: Error response when request data cannot be validated
- `403`: Error response when user is not authorized to call an endpoint or retrieve/modify objects
- `404`: Error response when requested object is not found
- `412`: Response when the API handler encounters an unexpected error
- `504`: The Site did not return a result within the request budget allocated to Site communication within the request cycle. This can occur if the Site Controller is down or under heavy request load. Operations are in general safe to retry. In rare cases, operations that create or update resources may succeed even if timeout is returned.

## Changes

- **2026-10-15** `293dc126ab73`: 5 info
  - removed the `nico` enum value from the `source` response property for the response status `400`
  - removed the `nico` enum value from the `source` response property for the response status `403`
  - removed the `nico` enum value from the `source` response property for the response status `404`
  - removed the `nico` enum value from the `source` response property for the response status `412`
  - …1 more
- **2026-10-01** `0b2823e8f92b`: 2 info
  - added the required property `nmxcClusterId` to the response with the `200` status
  - added the required property `rackGroupId` to the response with the `200` status
- **2026-09-30** `51b54c5d58d1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/changes/v2/org/:org/nico/domain/nvlink/:id/get.md)

---

[API](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/revisions/db15b7308121?raw)