GET
/api/application/nodes/<nodeid>/addressesFetching a Node's Addresses
Query parameters
pageper_page- Max is 100.
filter[address]filter[type] = ipv4 | ipv6filter[server_id]- This field is nullable and will return unallocated addresses if you leave it as ?filter[server_id]= in your request.
Request
GET
/api/application/nodes/<nodeid>/addressescurl "https://panel.example.com/api/application/nodes/<nodeid>/addresses" \ -H "Authorization: Bearer <token>" \ -H "Accept: application/json"
use Illuminate\Support\Facades\Http; $response = Http::withToken($token) ->acceptJson() ->get('https://panel.example.com/api/application/nodes/<nodeid>/addresses');
const response = await fetch('https://panel.example.com/api/application/nodes/<nodeid>/addresses', { headers: { Authorization: `Bearer ${token}`, Accept: 'application/json', }, })
Response
{ "data": [ { "id": 11, "address_pool_id": 2, "server_id": null, "type": "ipv4", "address": "172.16.141.70", "cidr": 24, "gateway": "172.16.141.1", "mac_address": null }, { "id": 10, "address_pool_id": 2, "server_id": null, "type": "ipv4", "address": "172.16.141.69", "cidr": 24, "gateway": "172.16.141.1", "mac_address": null }, { "id": 9, "address_pool_id": 2, "server_id": null, "type": "ipv4", "address": "172.16.141.68", "cidr": 24, "gateway": "172.16.141.1", "mac_address": null }, { "id": 8, "address_pool_id": 2, "server_id": null, "type": "ipv4", "address": "172.16.141.67", "cidr": 24, "gateway": "172.16.141.1", "mac_address": null } ], "meta": { "pagination": { "total": 4, "count": 4, "per_page": 50, "current_page": 1, "total_pages": 1, "links": {} } } }
- page
- per_page
- max is 100
- filter[address]
- filter[type] = ipv4 | ipv6
- filter[server_id]
- This field is nullable and will return unallocated addresses if you leave it as
?filter[server_id]=in your request
- This field is nullable and will return unallocated addresses if you leave it as
PUT
/api/application/nodes/<nodeid>/addresses/<addressid>Updating an Address
Body parameters
mac_addressserver_idintegeraddressstringtypestringcidrintegergatewaystring
Request
PUT
/api/application/nodes/<nodeid>/addresses/<addressid>curl -X PUT "https://panel.example.com/api/application/nodes/<nodeid>/addresses/<addressid>" \ -H "Authorization: Bearer <token>" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data '{ "mac_address": null, "server_id": 10, "address": "172.16.141.71", "type": "ipv4", "cidr": 24, "gateway": "172.16.141.2" }'
use Illuminate\Support\Facades\Http; $response = Http::withToken($token) ->acceptJson() ->put('https://panel.example.com/api/application/nodes/<nodeid>/addresses/<addressid>', [ 'mac_address' => null, 'server_id' => 10, 'address' => '172.16.141.71', 'type' => 'ipv4', 'cidr' => 24, 'gateway' => '172.16.141.2', ]);
const response = await fetch('https://panel.example.com/api/application/nodes/<nodeid>/addresses/<addressid>', { method: 'PUT', headers: { Authorization: `Bearer ${token}`, Accept: 'application/json', 'Content-Type': 'application/json', }, body: JSON.stringify({ "mac_address": null, "server_id": 10, "address": "172.16.141.71", "type": "ipv4", "cidr": 24, "gateway": "172.16.141.2" }), })
Response
{ "data": { "id": 14, "address_pool_id": 2, "server_id": 10, "type": "ipv4", "address": "172.16.141.71", "cidr": 24, "gateway": "172.16.141.2", "mac_address": null } }
Deleting an Address
DELETE /api/application/nodes/<nodeid>/addresses/<address id>
Returns no content