Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Authentication

Retrieve metadata.

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
get/info

Query parameters

domainstring

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

Response

OK

web_domainstring

The web domain for PortSIP PBX

private_ipv4string

The private IPv4 of system.

public_ipv4string

The public IPv4 of system.

enable_ipv6boolean

Indicates if IPv6 would be enabled.

private_ipv6string

The private IPv6 of system.

public_ipv6string

The public IPv6 of system.

primary_dns_serverstring

The primary DNS server.

secondary_dns_serverstring

The secondary DNS server.

namestring

The name of the tenant.

domainstring

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.

websitestring

The official website of tenant.

avatar_urlstring

The relative path to file url for file downloading.

enable_ms365_integrationboolean

Microsoft 365 SSO integration enabled or not.

ms365_authorization_endpointstring

The Microsoft Identity Provider authorization endpoint for this tenant.

Example response

{
  "avatar_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}