List devices

GET

/api/devices

const url = 'http://localhost:3000/api/devices?page=1&sort=name&order=asc&status=all';
const options = {method: 'GET', headers: {cookie: 'session=<session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/devices?page=1&sort=name&order=asc&status=all' \
  --cookie session=<session>

Authorizations

cookieAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

Page number (1-based)

pageSize

integer

>= 1 <= 10000

Rows per page. Omitted = full table, capped at 10000.

search

string

Case-insensitive substring match across name, asset tag, serial number, model, primary IP

sort

string

Allowed values: name status assetTag serialNumber createdAt updatedAt

Sort column

order

string

Allowed values: asc desc

Sort direction

status

string

Allowed values: all active planned staged offline decommissioned

Filter by status (all = no filter)

siteId

string

Filter by site id — a UUID, or none for records with no site. Malformed values return 400.

locationId

string

Filter by location id — a UUID, or none for records with no location. Malformed values return 400.

manufacturerId

string

Filter by manufacturer id — a UUID, or none for records with no manufacturer. Malformed values return 400.

Responses

200

Success

application/json

object

data

required

Array<object>

object

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

total

required

integer

page

required

integer

pageSize

required

integer

hasMore

required

boolean

Example

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

400

Invalid filter param

application/json

object

error

required

string

Example

{
  "error": "Not found"
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}