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 pageSize=20 \
     -d siteId=siteId

[
  {
    "id": "lenovo.sr650v2.cpu.1",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "deviceType": "gpu",
    "associatedMachineIds": [
      "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g"
    ],
    "components": {
      "cpus": [
        {
          "vendor": "Intel",
          "model": "Xeon Platinum 8480+",
          "threadCount": 112,
          "count": 2
        }
      ],
      "gpus": [
        {
          "vendor": "NVIDIA",
          "model": "H100 SXM5",
          "totalMemory": "80GB HBM3",
          "count": 8
        }
      ],
      "memory": [
        {
          "capacityMb": 65536,
          "memoryType": "DDR5",
          "count": 16
        }
      ],
      "storage": [
        {
          "vendor": "",
          "model": "SAMSUNG MZ1L21T9HCLS-00A07",
          "capacityMb": 0,
          "count": 4,
          "minSizeMiB": 7680000,
          "maxSizeMiB": 7680000,
          "pciPatterns": [
            "^/devices/pci.*/nvme$"
          ]
        }
      ],
      "chassis": {
        "vendor": "Supermicro",
        "model": "SYS-420GP-TNR"
      }
    },
    "created": "2019-08-24T14:15:22Z"
  }
]

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

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site to retrieve SKUs from

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

Ordering for pagination query

Response headers

Response

idstringOptionalRead-only

Unique identifier for the SKU

siteIdstringOptionalRead-onlyformat: "uuid"

ID of the Site this SKU belongs to

descriptionstringOptionalRead-only

Human-readable SKU description

schemaVersionuintOptionalRead-only>=0

Core SKU schema version when available

deviceTypestring or nullOptionalRead-only

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

associatedMachineIdslist of stringsOptionalRead-only

List of machine IDs associated with this SKU

componentsobjectOptional

Hardware components of this SKU

createddatetimeOptionalRead-only

ISO 8601 datetime when the SKU was created, using the Site-reported timestamp when available

Errors

400

Bad Request Error

403

Forbidden Error