---
title: "Get rack layout"
method: GET
path: "/v1/objects/{object-id}/rack-layout"
tags: ["Objects"]
---

# Get rack layout

`GET /v1/objects/{object-id}/rack-layout`

Retrieve the complete layout of a rack in a single call: rack metadata, passive elements, and all placed child objects (nodes and chassis) with their placement geometry. Placed objects are filtered by the requesting user's read access and only those with a valid rack position (>= 1) are returned.

## Path parameters

- `object-id` integer, required

## Response `200`

Rack layout retrieved successfully

- object
  - `rackId` integer — Rack object ID
  - `name` string — Rack name
  - `height` integer — Rack height in units
  - `topBottomNumbering` boolean — True if rack units are numbered from top to bottom
  - `passiveElements` object[] — Passive rack elements (patch panels, PDUs, organisers, fillers)
    - `id` integer
    - `name` string
    - `type` integer — Element type (0=patch panel, 1=filler panel, 2=organiser, 3=PDU)
    - `position` integer
    - `height` integer
    - `orientation` integer — Orientation (0=fill, 1=front, 2=rear)
    - `portCount` integer — Number of ports (patch panels only)
    - `imageFront` string, uuid
    - `imageRear` string, uuid
  - `objects` object[] — Placed child objects (nodes and chassis) with rack placement
    - `id` integer — Object ID
    - `objectClass` integer — Object class code
    - `name` string — Object name
    - `status` integer — Object status
    - `rackPosition` integer
    - `rackHeight` integer
    - `rackOrientation` integer — Orientation (0=fill, 1=front, 2=rear)
    - `rackImageFront` string, uuid
    - `rackImageRear` string, uuid

## Other responses

- `400` — Object ID is invalid or object is not a rack
- `401` — Unauthorized
- `403` — User does not have read access to given object
- `404` — Object with given ID does not exist

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)