List IP addresses

GET

/api/ip-addresses

const url = 'http://localhost:3000/api/ip-addresses?page=1&sort=address&order=asc';
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/ip-addresses?page=1&sort=address&order=asc' \
  --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 address, DNS name, description, role

sort

string

Allowed values: address status dnsName createdAt

Sort column

order

string

Allowed values: asc desc

Sort direction

Responses

200

Success

application/json

object

data

required

Array<object>

object

required

string format: uuid

address

required

string

vrfId

string format: uuid

nullable

deviceId

string format: uuid

nullable

interfaceId

Device_ports.id this address is bound to. Setting it on create/update re-homes deviceId to that port’s device so the address shows under both the interface and the device. ON DELETE SET NULL.

string format: uuid

nullable

interfaceName

Join-only: the interface name, returned by GET /api/devices/{id}/ips.

string

nullable

status

required

string

Allowed values: active reserved deprecated dhcp

role

E.g. loopback, mgmt, peering, vip, secondary

string

nullable

family

integer

nullable

Allowed values: 4 6

dnsName

string

nullable

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": [
    {
      "address": "10.0.0.10/24",
      "status": "active",
      "family": 4
    }
  ]
}

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