Expected Rack

Update Expected Rack

Changed on

Update an existing Expected Rack identified by its id.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Infrastructure Provider must own the Expected Rack.

Alternatively, Tenant Admins with TargetedInstanceCreation capability can also update Expected Racks if they have an account with the Site's Infrastructure Provider.

rackId is immutable: an update that changes it is rejected with 400 before any database mutation.

patch/v2/org/{org}/nico/expected-rack/{id}

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/expected-rack/{id}
  • Auth
    HTTP bearer

Request body

idstring uuid nullable

ID of the Expected Rack to update.

For single updates, omit id or set it to null to use the ID from the URL path. A non-null body id must match the URL ID and use lowercase, hyphenated UUID format. Otherwise, REST returns HTTP 400.

rackIdstring nullable

Operator-supplied rack identifier. Immutable on update: omit this field, send null, or provide the existing value as a compatibility no-op. A changed value is rejected because Core and Flow use rackId as the identity key for expected racks.

rackProfileIdstring nullable

Ignored compatibility field. Metadata updates preserve the stored profile; this field alone is not a valid update.

namestring nullable

Human-readable name of the Expected Rack

descriptionstring nullable

Human-readable description of the Expected Rack

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

Example request

{
  "name": "Rack 01 (updated)",
  "description": "Production rack in row A, upgraded chassis",
  "labels": {
    "chassis.manufacturer": "NVIDIA",
    "chassis.serial-number": "NVRK0001001",
    "chassis.model": "GB200-NVL72",
    "location.datacenter": "phx-dc01",
    "location.position": "A1"
  }
}

Response

OK

idstring uuid

Unique identifier (UUID) for the Expected Rack

rackIdstring

Operator-supplied identifier for the rack (string, not UUID). Unique within a Site.

siteIdstring uuid

ID of the Site the Expected Rack belongs to

rackProfileIdstring

Identifier of the Rack Profile this rack conforms to

rackGroupIdstring nullable

External rack group ID selected and persisted at creation together with rackProfileId. Null for legacy rows without a recorded group; metadata updates preserve it.

namestring

Human-readable name of the Expected Rack

descriptionstring

Human-readable description of the Expected Rack

labelsLabels

Label keys must not be empty or whitespace-only. Keys and values may contain at most 255 characters and must not contain the Unicode NUL character (U+0000). Empty values are allowed.

createdstring date-time

ISO 8601 datetime when the Expected Rack was created

updatedstring date-time

ISO 8601 datetime when the Expected Rack was last updated

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "rackId": "rack-01",
  "siteId": "f97df110-f4de-492e-8849-4a6af68026b0",
  "rackProfileId": "rp-standard-42u",
  "name": "Rack 01",
  "description": "Production rack in row A",
  "labels": {
    "chassis.manufacturer": "NVIDIA",
    "chassis.serial-number": "NVRK0001001",
    "chassis.model": "GB200-NVL72",
    "location.region": "us-west-2",
    "location.datacenter": "phx-dc01",
    "location.room": "room-1",
    "location.position": "A1"
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z"
}

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 4a2b5e050a2eRevision changes
    • info

      added the non-success response with the status