Demo
Demo

Knowledge base

PMTA knowledge base›API endpoint§ 5.5

Details of one receiver

/domainDetail
A breakdown for one domain

Returns the state of one recipient domain.

The call is GET /domainDetail?format=json&domain=gmail.com.

The manual does not describe the response fields — only the call address. What exactly arrives is checked on your own node, not taken from the description.

Access is decided by http-access based on the address the request came from — the monitor level is enough for reading. The key from http-api-key in the X-API-Key header grants full access from any address.

The main trap is expecting a breakdown by sending address. The domains section adds up a receiver’s mail from all its queues. If the receiver refuses only one address, this dissolves in the sum — such a question is asked of /queues with a “domain/*” pair.
What the Hub does. It does not ask: /domains is enough for the “PMTA monitoring” screen, and the screen does not show details of a single receiver.
Recommended values

What to ask this endpoint:

Question This one or not
what is going on with one receiver overall yes
which sending address it refuses no — /queues with a “domain/*” pair
all receivers at once no — /domains, as a top
what happened yesterday no — that is accounting
The call address and the domain parameter come from the manual (§ 5.5.1). The split of questions is ours; the manual does not describe the response contents.
Example configuration
# one receiver
curl -s 'http://127.0.0.1:8080/domainDetail?format=json&domain=gmail.com'
The manual does not give the response contents — the first call on your own node is the field description.
yellow — — directive names, blue — blocks. They are highlighted the same way in the text of the card.
Compatibility
PowerMTA 6.0
described in the manual of this version · platform: any
The vendor does not state the first version for every directive — there is no note here. The name also appears in the 5.0 edition of the manual.
⇄

Related entries

1 relation

Where you can see it

Receivers summed across all sending addressesThe screen that shows the same thing to a human. § 5.5

How to check on the node
Look at the response and compare it with the console:
curl -s 'http://127.0.0.1:8080/domainDetail?format=json&domain=gmail.com' | head -60
pmta show domains --errors gmail.com
If the console sees the domain but the request returns nothing, check the domain spelling and the requesting address’s permissions in http-access.
◇

What else to read

3 articles

◇What the node tells about itself and through which channelsSeven observation surfaces: the web monitor, the console in four formats, the log, accounting, accounting search, metrics and export to external analytics.◇The watchdog that restarts the engineKeeps an eye on the engine and brings it back up after a crash by itself, sending a crash report to the postmaster address.◇How the policy for a receiver is assembledSettings are assembled from the most general pattern to the most precise; the order of blocks in the file means nothing.

In the Hub
Cost of a mistake
safe: a wrong value breaks nothing
Scenarios
Troubleshoot deliverability