Retrieve all SKUs

GET

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

GET

/v2/org/:org/nico/sku

$ curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/sku \
>      -H "Authorization: Bearer <token>" \
>      -d siteId=siteId

1 [
2   {
3     "id": "lenovo.sr650v2.cpu.1",
4     "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
5     "deviceType": "gpu",
6     "associatedMachineIds": [
7       "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g"
8     ],
9     "components": {
10       "cpus": [
11         {
12           "vendor": "Intel",
13           "model": "Xeon Platinum 8480+",
14           "threadCount": 112,
15           "count": 2
16         }
17       ],
18       "gpus": [
19         {
20           "vendor": "NVIDIA",
21           "model": "H100 SXM5",
22           "totalMemory": "80GB HBM3",
23           "count": 8
24         }
25       ],
26       "memory": [
27         {
28           "capacityMb": 65536,
29           "memoryType": "DDR5",
30           "count": 16
31         }
32       ],
33       "storage": [
34         {
35           "vendor": "Samsung",
36           "model": "PM9A3",
37           "capacityMb": 7680000,
38           "count": 4
39         }
40       ],
41       "chassis": {
42         "vendor": "Supermicro",
43         "model": "SYS-420GP-TNR"
44       }
45     },
46     "created": "2019-08-24T14:15:22Z",
47     "updated": "2019-08-24T14:15:22Z"
48   }
49 ]

Retrieve all SKUs (Stock Keeping Units) for a Site.

SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics.

A siteId query parameter is required for all requests.

For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN suffix.

For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled and Tenant Account with Machine’s Provider. User must have authorization role with TENANT_ADMIN suffix.

Retrieve all SKUs (Stock Keeping Units) for a Site. SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics. A `siteId` query parameter is required for all requests. For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with `PROVIDER_ADMIN` suffix. For Tenants: Org must have a Tenant with `TargetedInstanceCreation` capability enabled and Tenant Account with Machine's Provider. User must have authorization role with `TENANT_ADMIN` suffix.

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

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site to retrieve SKUs from

pageNumberintegerOptional>=1Defaults to 1

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringRead-only

Unique identifier for the SKU

siteIdstringRead-onlyformat: "uuid"

ID of the Site this SKU belongs to

deviceTypestring or nullRead-only

Optional device type identifier (e.g. “gpu”, “cpu”, “storage”)

associatedMachineIdslist of stringsRead-only

List of machine IDs associated with this SKU

componentsobject

Hardware components of this SKU

createddatetimeRead-only

ISO 8601 datetime when the SKU was created

updateddatetimeRead-only

ISO 8601 datetime when the SKU was last updated

Errors

400

Bad Request Error

403

Forbidden Error