Network
IPv4 assignment and the network whitelist for a server's interfaces.
Endpoints
- POSTAdd an address to the whitelist
/servers/{serverId}/networkWhitelistAdd an address or CIDR range to the interface's network whitelist, allowing the server to send from addresses that are not assigned to it. - DELETERemove an address from the whitelist
/servers/{serverId}/networkWhitelistRemove an address from the interface's network whitelist. - POSTAdd a quantity of IPv4 addresses
/servers/{serverId}/ipv4QtyAllocate quantity free IPv4 addresses to the interface from the blocks available to the server's hypervisor. The response lists the addresses that were… - POSTAdd an array of IPv4 addresses
/servers/{serverId}/ipv4Assign specific free IPv4 addresses to the interface. The interface endpoints offer the same by id or quantity, with ordering and IPv6. - DELETERemove an array of IPv4 addresses
/servers/{serverId}/ipv4Unassign the listed IPv4 addresses from the interface and return them to their blocks. - GETRetrieve a server's network interfaces ●
/servers/{serverId}/interfacesThe server's interfaces, primary first, with their settings, network, VLANs and addresses. The other interface endpoints address one by primary , secondary or… - POSTCreate a server interface ●
/servers/{serverId}/interfacesCreate the server's secondary interface, or its primary when it has none. apply: true also attaches it to the running server. - GETRetrieve a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}One interface by role or tag. - PUTUpdate a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}Change an interface's settings; send only the fields to change. apply: true pushes bandwidth, filter and isolation changes to the running server. - POSTAttach IPv4 addresses to a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv4Attach IPv4 addresses by ids , addresses or quantity send one . Addresses must be free and in a block the hypervisor can use; they land in the configuration… - DELETERemove IPv4 addresses from a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv4Return the listed addresses ids or addresses to their blocks. The remaining addresses are renumbered and the primary address moves if it was removed. - PUTSet the order of a server interface's IPv4 addresses ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv4/orderReplace the order of the interface's addresses; order lists every address once. On the primary interface the first address becomes the server's primary address. - POSTAttach an IPv6 subnet to a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv6Attach the next free IPv6 subnet from the interface's network, or the specific subnet given. The subnet's first address is created with it. - DELETERemove IPv6 subnets from a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv6Return the listed subnets to their blocks, deleting their addresses. - GETRetrieve a server interface's extra MAC addresses ●
/servers/{serverId}/interfaces/{interfaceRef}/macsThe extra MAC addresses on the interface, each with the ids of the IPv4 addresses and IPv6 subnets bound to it. - POSTAdd an extra MAC address to a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/macsAdds a MAC for a nested guest behind the interface. Send mac to use a specific one, or an empty body to have a locally administered MAC allocated. The… - DELETERemove an extra MAC address from a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/macs/{macId}Removes the MAC. Refused while an IPv4 address or an IPv6 subnet is still bound to it; unbind them first. - PUTBind a server interface's IPv4 address to a MAC ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv4/{ipId}/macBinds the address to one of the interface's extra MACs, so only that MAC may send from it, or with macId null back to the interface's own MAC. - PUTBind a server interface's IPv6 subnet to a MAC ●
/servers/{serverId}/interfaces/{interfaceRef}/ipv6/{subnetId}/macBinds the whole subnet to one of the interface's extra MACs, so only that MAC may send from any of its addresses, or with macId null back to the interface's… - GETRetrieve a server interface's VLANs ●
/servers/{serverId}/interfaces/{interfaceRef}/vlansThe VLANs tagged on the interface. VLANs apply on simpleBridge and lvBridgeOVS networks. - POSTAdd a VLAN to a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/vlansTag a VLAN 1 to 4094 on the interface. It lands in the server's configuration at the next start or push. - PUTUpdate a VLAN on a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/vlans/{vlanId}nativeMode applies to this VLAN. trunk is a property of the interface and applies to every VLAN on it, as in the admin VLAN table. - DELETERemove a VLAN from a server interface ●
/servers/{serverId}/interfaces/{interfaceRef}/vlans/{vlanId}Untag the VLAN. The change is written into the server's configuration at the next start or configuration push.