Update Instance Type | NVIDIA Infra Controller

curl -X PATCH https://carbide-rest-api.carbide.svc.cluster.local/v2/org/org/carbide/instance/type/instanceTypeId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "description": "Updated version of the X3 Large family of machines",
  "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
    }
  ]
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "x3.large",
  "description": "Updated version of the X3 Large family of machines",
  "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
    }
  ],
  "status": "Pending",
  "statusHistory": [
    {
      "status": "Pending",
      "message": "Request received, pending processing",
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "deprecations": [
    {
      "queryParam": "includeMachineAssociation",
      "replacedBy": "includeMachineAssignment",
      "takeActionBy": "2023-07-26T00:00:00Z",
      "notice": "'includeMachineAssociation' has been deprecated in favor of 'includeMachineAssignment'. Please take action immediately."
    },
    {
      "attribute": "displayName",
      "takeActionBy": "2024-10-30T00:00:00Z",
      "notice": "'displayName' has been deprecated. Please take action immediately."
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Update an Instance Type by ID.

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

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired

instanceTypeIdstringRequired

Request

namestringOptional2-256 characters

descriptionstringOptional

labelsmap from strings to stringsOptional

machineCapabilitieslist of objectsOptional

Response

idstringRead-onlyformat: "uuid"

namestring2-256 characters

descriptionstring

controllerMachineTypestring

infrastructureProviderIdstringformat: "uuid"

siteIdstringformat: "uuid"

labelsmap from strings to strings

machineCapabilitieslist of objects

machineInstanceTypeslist of objects

Available only for Providers

allocationStatsobject

summary of machine counts by allocation status

statusenum

Status values for Instance Type objects

Allowed values:

statusHistorylist of objects

deprecationslist of objects

createddatetimeRead-only

updateddatetimeRead-only

Errors

403

Forbidden Error