Info

Retrieve metadata.

get

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

domainstringOptional

Use the domain query parameter to retrieve just a subset of a collection.

Responses

200

application/json

4XX

Error

get

GET /api/info HTTP/1.1
Host: hostname:8887
Accept: */*

{
  "web_domain": "example.com",
  "private_ipv4": "127.0.0.1",
  "public_ipv4": "127.0.0.1",
  "enable_ipv6": false,
  "private_ipv6": "::1",
  "public_ipv6": "::1",
  "primary_dns_server": "127.0.0.1",
  "secondary_dns_server": "127.0.0.1",
  "name": "example",
  "domain": "example.com",
  "website": "example.com",
  "avatar_url": "avatar.com/avatar",
  "enable_ms365_integration": false,
  "ms365_authorization_endpoint": "/ms365"
}

PreviousAPI reference NextLogin