Skip to content
MailDock Docs

/domains/{id}/tls-rpt

GET
/domains/{id}/tls-rpt
curl --request GET \
  --url 'https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tls-rpt?days=30' \
  --header 'Authorization: Bearer <token>'

SMTP TLS Reporting (RFC 8460) for the window: session totals, failure types with the sending hosts that hit them, and per-reporter breakdown.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

Section titled “Query Parameters”
days
integer
default: 30 >= 1 <= 365

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
days
required
integer
>= -9007199254740991 <= 9007199254740991
reports
required
integer
>= -9007199254740991 <= 9007199254740991
successfulSessions
required
integer
>= -9007199254740991 <= 9007199254740991
failedSessions
required
integer
>= -9007199254740991 <= 9007199254740991
policyTypes
required
Array<string>
failures
required
Array<object>
object
resultType
required
string
sessions
required
integer
>= -9007199254740991 <= 9007199254740991
sendingHosts
required
Array<string>
reporters
required
Array<object>
object
orgName
required
string
successfulSessions
required
integer
>= -9007199254740991 <= 9007199254740991
failedSessions
required
integer
>= -9007199254740991 <= 9007199254740991
lastReport
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
latest
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
orgName
required
string
begin
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
end
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
successfulSessions
required
integer
>= -9007199254740991 <= 9007199254740991
failedSessions
required
integer
>= -9007199254740991 <= 9007199254740991
receivedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
Examplegenerated
{
  "days": 1,
  "reports": 1,
  "successfulSessions": 1,
  "failedSessions": 1,
  "policyTypes": [
    "example"
  ],
  "failures": [
    {
      "resultType": "example",
      "sessions": 1,
      "sendingHosts": [
        "example"
      ]
    }
  ],
  "reporters": [
    {
      "orgName": "example",
      "successfulSessions": 1,
      "failedSessions": 1,
      "lastReport": "2026-04-15T12:00:00Z"
    }
  ],
  "latest": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "orgName": "example",
      "begin": "2026-04-15T12:00:00Z",
      "end": "2026-04-15T12:00:00Z",
      "successfulSessions": 1,
      "failedSessions": 1,
      "receivedAt": "2026-04-15T12:00:00Z"
    }
  ]
}