---
title: "Retrieve metadata."
method: GET
path: "/info"
tags: ["Authentication"]
---

# Retrieve metadata.

`GET /info`

Retrieve system metadata information.   
If the optional `domain` query parameter is specified,    
the relevant tenant metadata information will be returned together.   
System metadata:   
- `web_domain`
- `private_ipv4`
- `public_ipv4`
- `enable_ipv6`
- `private_ipv6`
- `public_ipv6`
- `primary_dns_server`
- `secondary_dns_server`   
Tenant metadata:   
- `name`
- `domain`
- `website`
- `avatar_url`
- `enable_ms365_integration`
- `ms365_authorization_endpoint`

## Query parameters

- `domain` string

## Response `200`

OK

- object
  - `web_domain` string — The web domain for PortSIP PBX
  - `private_ipv4` string — The private IPv4 of system.
  - `public_ipv4` string — The public IPv4 of system.
  - `enable_ipv6` boolean — Indicates if IPv6 would be enabled.
  - `private_ipv6` string — The private IPv6 of system.
  - `public_ipv6` string — The public IPv6 of system.
  - `primary_dns_server` string — The primary DNS server.
  - `secondary_dns_server` string — The secondary DNS server.
  - `name` string — The name of the tenant.
  - `domain` string — The SIP domain of tenant. It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.
  - `website` string — The official website of tenant.
  - `avatar_url` string — The relative path to file url for file downloading.
  - `enable_ms365_integration` boolean — Microsoft 365 SSO integration enabled or not.
  - `ms365_authorization_endpoint` string — The Microsoft Identity Provider authorization endpoint for this tenant.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)