Get IP address

GET

/api/ip-addresses/{id}

const url = 'http://localhost:3000/api/ip-addresses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie session=<session>

Authorizations

cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Success

application/json

object

data

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

Example

{
  "data": {
    "address": "10.0.0.10/24",
    "status": "active",
    "family": 4
  }
}

401

Not authenticated

application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

IpAddress not found

application/json

object

error

required

string

Example

{
  "error": "Not found"
}