---
title: "Retrieve IM server configuration"
method: GET
path: "/im"
tags: ["Administration"]
---

# Retrieve IM server configuration

`GET /im`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/im`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/im/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve settings of IM server.

## Response `200`

OK

- object
  - `private_ipv4` string: Host IPV4 address.
  - `private_ipv6` string: Host IPV6 address.
  - `public_ipv4` string: Host IPV4 address.
  - `public_ipv6` string: Host IPV6 address.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)