Get device

GET

/api/devices/{id}

curl --request GET \
  --url http://localhost:3000/api/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

• Local development
• Dedicated / self-hosted instance

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Success

Media type application/json

object

data

object

id

required

string format: uuid

name

required

string

status

required

string

Allowed values: active planned staged offline decommissioned

siteId

string format: uuid

nullable

locationId

string format: uuid

nullable

rackId

string format: uuid

nullable

manufacturerId

string format: uuid

nullable

deviceRoleId

string format: uuid

nullable

deviceTypeId

string format: uuid

nullable

platformId

string format: uuid

nullable

position

Lowest occupied rack unit

integer

nullable

uHeight

Rack units occupied

integer

default: 1

platform

Legacy free-text platform (prefer platformId)

string

nullable

model

Legacy free-text model (prefer deviceTypeId)

string

nullable

primaryIp

string

nullable

description

string

nullable

tags

Array<string>

serialNumber

string

nullable

assetTag

string

nullable

notes

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "status": "active",
    "uHeight": 1
  }
}

401

Not authenticated

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

Device not found

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}