Return shared IP address

This function retrieves the IP address that an account shares with the accounts that it owns.

SecurityBasicAuth
Request
query Parameters
user
string <username>

The WHM user's username.

Note:

This parameter defaults to the currently-authenticated user.

Example: user=example
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/get_shared_ip
Request samples
whmapi1 --output=jsonpretty \
  get_shared_ip
Response samples
application/json
{
  • "data": {
    • "ip": "192.168.0.1"
    },
  • "metadata": {
    • "command": "get_shared_ip",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}