Sign in
Site

Retrieve all Sites

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.

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

Query parameters

infrastructureProviderIdstring uuid

Filter Sites by Infrastructure Provider ID. Deprecated: Infrastructure Provider is now inferred from the org's membership.

tenantIdstring uuid

Filter Sites by Tenant ID. Deprecated: Tenant is now inferred from the org's membership.

statusstring

Filter Sites by Status. Can be specified multiple times to filter on more than one status

isNativeNetworkingEnabledboolean

Filter Sites by native networking enabled flag. Requires Provider Admin role.

isNetworkSecurityGroupEnabledboolean

Filter Sites by network security group enabled flag. Requires Provider Admin role.

isNVLinkPartitionEnabledboolean

Filter Sites by NVLink partitioning enabled flag. Requires Provider Admin role.

isFlowEnabledboolean

Filter Sites by NICo Flow enabled flag. Requires Provider Admin role.

includeMachineStatsboolean

Include a breakdown of Machine counts by lifecycle status and health. Requires Provider Admin role.

includeGpuStatsboolean

Include a per-Site breakdown of GPU counts grouped by GPU type. Requires Provider Admin role.

querystring

Search for matches across all Sites. Input will be matched against name, description, location, contact, and status fields

includeRelation'InfrastructureProvider'

Related entity to expand

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

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'

Ordering for pagination query

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

Changed in 6 of the 90 revisions of this API.18

  • 9c78a8936b341See the full diff
    • ○

      added the optional property items/capabilities/dpsPowerManagement to the response with the 200 status

      response-optional-property-added

  • 5c6bffda4e242See the full diff
    • ○

      added the optional property items/machineStats/totalByStatus/Decommissioning to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/machineStats/totalByStatusAndHealth/Decommissioning to the response with the 200 status

      response-optional-property-added

  • a482c2d8f5e21See the full diff
    • ○

      added the optional property items/capabilities/vpcSlaac to the response with the 200 status

      response-optional-property-added

  • c459c6587dee1See the full diff
    • ●

      for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

  • 45b1bd09c55c2See the full diff
    • ○

      query request parameter infrastructureProviderId was deprecated

      request-parameter-deprecated

    • ○

      query request parameter tenantId was deprecated

      request-parameter-deprecated

  • 3ff50f4d9fbc2See the full diff
    • ○

      added the new optional query request parameter includeGpuStats

      new-optional-request-parameter

    • ○

      added the optional property items/gpuStats to the response with the 200 status

      response-optional-property-added