Update SKU

PATCH

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

PATCH

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

curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/sku/skuId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "DGX H100 compute node with InfiniBand",
  "components": {
    "infinibandDevices": [
      {
        "vendor": "Mellanox Technologies",
        "model": "MT2910 Family [ConnectX-7]",
        "count": 4,
        "inactiveDevices": []
      }
    ]
  }
}'

{
  "id": "lenovo.sr650v2.cpu.1",
  "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  "description": "Lenovo SR650 V2 compute node",
  "schemaVersion": 5,
  "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": "Samsung",
        "model": "PM9A3",
        "capacityMb": 7680000,
        "count": 4
      }
    ],
    "chassis": {
      "vendor": "Supermicro",
      "model": "SYS-420GP-TNR"
    }
  },
  "created": "2019-08-24T14:15:22Z"
}

Update selected mutable fields on a SKU. The Site is determined from the saved SKU record.

Fields omitted from the request retain their current values. If a user updates the components field, the schema version will be updated to the current version (5).

The Org must have an Infrastructure Provider that owns the SKU’s Site. The user must have an authorization role with the PROVIDER_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

skuIdstringRequired

ID of the SKU

Request

This endpoint expects an object.

descriptionstringOptional

Replacement SKU description

deviceTypestringOptional

Replacement device type identifier

componentsobjectOptional

Hardware components that make up a 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