Get detailed dns check for domain

GET

/domains/{domainID}/dnsCheck

curl --request GET \
  --url https://example.com/api/v1/domains/1/dnsCheck \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

Responses

200

Dns check returned

Media typeapplication/json

object

localIp

The IP the internal DNS server resolved from the domain

string

nullable

externalIp

The IP the external DNS server resolved from the domain

string

nullable

mxRecords

object

internalDNS

string

nullable

externalDNS

string

nullable

mxDomain

string

nullable

reverseLookup

string

nullable

autodiscover

object

internalDNS

string

nullable

externalDNS

string

nullable

autoconfig

object

internalDNS

string

nullable

externalDNS

string

nullable

txt

object

internalDNS

string

nullable

externalDNS

string

nullable

dkim

object

internalDNS

string

nullable

externalDNS

string

nullable

dmarc

object

internalDNS

string

nullable

externalDNS

string

nullable

caldavTXT

object

internalDNS

string

nullable

externalDNS

string

nullable

carddavTXT

object

internalDNS

string

nullable

externalDNS

string

nullable

autodiscoverSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

ip

string

nullable

submissionSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

imapSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

imapsSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

pop3SRV

object

internalDNS

string

nullable

externalDNS

string

nullable

pop3sSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

caldavSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

caldavsSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

carddavSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

carddavsSRV

object

internalDNS

string

nullable

externalDNS

string

nullable

Example^generated

{
  "localIp": "example",
  "externalIp": "example",
  "mxRecords": {
    "internalDNS": "example",
    "externalDNS": "example",
    "mxDomain": "example",
    "reverseLookup": "example"
  },
  "autodiscover": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "autoconfig": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "txt": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "dkim": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "dmarc": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "caldavTXT": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "carddavTXT": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "autodiscoverSRV": {
    "internalDNS": "example",
    "externalDNS": "example",
    "ip": "example"
  },
  "submissionSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "imapSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "imapsSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "pop3SRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "pop3sSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "caldavSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "caldavsSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "carddavSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  },
  "carddavsSRV": {
    "internalDNS": "example",
    "externalDNS": "example"
  }
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}