Rack

Retrieve all Racks

Changed on

Get all Racks for the specified Site.

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

get/v2/org/{org}/nico/rack

Request

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

Query parameters

siteIdstring uuid required

ID of the Site to retrieve Racks from

includeComponentsboolean

Include rack components in response

namestring

Filter by rack name

manufacturerstring

Filter by manufacturer

pageNumberinteger

One-indexed page number.

Page number for pagination query

pageSizeinteger
Example:20

Page size for pagination query

orderBy'NAME_ASC' | 'NAME_DESC' | 'MANUFACTURER_ASC' | 'MANUFACTURER_DESC' | 'MODEL_ASC' | 'MODEL_DESC'

Ordering for pagination query. Defaults to NAME_ASC; equal field values are ordered by an immutable unique identifier to keep page boundaries stable.

Response

OK

idstring

Rack ID

namestring

Name of the Rack

manufacturerstring

Manufacturer of the Rack

modelstring

Model of the Rack

serialNumberstring

Serial number of the Rack

descriptionstring

Description of the Rack

operationStatus'Unknown' | 'Initializing' | 'Ready' | 'InUse' | 'Error' | 'Deleting' required

Operability phase aggregated from tray operationStatus values.

nvLinkDomainIdsstring[] required

Domain external IDs (rack group IDs) containing this Rack. Empty when no rack-group Domain is assigned.

Example response

[
  {
    "id": "rack-01",
    "name": "Rack-01",
    "manufacturer": "Dell",
    "model": "PowerEdge R750",
    "serialNumber": "SN-RACK-001",
    "description": "Primary compute rack",
    "operationStatus": "Ready",
    "nvLinkDomainIds": [
      "59202b81-65fb-45ec-b3b8-91ab0ad3f34a"
    ],
    "taskStats": {
      "pendingTaskCount": 0,
      "activeTaskCount": 0
    },
    "health": {
      "source": "rack-aggregate-health",
      "observedAt": "2026-09-28T12:00:00Z",
      "successes": [],
      "alerts": []
    },
    "location": {
      "region": "us-east-1",
      "datacenter": "DC-01",
      "room": "Room-A",
      "position": "A1"
    },
    "components": [
      {
        "id": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
        "type": "Compute",
        "name": "Server-01",
        "serialNumber": "SN-SRV-001",
        "manufacturer": "Dell",
        "firmwareVersion": "2.1.0",
        "slotId": 1,
        "trayIdx": 0,
        "hostId": 0,
        "bmcs": [
          {
            "type": "BmcTypeHost",
            "macAddress": "AA:BB:CC:DD:EE:01",
            "ipAddress": "10.0.0.101"
          }
        ],
        "powerState": "on",
        "leakStatus": "Leaking",
        "leakHandlingStatus": "ShuttingDown",
        "health": {
          "source": "aggregate-host-health",
          "observedAt": "2026-09-28T12:00:00Z",
          "successes": [],
          "alerts": []
        }
      }
    ]
  }
]

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

  • 0b2823e8f92bRevision changes
    • breaking

      the // response's property format changed from uuid to no format for status