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

# Retrieve all NVLink Logical Partitions

`GET /v2/org/{org}/nico/nvlink-logical-partition`

Retrieve all NVLink Logical Partitions for the org

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

## Query parameters

- `siteId` string, uuid
- `status` string
- `query` string
- `includeInterfaces` boolean
- `includeStats` boolean
- `includeVpcs` boolean
- `includeRelation` 'Site' | 'Tenant'
- `pageNumber` integer
- `pageSize` integer
- `orderBy` 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

## Response `200`

OK

- NVLinkLogicalPartition[]
  - `id` string, uuid — Unique ID of the NVLink Logical Partition
  - `name` string — Name of the NVLink Logical Partition
  - `description` string, nullable — Optional description of the NVLink Logical Partition
  - `siteId` string, uuid — ID of the Site the NVLink Logical Partition belongs to
  - `tenantId` string, uuid — ID of the Tenant the NVLink Logical Partition belongs to
  - `status` 'Pending' | 'Provisioning' | 'Configuring' | 'Ready' | 'Deleting' | 'Error' — Status values for NVLink Logical Partition objects
  - `statusHistory` StatusDetail[] — Details of status changes for the NVLink Logical Partition over time
    - `status` string — State of the associated entity at a particular time
    - `message` string, nullable — Description of the state and cause/remedy in case of error
    - `created` string, date-time — Date/time when the associated entity assumed the status
    - `updated` string, date-time — Date/time when the associated entity was last observed with this status
  - `nvLinkLogicalPartitionStats` NVLinkLogicalPartitionStats — GPU and Instance counts for an NVLink Logical Partition
    - `totalGpus` integer — Total number of GPUs associated with the NVLink Logical Partition
    - `totalDistinctInstances` integer — Total number of distinct Instances associated with the NVLink Logical Partition
  - `created` string, date-time — Date and time the NVLink Logical Partition was created
  - `updated` string, date-time — Date and time the NVLink Logical Partition was last updated

## 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/4c29fe59bd4e/schema)