Retrieve Site

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/site/:siteId

GET

/v2/org/:org/nico/site/:siteId

curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/site/siteId \
     -H "Authorization: Bearer <token>"

{
  "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,
  "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"
  },
  "capabilities": {
    "nativeNetworking": true,
    "networkSecurityGroup": true,
    "nvLinkPartition": false,
    "flow": true,
    "imageBasedOperatingSystem": false,
    "vpcSlaac": false,
    "dpsPowerManagement": false
  },
  "machineStats": {
    "total": 15,
    "totalByStatus": {
      "Decommissioned": 0,
      "Decommissioning": 0,
      "Error": 5,
      "Initializing": 0,
      "InUse": 3,
      "Maintenance": 0,
      "Ready": 7,
      "Reset": 0,
      "Unknown": 0
    },
    "totalByHealth": {
      "healthy": 12,
      "unhealthy": 3
    },
    "totalByStatusAndHealth": {
      "Decommissioned": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Decommissioning": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Error": {
        "healthy": 2,
        "unhealthy": 3
      },
      "Initializing": {
        "healthy": 0,
        "unhealthy": 0
      },
      "InUse": {
        "healthy": 3,
        "unhealthy": 0
      },
      "Maintenance": {
        "healthy": 5,
        "unhealthy": 0
      },
      "Ready": {
        "healthy": 5,
        "unhealthy": 0
      },
      "Reset": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Unknown": {
        "healthy": 0,
        "unhealthy": 0
      }
    },
    "totalByAllocation": {
      "allocatedInUse": 3,
      "allocatedNotInUse": 3,
      "unallocated": 5
    }
  },
  "gpuStats": [
    {
      "name": "NVIDIA GB200",
      "gpus": 64,
      "machines": 16
    }
  ]
}

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

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired

Name of the Org

siteIdstringRequiredformat: "uuid"

ID of the Site

Response

idstringOptionalRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Site in NICo Cloud

namestringOptional2-256 characters

Name of the Site

descriptionstring or nullOptional

Optional description for the Site

orgstringOptional

NGC organization ID of the Infrastructure Provider that owns the Site

infrastructureProviderIdstringOptionalformat: "uuid"

ID of the Infrastructure Provider that owns the Site

siteControllerVersionstring or nullOptional

Version of the Site Controller software

siteAgentVersionstring or nullOptional

Version of the Site Agent software

registrationTokenstring or nullOptional

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

registrationTokenExpirationdatetime or nullOptionalRead-only

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

serialConsoleHostnamestring or nullOptionalformat: "hostname"

Serial console hostname of the site controller

isSerialConsoleEnabledbooleanOptional

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

serialConsoleIdleTimeoutinteger or nullOptional

Maximum idle time in seconds before Serial Console is disconnected

serialConsoleMaxSessionLengthinteger or nullOptional

Maximum length of Serial Console session in seconds

isSerialConsoleSSHKeysEnabledbooleanOptional

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

isOnlinebooleanOptional

Indicates if the Site is currently reachable from Cloud

statusenumOptional

Status of the Site

Allowed values:

statusHistorylist of objectsOptional

Chronological status history for the Site

createddatetimeOptional

Date/time when the Site was created

updateddatetimeOptional

Date/time when the Site was last updated

locationobject or nullOptional

Site location information. Null when unset

contactobject or nullOptional

Site contact information. Null when unset

capabilitiesobjectOptional

Site capabilities used for feature availability and configuration

machineStatsobject or nullOptional

Machine counts by status for the Site. Populated on Site list requests when includeMachineStats is true; null otherwise. Sites with no Machines or Allocations return zeroed statistics when requested

gpuStatslist of objects or nullOptional

GPU counts grouped by GPU type for the Site. Populated on Site list requests when includeGpuStats is true; null otherwise. Sites without GPUs return an empty array when requested

Errors

403

Forbidden Error