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

{
  "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 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

Path parameters

orgstringRequired

Name of the Org

skuIdstringRequired

ID of the SKU

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

404

Not Found Error