v57

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

Retrieve all Racks

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

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
Example:1

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

Response

OK

idstring uuid

Unique identifier of the Rack

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

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Rack-01",
    "manufacturer": "Dell",
    "model": "PowerEdge R750",
    "serialNumber": "SN-RACK-001",
    "description": "Primary compute rack",
    "location": {
      "region": "us-east-1",
      "datacenter": "DC-01",
      "room": "Room-A",
      "position": "A1"
    },
    "components": [
      {
        "id": "660e8400-e29b-41d4-a716-446655440001",
        "componentId": "fm100ht4v4mce2qstjnl8970nnj3ie6ecek4mtjn27pea4kre5gsa49jg0g",
        "type": "ComponentTypeCompute",
        "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"
      }
    ]
  }
]