Demo
Demo

Knowledge base

PMTA knowledge base›API endpoint§ 5.11

Return a node file

critical

/getFile
Logs and accounting over the network

Returns a log or accounting file by name — the one the “Logs” page offers for download.

The call is GET /getFile?file=log.txt, where log.txt is a file name from the /logs list. There is no format parameter: the file itself arrives.

A way to read the log without logging into the machine. ⚠️ And at the same time a way to read it for anyone who has reached the monitor port: logs and accounting hold recipient addresses and receiver replies.

To cut off files while keeping the monitor, use the deny-logs qualifier on the monitor level in http-access.

The key from http-api-key in the X-API-Key header grants full access from any address.

The main trap is opening the files along with the monitor. The monitor level without the deny-logs qualifier serves both logs and accounting: an address given “just a look at the queue” also gets recipients and receiver replies.
What the Hub does. It does not ask: accounting events reach the Hub as a stream through the webhook, and it computes the “Accounting statistics” summaries on the node itself over SSH. At the same time the Hub gives its own addresses in http-access the monitor level without deny-logs — the files are formally open to them.
Recommended values

What to ask this endpoint:

Question This one or not
log lines without logging into the machine yes
messages from previous days yes — through the accounting file, until it is deleted
which files exist no — /logs
The call address, the file parameter and the deny-logs qualifier come from the manual (§ 5.11, § 3.3.1.58.3). The split of questions and the conclusion about leaks are ours.
Example configuration
# download a log file by name from the list
curl -s 'http://127.0.0.1:8080/getFile?file=log.txt' -o log.txt
The name log.txt is the manual’s example; real names come from the /logs response.
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

4 relations

Does not work without

List of logs and accounting filesA neighboring catalog entry. § 5.11

Works together with

Figure out why a queue to one receiver is growingThe investigation in which this output is one of the steps. inference

Applies to

The node's own logThe file this output refers to. § 5.11

Where you can see it

LogsThe screen that shows the same thing to a human. § 5.11

Referenced from

Start a new log fileThe same thing, returned by a request. inference

How to check on the node
Check who the files are open to:
curl -s -o /dev/null -w "%{http_code}\n" 'http://127.0.0.1:8080/getFile?file=log.txt'
grep -n 'http-access' /etc/pmta/config
Code 200 from an outside address means the files are open to everyone the monitor is open to; close them with the deny-logs qualifier.
◇

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 log and accounting — two files and two different questionsThe engine keeps a separate log and a separate accounting file; the separation is made for the sake of format, performance and the ability to hand over the log without disclosing data.◇A file, a program or an endpoint — and a file under each of the threeThree ways to hand off accounting records; an endpoint still has a file underneath, which is deleted only after a successful send, and a non-2xx response triggers a retry.

In the Hub
Cost of a mistake
safe: a wrong value breaks nothing
Scenarios
Untangle a stuck queue · Collect telemetry
Priority
critical