Skip to content

List device types

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “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, slug, model family, ASIC chipset, key features

sort
string
Allowed values: name slug modelFamily createdAt

Sort column

order
string
Allowed values: asc desc

Sort direction

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
Array<object>
object
id
required
string format: uuid
name
required
string
slug
string
nullable
manufacturerId
string format: uuid
nullable
description
string
nullable
modelFamily
string
nullable
formFactor
string
nullable
rackUnits

Numeric(4,1) serialised as string

string
nullable
airflow
string
nullable
weightKg

Numeric(7,2) serialised as string

string
nullable
powerIdleW
integer
nullable
powerMaxW
integer
nullable
poeBudgetW
integer
nullable
keyFeatures
string
nullable
typicalDeployment
string
nullable
asicChipset
string
nullable
defaultPlatformId
string format: uuid
nullable
defaultRoleId
string format: uuid
nullable
popular
boolean
source
string
Allowed values: vendor customer
status
string
Allowed values: active announced eos eol
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": [
    {
      "source": "vendor",
      "status": "active"
    }
  ]
}

400

Section titled “400 ”

Invalid filter param

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}