Skip to content

List cables

GET
/api/cables
 
curl --request GET \
  --url 'http://localhost:3000/api/cables?page=1&sort=label&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 label, type, color, description

sort
string
Allowed values: label type status 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
label
string
nullable
type
required
string
Allowed values: cat5e cat6 cat6a cat7 cat8 fiber-mm fiber-sm sfp qsfp dac aoc power usb serial other
status
required
string
Allowed values: connected planned decommissioning
color
string
nullable
length

Numeric serialised as string

string
nullable
lengthUnit
string
nullable
Allowed values: m cm ft in
aPortId
required
string format: uuid
bPortId
required
string format: uuid
description
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": [
    {
      "type": "cat5e",
      "status": "connected",
      "lengthUnit": "m"
    }
  ]
}

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"
}