Knowledge base
Run a command over the networkcriticalAPI endpointRuns a node console command passed in the request and returns the result as a structure or as text.Return a node filecriticalAPI endpointReturns a log or accounting file by name from the /logs list.Details of one queuecriticalAPI endpointReturns one queue with short histories: the latest recipient events, errors and mode changes.The whole node state in one documentcriticalAPI endpointReturns the status page as a structure in XML or JSON: product, license, machine, traffic, connections, resolver, queues, spool and the running flag — in one response.Address lists through the configuration APIcriticalAPI endpointCreates, reads, extends and deletes address and domain lists — for suppression, for example — without editing files.Replace the configuration file over the networkAPI endpointWrites one or more configuration files to the node — without checking the contents and without reloading.Read the configuration file over the networkAPI endpointReturns the contents of a configuration file from /etc/pmta/ — the file itself or as a string inside JSON.Messages in the queueAPI endpointLists messages in the selected queues, filtered by job, envelope, recipient and sender.List of logs and accounting filesAPI endpointLists the log and accounting files the monitor can serve; the contents themselves come through /getFile.Queues with the most recipientsAPI endpointReturns the top queues — “receiver and sending address” pairs — by number of recipients; the queue parameter narrows the selection.Receiver policy inside an addressAPI endpointCreates, reads, extends and deletes receiver blocks inside a sending address created through the API.Sending addresses through the configuration APIAPI endpointCreates, reads, extends and deletes sending addresses with requests — as directive lines in JSON.List of configuration filesAPI endpointLists the node’s active configuration files: the main one, the included ones and the defaults file.Details of one receiverAPI endpointReturns the state of one recipient domain.Receivers with the largest queueAPI endpointReturns the recipient domains with the largest queue, summing all sending addresses for each.Addresses present on the machineAPI endpointLists the addresses configured on the machine itself.JobsAPI endpointReturns jobs that have mail in the queue, as a top; /jobDetail returns one job.Sending addresses that have a queueAPI endpointReturns sending addresses that currently have mail in the queue, by number of recipients in descending order.Submitting a message over HTTPAPI endpointAccepts a message as a JSON request over HTTPS instead of an SMTP session — with recipients, substitutions and content.Web monitor rootAPI endpointReturns the monitor’s start page as a structure: installation information and the top queue domains.