Retrieve all Racks

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/rack

GET

/v2/org/:org/nico/rack

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/rack \
     -H "Authorization: Bearer <token>" \
     -d pageSize=20 \
     -d siteId=siteId

[
  {
    "operationStatus": "Ready",
    "nvLinkDomainIds": [
      "59202b81-65fb-45ec-b3b8-91ab0ad3f34a"
    ],
    "taskStats": {
      "pendingTaskCount": 0,
      "activeTaskCount": 0
    },
    "health": null,
    "id": "rack-01",
    "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": [
      {
        "health": null,
        "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"
      }
    ]
  }
]

Get all Racks for the specified Site.

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

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

Path parameters

orgstringRequired

Name of the Org

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site to retrieve Racks from

includeComponentsbooleanOptional

Include rack components in response

namestringOptional

Filter by rack name

manufacturerstringOptional

Filter by manufacturer

pageNumberintegerOptional1-21474836

Page number for pagination query

pageSizeintegerOptional1-100

Page size for pagination query

orderByenumOptional

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

Response headers

Response

operationStatusenum

Operability phase aggregated from tray operationStatus values.

nvLinkDomainIdslist of strings

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

taskStatsobject

Counts of non-terminal tasks currently associated with a rack or tray. Rack stats include component-scoped tasks on the rack; tray stats include only tasks that explicitly target the tray.

healthobject or null

Latest Core aggregate health snapshot synchronized by Flow. Null when Core reports no aggregate health, including before the first successful inventory sync.

idstringOptional

Rack ID

namestringOptional

Name of the Rack

manufacturerstringOptional

Manufacturer of the Rack

modelstringOptional

Model of the Rack

serialNumberstringOptional

Serial number of the Rack

descriptionstringOptional

Description of the Rack

locationobjectOptional

Physical or logical location of the Rack

componentslist of objectsOptional

Components within the Rack. Only returned when includeComponents is true.

Errors

403

Forbidden Error

504

Gateway Timeout Error