Skip to main content
GET
Get a site's rack floorplan

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

site_id
string<uuid>
required

Site ID used to constrain the unpaginated compact response.

Response

One site's rack grid: every rack, placed, in grid order.

site_id
string<uuid>
required
rack_position_strategy
enum<string>
required

How every position and row in this response was determined. Reported once because it is a property of the site, and it tells a caller whether the placement is authoritative or inferred from operator naming. The same value the standup racks and allocation grid endpoints report for this site.

  • derived_from_name - DERIVED_FROM_NAME
  • derived_from_scalable_unit - DERIVED_FROM_SCALABLE_UNIT
Available options:
derived_from_name,
derived_from_scalable_unit
racks
object[]
required

Every rack whose Location belongs to this site, including racks holding no devices, ordered down the rows then along each row. Racks whose placement could not be read sort last with null coordinates. The Location is the authority on which site a rack is on, so a rack whose Location has moved appears on its new site's floor and not its old one.