Sign in

v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB
Instance Type

Update Instance Type

Update an Instance Type by ID.

Org must have an Infrastructure Provider entity that owns the Instance Type. User must have authorization role with PROVIDER_ADMIN suffix.

patch/v2/org/{org}/nico/instance/type/{instanceTypeId}

Request body

namestring nullable

Name of the Instance Type

descriptionstring nullable

Description of the Instance Type

labelsLabels

Example request

{
  "description": "Updated version of the X3 Large family of machines"
}

Response

OK

idstring uuid

Unique UUID v4 identifier for the Instance Type

namestring

Name of the Instance Type

descriptionstring nullable

Description of the Instance Type

controllerMachineTypestring nullable

Machine type assigned by Site Controller

infrastructureProviderIdstring uuid

ID of the Infrastructure Provider that owns the Instance Type

siteIdstring uuid

ID of the Site that owns the Instance Type

labelsLabels
status'Pending' | 'Registering' | 'Ready' | 'Deleting' | 'Error'

Status values for Instance Type objects

createdstring date-time

Date/time when the InstanceType was created

updatedstring date-time

Date/time when the InstanceType was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "x3.large",
  "description": "Part of X family, the X3 Large features increased compute power",
  "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
  "siteId": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
  "labels": {
    "region": "portland",
    "env": "staging"
  },
  "machineCapabilities": [
    {
      "type": "CPU",
      "name": "Intel(R) Xeon(R) Gold 6354 CPU @ 3.00GHz",
      "frequency": "3.0GHz",
      "cores": 18,
      "threads": 36,
      "count": 2
    }
  ],
  "machineInstanceTypes": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "machineId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
      "instanceTypeId": "41e36058-8403-4086-a9b8-39cb5bc9cb98",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}