Allocation6

Audit2

BMC Credential1

Credential Rotation2

Domain6

DPU Extension Service7

DPU Machine2

Expected Machine11

Expected Power Shelf7

Expected Rack8

Expected Rack Group8

Expected Switch7

Host Firmware Config2

InfiniBand Partition6

Infrastructure Provider2

Instance10

Instance Type8

IP Block6

iPXE Template2

Machine25

Measured Boot Trusted Machine3

Measured Boot Trusted Profile3

Metadata1

Network Security Group5

NVLink Logical Partition6

Operating System5

Rack14

Rule5

Service Account1

Site6

Site Explorer2

SKU5

SpectrumX Partition4

SSH Key5

SSH Key Group5

Subnet5

Task3

Task Run8

Tenant4

Tenant Account5

Tenant Identity10

Tray12

UEFI Credential1

User1

VPC9

VPC Peering4

VPC Prefix5

Site

Retrieve Site

Changed on Oct 26, 2026

Retrieve a specific Site by ID.

User must have authorization role with PROVIDER_ADMIN or TENANT_ADMIN suffix.

Access is granted if:

The Site is owned by the org's Infrastructure Provider
The org's Tenant has an Allocation for Site
The org's Tenant is privileged and has Account with Site's Provider

get/v2/org/{org}/nico/site/{siteId}

Request

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

Response

idstring uuid

Unique UUID v4 identifier for the Site in NICo Cloud

namestring

Name of the Site

descriptionstring nullable

Optional description for the Site

orgstring

NGC organization ID of the Infrastructure Provider that owns the Site

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider that owns the Site

siteControllerVersionstring nullable

Version of the Site Controller software

siteAgentVersionstring nullable

Version of the Site Agent software

registrationTokenstring nullable

Token that can be used to register a Site. Value only exposed to Provider

registrationTokenExpirationstring date-time nullable

Date/time when registration token expires. Value only exposed to Provider

serialConsoleHostnamestring hostname nullable

Serial console hostname of the site controller

isSerialConsoleEnabledboolean

Indicates if Serial Console is enabled for the Site by the Provider

serialConsoleIdleTimeoutinteger nullable

Maximum idle time in seconds before Serial Console is disconnected

serialConsoleMaxSessionLengthinteger nullable

Maximum length of Serial Console session in seconds

isSerialConsoleSSHKeysEnabledboolean

Only visible to Tenant retrieving the Site. Indicates if Serial Console access using SSH Keys is enabled by Tenant

isOnlineboolean

Indicates if the Site is currently reachable from Cloud

status'Pending' | 'Registered' | 'Error'

Status values for Site objects

createdstring date-time

Date/time when the Site was created

updatedstring date-time

Date/time when the Site was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "San Jose Central 4",
  "description": "Datacenter serving the San Jose central region",
  "org": "qygdmg8oqik8",
  "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
  "siteControllerVersion": "0.1",
  "siteAgentVersion": "0.1",
  "registrationToken": "J7KO-89RR-Y7WQ-AD90",
  "registrationTokenExpiration": "2019-08-25T12:00:00Z",
  "serialConsoleHostname": "sjc.nico.acme.com",
  "isSerialConsoleEnabled": true,
  "serialConsoleIdleTimeout": 60,
  "serialConsoleMaxSessionLength": 3600,
  "isSerialConsoleSSHKeysEnabled": true,
  "machineStats": {
    "total": 15,
    "totalByStatus": {
      "Initializing": 0,
      "Ready": 7,
      "Reset": 0,
      "Maintenance": 0,
      "InUse": 3,
      "Error": 5,
      "Decommissioning": 0,
      "Decommissioned": 0,
      "Unknown": 0
    },
    "totalByHealth": {
      "healthy": 12,
      "unhealthy": 3
    },
    "totalByStatusAndHealth": {
      "Initializing": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Ready": {
        "healthy": 5,
        "unhealthy": 0
      },
      "Reset": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Maintenance": {
        "healthy": 5,
        "unhealthy": 0
      },
      "InUse": {
        "healthy": 3,
        "unhealthy": 0
      },
      "Error": {
        "healthy": 2,
        "unhealthy": 3
      },
      "Decommissioning": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Decommissioned": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Unknown": {
        "healthy": 0,
        "unhealthy": 0
      }
    },
    "totalByAllocation": {
      "allocatedInUse": 3,
      "allocatedNotInUse": 3,
      "unallocated": 5
    }
  },
  "gpuStats": [
    {
      "name": "NVIDIA GB200",
      "gpus": 64,
      "machines": 16
    }
  ],
  "capabilities": {
    "nativeNetworking": true,
    "networkSecurityGroup": true,
    "nvLinkPartition": false,
    "flow": true,
    "imageBasedOperatingSystem": false,
    "vpcSlaac": false,
    "dpsPowerManagement": false
  },
  "isOnline": false,
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "location": {
    "city": "San Jose",
    "state": "CA",
    "country": "USA"
  },
  "contact": {
    "email": "johndoe@nvidia.com"
  }
}

Changes

Oct 26, 202604bf8e76558f Revision changes
- info
  the response optional property / became read-only for the status
Oct 22, 20262c2e94eb87dc Revision changes
- breaking
  the response property became nullable for the status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  the response's property type changed from object to no type for status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status
- warning
  removed the optional property / from the response with the status

Operation history (8 revisions)

Retrieve Site

Request

Response 200OK

Example response

Changes

Response