Skip to content

List prefixes

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

sort
string
Allowed values: prefix 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
prefix
required
string
vrfId
string format: uuid
nullable
siteId
string format: uuid
nullable
vlanId
string format: uuid
nullable
status
required
string
Allowed values: active container reserved deprecated
isPool
required
boolean
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": [
    {
      "prefix": "10.0.0.0/24",
      "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"
}