Remove IP address

This function removes an IP address from the server.

SecurityBasicAuth
Request
query Parameters
ip
required
string <ipv4>

The IPv4 address.

Example: ip=10.1.1.1
ethernetdev
string or null
Default: ""

The network alias to which the IPv4 address is bound.

Example: ethernetdev=eth0
skipifshutdown
integer
Default: 0

Whether to remove the IP address if the ethernet interface is down.

  • 1 — Do not remove the IP address.
  • 0 — Remove the IP address.
Enum: 0 1
Example: skipifshutdown=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/delip
Request samples
whmapi1 --output=jsonpretty \
  delip \
  ip='10.1.1.1'
Response samples
application/json
{
  • "metadata": {
    • "command": "delip",
    • "reason": "eth0:cp2 is now down, 10.1.1.1 has been removed",
    • "result": 1,
    • "version": 1
    }
}