---
title: "Return shared IP address"
method: GET
path: "/get_shared_ip"
tags: ["IP Addresses", "IPv4 Address Settings"]
---

# Return shared IP address

`GET /get_shared_ip`

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

## Query parameters

- `user` string, username

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `ip` string — The IP address that the WHM user shares. **Note:** If the user does **not** have a shared IP address, the function returns the tilde ( `~` ) character.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)