Skip to main content
GET
/
Agent
/
Account
/
DomainInfo
Domain Info
curl --request GET \
  --url https://{host}/Agent/Account/DomainInfo
{
  "useEncryption": true,
  "domain": "<string>",
  "humanReadableName": "<string>",
  "humanReadableDescription": "<string>"
}

Overview

Gets human-readable information about the domain of the server. This resource is accessed using HTTP GET, so there is no payload sent to resource. The request can be made anonymously. No authentication is required. This resource is typically called in the beginning of an on-boarding process, where the user is given a choice to select service provider (i.e. domain).

Authentication

No authentication required.

Notes

This endpoint uses the request schema notation described in Pattern matching.

Headers

Accept-Language
string

Selects which language to use for human-readable strings returned.

Response

200 - application/json

Success

useEncryption
boolean
required
domain
string
humanReadableName
string
humanReadableDescription
string