---
title: "Return server's IP addresses"
method: GET
path: "/listips"
tags: ["IP Addresses", "IPv4 Address Settings"]
---

# Return server's IP addresses

`GET /listips`

This function lists a server's IP addresses.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `ip` object[] — An array of objects that contain IP address information.
      - `active` 0 | 1 — Whether the IP address is active. * `1` — Active. * `0` — Inactive.
      - `dedicated` 0 | 1 — Whether the IP address is dedicated. * `1` — Dedicated. * `0` — Shared.
      - `if` string — The IP address' network interface.
      - `ip` string, ipv4 — The IP address.
      - `mainaddr` 0 | 1 — Whether the IP address is the server's main IP address. * `1` — Main IP address. * `0` — **Not** the main IP address.
      - `netmask` string, ipv4 — The IP address' netmask.
      - `network` string, ipv4 — The IP address' network value.
      - `public_ip` string, ipv4 — The public IP for the IP address.
      - `removable` 0 | 1 — Whether the IP address can be removed. * `1` — Removable. * `0` — **Not** removable.
      - `used` 0 | 1 — Whether the IP address is in use. * `1` — In use. * `0` — **Not** in use.
  - `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)