latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

IP Addresses
IPv4 Address Settings

Return shared IP address

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

get/get_shared_ip

Query parameters

userstring username
Example:example

The WHM user's username.

Note:

This parameter defaults to the currently-authenticated user.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "ip": "192.168.0.1"
  },
  "metadata": {
    "command": "get_shared_ip",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}