--- 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 parameter 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 - `includeGpuStats` 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 — Unique UUID v4 identifier for the Site in NICo Cloud - `name` string — Name of the Site - `description` string, nullable — Optional description for the Site - `org` string — NGC organization ID of the Infrastructure Provider that owns the Site - `infrastructureProviderId` string, uuid — ID of the Infrastructure Provider that owns the Site - `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 — Serial console hostname of the site controller - `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[] — Chronological status history for the Site - `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 — Date/time when the Site was created - `updated` string, date-time — Date/time when the Site was last updated - `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 — Whether the Site supports native networking - `networkSecurityGroup` boolean — Whether the Site supports Network Security Groups - `nvLinkPartition` boolean — Whether the Site supports NVLink partitioning - `flow` boolean — Whether the Site supports Flow-based operations - `imageBasedOperatingSystem` boolean — Whether the Site supports image-based operating system provisioning - `machineStats` SiteMachineStats — Machine stats for a Site - `total` integer — Total number of Machines at the Site - `totalByStatus` SiteMachineStatsByStatus — Machine stats for a Site by status - `Decommissioned` integer — Number of Machines in Decommissioned status - `Error` integer — Number of Machines in Error status - `Initializing` integer — Number of Machines in Initializing status - `InUse` integer — Number of Machines in InUse status - `Maintenance` integer — Number of Machines in Maintenance status - `Ready` integer — Number of Machines in Ready status - `Reset` integer — Number of Machines in Reset status - `Unknown` integer — Number of Machines in Unknown status - `totalByHealth` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `totalByStatusAndHealth` SiteMachineStatsByStatusAndHealth — Machine stats for a Site by status and health - `Decommissioned` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Error` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Initializing` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `InUse` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Maintenance` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Ready` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Reset` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `Unknown` SiteMachineStatsByHealth — Machine stats for a Site by health - `healthy` integer — Number of healthy Machines - `unhealthy` integer — Number of unhealthy Machines - `totalByAllocation` SiteMachineStatsByAllocation — Machine stats for a Site by allocation - `allocatedInUse` integer — Number of allocated Machines currently in use - `allocatedNotInUse` integer — Number of allocated Machines not currently in use - `unallocated` integer — Number of Machines not currently allocated - `gpuStats` MachineGPUStats[] — GPU counts grouped by GPU type for the Site. Populated when includeGpuStats is set - `name` string — GPU name from the MachineCapability record - `gpus` integer — Total number of GPUs (summation of all Machine GPU capability counts) - `machines` integer — Number of machines that have this GPU capability ## 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/versions/69e00804e732/schema)