---
title: "Retrieve all NVLink Interfaces"
method: GET
path: "/v2/org/{org}/nico/nvlink-interface"
tags: ["NVLink Logical Partition"]
---

# Retrieve all NVLink Interfaces

`GET /v2/org/{org}/nico/nvlink-interface`

Get all NVLink Interfaces

Org must have a Tenant entity. User must have authorization role with `TENANT_ADMIN` suffix.

## Query parameters

- `status` string
- `siteId` string
- `instanceId` string
- `nvLinkLogicalPartitionId` string
- `nvLinkDomainId` string
- `includeRelation` 'Instance' | 'NVLinkLogicalPartition'
- `pageNumber` integer
- `pageSize` integer
- `orderBy` 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

## Response `200`

OK

- NVLinkInterface[]
  - `id` string, uuid
  - `instanceId` string, uuid
  - `nvLinkLogicalPartitionId` string, uuid — ID of the NVLink Logical Partition associated with this interface
  - `nvLinkDomainId` string, uuid, nullable — ID of the NVLink Domain associated with this Interface
  - `deviceInstance` integer — Index of the device, used to identify the GPU associated with this Interface
  - `gpuGuid` string, nullable — Unique ID of the GPU
  - `status` 'Pending' | 'Provisioning' | 'Ready' | 'Deleting' | 'Error' — Status values for NVLink Interface objects
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `403` — Error response when user is not authorized to call an endpoint or retrieve/modify objects

---

[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-service-production.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/c8ea33c2b23f/schema)