Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Site

Update Site

Update a specific Site

User must have authorization role with PROVIDER_ADMIN suffix.

Infrastructure Provider updating the Site must be the owner of the Site. At present, there are no other Site-specific configurations modifiable by Tenant.

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

Request body

namestring nullable

Update name of the Site. Can only be updated by Provider

descriptionstring nullable

Update description for the Site. Can only be updated by Provider

renewRegistrationTokenboolean

Set to true to issue a new registration token. Can only be updated by Provider

serialConsoleHostnamestring hostname nullable

Hostname to reach Serial Console for the Site. Can only be updated by Provider

isSerialConsoleEnabledboolean

Enable/disable Serial Console. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

serialConsoleIdleTimeoutinteger

Maximum idle time in seconds before Serial Console is disconnected. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

serialConsoleMaxSessionLengthinteger

Maximum length of Serial Console session in seconds. Can only be updated by Provider. Modifying this attribute has no actual effect on SOL. It will be removed in a future API version.

isSerialConsoleSSHKeysEnabledboolean

Enable/disable Serial Console access using SSH Keys. Previously updateable only by Tenants, modifying this value is no longer supported, update SSH Key Groups to remove Site instead.

Example request

{
  "name": "sjc04",
  "description": "Datacenter 4 serving central San Jose",
  "renewRegistrationToken": true,
  "serialConsoleHostname": "sol.nico.acme.com",
  "location": {
    "city": "San Jose",
    "state": "CA",
    "country": "USA"
  },
  "contact": {
    "email": "johndoe@nvidia.com"
  }
}

Response

OK

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,
      "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
      },
      "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": false,
    "imageBasedOperatingSystem": 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"
  }
}