Retrieve Site | NVIDIA Infra Controller

curl https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/site/siteId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "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": "1.2.3",
  "siteAgentVersion": "1.2.3",
  "registrationToken": "J7KO-89RR-Y7WQ-AD90",
  "registrationTokenExpiration": "2024-12-31T23:59:59Z",
  "serialConsoleHostname": "sjc.carbide.acme.com",
  "isSerialConsoleEnabled": true,
  "serialConsoleIdleTimeout": 300,
  "serialConsoleMaxSessionLength": 7200,
  "isSerialConsoleSSHKeysEnabled": true,
  "isOnline": true,
  "status": "Registered",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2024-01-10T08:00:00Z",
      "updated": "2024-01-10T08:00:00Z"
    },
    {
      "status": "Registered",
      "message": "Site successfully registered and operational",
      "created": "2024-01-15T12:00:00Z",
      "updated": "2024-01-15T12:00:00Z"
    }
  ],
  "created": "2024-01-10T08:00:00Z",
  "updated": "2024-04-20T10:30:00Z",
  "location": {
    "city": "San Jose",
    "state": "CA",
    "country": "USA"
  },
  "contact": {
    "email": "infra-support@acme.com"
  },
  "capabilities": {
    "nativeNetworking": true,
    "networkSecurityGroup": true,
    "nvLinkPartition": false,
    "rackLevelAdministration": false,
    "imageBasedOperatingSystem": false
  },
  "machineStats": {
    "total": 15,
    "totalByStatus": {
      "Decommissioned": 0,
      "Error": 2,
      "Initializing": 1,
      "InUse": 4,
      "Maintenance": 1,
      "Ready": 7,
      "Reset": 0,
      "Unknown": 0
    },
    "totalByHealth": {
      "healthy": 13,
      "unhealthy": 2
    },
    "totalByStatusAndHealth": {
      "Decommissioned": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Error": {
        "healthy": 1,
        "unhealthy": 1
      },
      "Initializing": {
        "healthy": 1,
        "unhealthy": 0
      },
      "InUse": {
        "healthy": 4,
        "unhealthy": 0
      },
      "Maintenance": {
        "healthy": 1,
        "unhealthy": 0
      },
      "Ready": {
        "healthy": 6,
        "unhealthy": 1
      },
      "Reset": {
        "healthy": 0,
        "unhealthy": 0
      },
      "Unknown": {
        "healthy": 0,
        "unhealthy": 0
      }
    },
    "totalByAllocation": {
      "allocatedInUse": 4,
      "allocatedNotInUse": 3,
      "unallocated": 8
    }
  }
}

Retrieve a specific Site by ID.

User must have FORGE_PROVIDER_ADMIN or FORGE_TENANT_ADMIN role.

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

Retrieve a specific Site by ID. User must have `FORGE_PROVIDER_ADMIN` or `FORGE_TENANT_ADMIN` role. 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current

``` 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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

siteIdstringRequired

Response

idstringRead-onlyformat: "uuid"

namestring2-256 characters

Name of the Site

descriptionstring

Optional description for the Site

orgstring

infrastructureProviderIdstringformat: "uuid"

siteControllerVersionstring

Version of the Site Controller software

siteAgentVersionstring

Version of the Site Agent software

registrationTokenstring

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

registrationTokenExpirationdatetimeRead-only

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

serialConsoleHostnamestringformat: "hostname"

isSerialConsoleEnabledboolean

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

serialConsoleIdleTimeoutinteger or null

Maximum idle time in seconds before Serial Console is disconnected

serialConsoleMaxSessionLengthinteger or null

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

statusenum

Status values for Site objects

Allowed values:

statusHistorylist of objects

createddatetime

updateddatetime

locationobject

Location of the Site

contactobject

Contact for the Site

capabilitiesobject

Boolean flags to indicate features supported by a Site

machineStatsobject

Machine stats for a Site

Errors

403

Forbidden Error