---
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 — Unique UUID v4 identifier for the NVLinkInterface
  - `instanceId` string, uuid — ID of the associated Instance
  - `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 — Date/time when the NVLinkInterface was created
  - `updated` string, date-time — Date/time when the NVLinkInterface was last updated
  - `deprecations` Deprecation[] — Deprecations active for this resource. Returned only if there are active deprecations.
    - `attribute` string, nullable — Name of the attribute that is deprecated. Omitted if queryParam or endpoint is being deprecated.
    - `queryParam` string, nullable — Query parameter that is deprecated. Omitted if attribute or endpoint is being deprecated.
    - `endpoint` string, nullable — API endpoint that is deprecated. Omitted if attribute or queryParam is being deprecated.
    - `replacedBy` string, nullable — Name of the attribute, query parameter, or endpoint that replaces the deprecated item. Omitted if no replacement is available.
    - `takeActionBy` string, date-time — Date/time by which clients should migrate away from the deprecated API surface
    - `notice` string — Message describing the deprecation

## Other responses

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

---

[API](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api.md) · [All operations](https://skmtc.net/nvidia/apis/nvidia-infra-controller-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/nvidia-infra-controller-rest-api/revisions/69e00804e732/schema)