Create Site

POST

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

POST

/v2/org/:org/nico/site

$ curl -X POST https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/site \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "San Jose Central 4",
>   "description": "Datacenter serving San Jose central region",
>   "location": {
>     "city": "San Jose",
>     "state": "CA",
>     "country": "USA"
>   },
>   "contact": {
>     "email": "johndoe@nvidia.com"
>   }
> }'

1 {
2   "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
3   "name": "San Jose Central 4",
4   "description": "Datacenter serving the San Jose central region",
5   "org": "qygdmg8oqik8",
6   "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
7   "siteControllerVersion": "0.1",
8   "siteAgentVersion": "0.1",
9   "registrationToken": "J7KO-89RR-Y7WQ-AD90",
10   "registrationTokenExpiration": "2019-08-25T12:00:00Z",
11   "serialConsoleHostname": "sjc.nico.acme.com",
12   "isSerialConsoleEnabled": true,
13   "serialConsoleIdleTimeout": 60,
14   "serialConsoleMaxSessionLength": 3600,
15   "isSerialConsoleSSHKeysEnabled": true,
16   "isOnline": false,
17   "status": "Pending",
18   "statusHistory": [
19     {
20       "status": "Pending",
21       "message": "Request received, pending processing",
22       "created": "2019-08-24T14:15:22Z",
23       "updated": "2019-08-24T14:15:22Z"
24     }
25   ],
26   "created": "2019-08-24T14:15:22Z",
27   "updated": "2019-08-24T14:15:22Z",
28   "location": {
29     "city": "San Jose",
30     "state": "CA",
31     "country": "USA"
32   },
33   "contact": {
34     "email": "johndoe@nvidia.com"
35   },
36   "capabilities": {
37     "nativeNetworking": true,
38     "networkSecurityGroup": true,
39     "nvLinkPartition": false,
40     "flow": false,
41     "imageBasedOperatingSystem": false
42   },
43   "machineStats": {
44     "total": 15,
45     "totalByStatus": {
46       "Decommissioned": 0,
47       "Error": 5,
48       "Initializing": 0,
49       "InUse": 3,
50       "Maintenance": 0,
51       "Ready": 7,
52       "Reset": 0,
53       "Unknown": 0
54     },
55     "totalByHealth": {
56       "healthy": 12,
57       "unhealthy": 3
58     },
59     "totalByStatusAndHealth": {
60       "Decommissioned": {
61         "healthy": 0,
62         "unhealthy": 0
63       },
64       "Error": {
65         "healthy": 2,
66         "unhealthy": 3
67       },
68       "Initializing": {
69         "healthy": 0,
70         "unhealthy": 0
71       },
72       "InUse": {
73         "healthy": 3,
74         "unhealthy": 0
75       },
76       "Maintenance": {
77         "healthy": 5,
78         "unhealthy": 0
79       },
80       "Ready": {
81         "healthy": 5,
82         "unhealthy": 0
83       },
84       "Reset": {
85         "healthy": 0,
86         "unhealthy": 0
87       },
88       "Unknown": {
89         "healthy": 0,
90         "unhealthy": 0
91       }
92     },
93     "totalByAllocation": {
94       "allocatedInUse": 3,
95       "allocatedNotInUse": 3,
96       "unallocated": 5
97     }
98   }
99 }

Create a Site for the org.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Tenants cannot create Sites.

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

``` 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

Request

This endpoint expects an object.

namestringRequired2-256 characters

Name for the Site

descriptionstring or nullOptional

Description for the Site

serialConsoleHostnamestring or nullOptionalformat: "hostname"

Hostname to reach Serial Console for the Site

locationobjectOptional

Site location information

contactobjectOptional

Site contact information

Response

Created

idstringRead-onlyformat: "uuid"

Unique UUID v4 identifier for the Site in NICo Cloud

namestring2-256 characters

Name of the Site

descriptionstring or null

Optional description for the Site

orgstring

NGC organization ID of the Infrastructure Provider that owns the Site

infrastructureProviderIdstringformat: "uuid"

ID of the Infrastructure Provider that owns the Site

siteControllerVersionstring or null

Version of the Site Controller software

siteAgentVersionstring or null

Version of the Site Agent software

registrationTokenstring or null

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

registrationTokenExpirationdatetime or nullRead-only

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

serialConsoleHostnamestring or nullformat: "hostname"

Serial console hostname of the site controller

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 of the Site

statusHistorylist of objects

Chronological status history for the Site

createddatetime

Date/time when the Site was created

updateddatetime

Date/time when the Site was last updated

locationobject

Site location information

contactobject

Site contact information

capabilitiesobject

Site capabilities used for feature availability and configuration

machineStatsobject

Machine counts by status for the Site

Errors

400

Bad Request Error

403

Forbidden Error