Retrieve SKU

GET

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

GET

/v2/org/:org/nico/sku/:skuId

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

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

Retrieve a specific SKU (Stock Keeping Unit) by ID.

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

For Infrastructure Providers: Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER suffix.

For Tenants: Org must have a Tenant with TargetedInstanceCreation capability enabled. User must have authorization role with TENANT_ADMIN suffix. The Tenant must have an account with the SKU’s Site’s Infrastructure Provider.

Retrieve a specific SKU (Stock Keeping Unit) by ID. SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics. For Infrastructure Providers: Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` or `PROVIDER_VIEWER` suffix. For Tenants: Org must have a Tenant with `TargetedInstanceCreation` capability enabled. User must have authorization role with `TENANT_ADMIN` suffix. The Tenant must have an account with the SKU's Site's Infrastructure 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

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

skuIdstringRequired

ID of the SKU

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

404

Not Found Error