Skip to main content
GET
List routers

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

Query Parameters

limit
integer
default:1000

Limit of items on a single page

Required range: x <= 1000
Example:

10

name
string

Optional. Filter routers by name

Example:

"router-name"

offset
integer
default:0

Offset in results list

Required range: x >= 0
Example:

0

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
RouterSerializer · object[]
required

Objects