---
title: "Retrieve all SpectrumX Partitions"
method: GET
path: "/v2/org/{org}/nico/spectrumx-partition"
tags: ["SpectrumX Partition"]
---

# Retrieve all SpectrumX Partitions

`GET /v2/org/{org}/nico/spectrumx-partition`

## Request

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

Retrieve all SpectrumX 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` 'Pending' | 'Provisioning' | 'Ready' | 'Error' | 'Deleting'
- `query` string
- `includeRelation` 'Site' | 'Tenant'
- `pageNumber` integer: One-indexed page number.
- `pageSize` integer
- `orderBy` 'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC'

## Response `200`

OK

- SpectrumXPartition[]
  - `id` string, uuid, required: Unique UUID v4 identifier for the SpectrumX Partition
  - `name` string, required: Name of the SpectrumX Partition
  - `description` string, nullable: Description of the SpectrumX Partition
  - `siteId` string, uuid, required: ID of the Site the Partition belongs to
  - `site` SiteSummary: SiteSummary contains a subset of data for Site object, used when nesting in other objects
    - `id` string, uuid: Unique UUID v4 identifier for the Site
    - `name` string: Name of the Site
    - `infrastructureProviderId` string, uuid: ID of the Infrastructure Provider that owns the Site
    - `isSerialConsoleEnabled` boolean: Indicates if Serial Console is enabled for the Site by the Provider
    - `isOnline` boolean: Indicates if the Site is currently reachable from Cloud
    - `capabilities` SiteCapabilities: Boolean flags to indicate features supported by a Site
      - `nativeNetworking` boolean: Whether the Site supports native networking
      - `networkSecurityGroup` boolean: Whether the Site supports Network Security Groups
      - `nvLinkPartition` boolean: Whether the latest successfully stored Site configuration inventory reports that NVLink partitioning is enabled in the Site's Core configuration. False also represents a new Site that has not reported Site configuration inventory yet. An inventory report from an older Core that omits the setting leaves the stored value unchanged. This value is managed by Site configuration inventory and cannot be updated through the Site API.
      - `flow` boolean: Whether the Site supports Flow-based operations
      - `imageBasedOperatingSystem` boolean: Whether the Site supports image-based operating system provisioning
      - `vpcSlaac` boolean: Whether the latest successfully stored Site configuration inventory reports that Core supports VPCs with SLAAC enabled. False also represents a missing Site configuration or an inventory report that omits the capability. This value is managed by Site configuration inventory and cannot be updated through the Site API.
      - `dpsPowerManagement` boolean: Whether this Site accepts non-empty power resource groups and power profiles for DPS power management. When false, omission and explicit clearing remain allowed.
    - `status` 'Pending' | 'Registered' | 'Error': Status values for Site objects
  - `tenantId` string, uuid, required: ID of the Tenant that owns the Partition
  - `tenant` TenantSummary: Summarizes a Tenant
    - `org` string: Name of the org this tenant belongs to
    - `orgDisplayName` string, nullable: Display name of the org the Tenant belongs to
    - `capabilities` TenantCapabilities: Deprecated tenant-wide capability summary. TargetedInstanceCreation is no longer stored on the Tenant entity; it is configured on Tenant Account `siteCapabilities` (and may be overridden per Site via Tenant Site configuration). On GET `/tenant/current`, `targetedInstanceCreation` is present and `true` only when the Tenant has at least one Ready Tenant Account, every Ready Tenant Account has the capability enabled by default, and no Tenant Site explicitly disables it. Otherwise the property is omitted. Embedded `TenantSummary.capabilities` objects in nested resources also omit the property.
      - `targetedInstanceCreation` boolean: Deprecated in favor of TenantAccount.siteCapabilities. On GET `/tenant/current`, the property is present and true only when every Ready Tenant Account enables TargetedInstanceCreation and no Tenant Site explicitly disables it; otherwise it is omitted. It is also omitted from embedded TenantSummary objects.
    - `deprecations` Deprecation[]: Deprecation notices for Tenant fields
      - `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
  - `vni` integer, nullable: VXLAN Network Identifier for the Partition. Allocated by the Site when the create request omits it
  - `labels` Labels: Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.
  - `status` 'Pending' | 'Provisioning' | 'Ready' | 'Error' | 'Deleting', required: Status of the SpectrumX Partition. A Partition becomes Ready once the Site reports it in inventory
  - `statusHistory` StatusDetail[]: Status detail records for the SpectrumX 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
  - `created` string, date-time: ISO datetime string for when the SpectrumX Partition was created
  - `updated` string, date-time: ISO datetime string for when the SpectrumX Partition was last updated

## Other responses

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

## Changes

- **2026-10-26** `04bf8e76558f`: 1 info
  - the response optional property `items/site/capabilities/nvLinkPartition` became read-only for the status `200`
- **2026-10-15** `293dc126ab73`: 1 info
  - removed the `nico` enum value from the `source` response property for the response status `403`
- **2026-09-29** `78f3b35615a5`: 1 info
  - added the optional property `retryable` to the response with the `403` status
- **2026-09-15** `cae9abe1b3da`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nvidia/apis/nvidia-infra-controller-rest-api/changes/v2/org/:org/nico/spectrumx-partition/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)