---
title: "Retrieve all Sites"
method: GET
path: "/v2/org/{org}/nico/site"
tags: ["Site"]
---

# Retrieve all Sites

`GET /v2/org/{org}/nico/site`

Retrieve all Sites for org.

User must have authorization role with `PROVIDER_ADMIN` or `TENANT_ADMIN` suffix. `infrastructureProviderId` or `tenantId` query param may be required for older API versions.

## Query parameters

- `infrastructureProviderId` string, uuid
- `tenantId` string, uuid
- `status` string
- `isNativeNetworkingEnabled` boolean
- `isNetworkSecurityGroupEnabled` boolean
- `isNVLinkPartitionEnabled` boolean
- `isFlowEnabled` boolean
- `includeMachineStats` boolean
- `query` string
- `includeRelation` 'InfrastructureProvider'
- `pageNumber` integer
- `pageSize` integer
- `orderBy` 'NAME_ASC' | 'NAME_DESC' | 'STATUS_ASC' | 'STATUS_DESC' | 'CREATED_ASC' | 'CREATED_DESC' | 'UPDATED_ASC' | 'UPDATED_DESC' | 'DESCRIPTION_ASC' | 'DESCRIPTION_DESC' | 'LOCATION_ASC' | 'LOCATION_DESC' | 'CONTACT_ASC' | 'CONTACT_DESC'

## Response `200`

OK

- Site[]
  - `id` string, uuid
  - `name` string — Name of the Site
  - `description` string, nullable — Optional description for the Site
  - `org` string
  - `infrastructureProviderId` string, uuid
  - `siteControllerVersion` string, nullable — Version of the Site Controller software
  - `siteAgentVersion` string, nullable — Version of the Site Agent software
  - `registrationToken` string, nullable — Token that can be used to register a Site. Value only exposed to Provider
  - `registrationTokenExpiration` string, date-time, nullable — Date/time when registration token expires. Value only exposed to Provider
  - `serialConsoleHostname` string, hostname, nullable
  - `isSerialConsoleEnabled` boolean — Indicates if Serial Console is enabled for the Site by the Provider
  - `serialConsoleIdleTimeout` integer, nullable — Maximum idle time in seconds before Serial Console is disconnected
  - `serialConsoleMaxSessionLength` integer, nullable — Maximum length of Serial Console session in seconds
  - `isSerialConsoleSSHKeysEnabled` boolean — Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant
  - `isOnline` boolean — Indicates if the Site is currently reachable from Cloud
  - `status` 'Pending' | 'Registered' | 'Error' — Status values for Site objects
  - `statusHistory` StatusDetail[]
    - `status` string
    - `message` string, nullable
    - `created` string, date-time
    - `updated` string, date-time
  - `created` string, date-time
  - `updated` string, date-time
  - `location` SiteLocation — Location of the Site
    - `city` string — City where the site is located
    - `state` string — State where the site is located
    - `country` string — Country where the site is located
  - `contact` SiteContact — Contact for the Site
    - `email` string — Email address of the Site contact
  - `capabilities` SiteCapabilities — Boolean flags to indicate features supported by a Site
    - `nativeNetworking` boolean
    - `networkSecurityGroup` boolean
    - `nvLinkPartition` boolean
    - `flow` boolean
    - `imageBasedOperatingSystem` boolean
  - `machineStats` SiteMachineStats — Machine stats for a Site
    - `total` integer
    - `totalByStatus` SiteMachineStatsByStatus — Machine stats for a Site by status
      - `Decommissioned` integer
      - `Error` integer
      - `Initializing` integer
      - `InUse` integer
      - `Maintenance` integer
      - `Ready` integer
      - `Reset` integer
      - `Unknown` integer
    - `totalByHealth` SiteMachineStatsByHealth — Machine stats for a Site by health
      - `healthy` integer
      - `unhealthy` integer
    - `totalByStatusAndHealth` SiteMachineStatsByStatusAndHealth — Machine stats for a Site by status and health
      - `Decommissioned` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Error` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Initializing` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `InUse` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Maintenance` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Ready` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Reset` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
      - `Unknown` SiteMachineStatsByHealth — Machine stats for a Site by health
        - `healthy` integer
        - `unhealthy` integer
    - `totalByAllocation` SiteMachineStatsByAllocation — Machine stats for a Site by allocation
      - `allocatedInUse` integer
      - `allocatedNotInUse` integer
      - `unallocated` integer

## 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.dev/nvidia/apis/nvidia-infra-controller-rest-api/revisions/c8ea33c2b23f?raw)