Making a POST request to this endpoint allows the system operator to administratively bounce messages that match certain criteria, or if no criteria are provided, ALL messages.
There is no way to undo the actions carried out by this request!
The body of the post request must be a JSON object; here's an example:
and the response will look something like this, with an entry for each matching queue name and the count of matching messages that were bounced:
The following fields are possible in the request:
Optional string. The domain name to match. If omitted, any domain will match.
Since: Version 2023.08.22-4d895015
The functionality described in this outlined box requires version 2023.08.22-4d895015 of KumoMTA, or a more recent version.
Optional string. The routing_domain name to match. If omitted, any routing_domain will match.
Optional string. The campaign name to match. If omitted, any campaign will match.
Optional string. The tenant to match. If omitted, any tenant will match.
If you specify none of
ALL queues will be bounced.
With great power, comes great responsibility!
Required. Reason to log in the delivery log.
Optional duration string. Defaults to
Specifies how long this bounce directive remains active.
While active, newly injected messages that match the bounce criteria will also be bounced.
In addition to making raw API requests, you may use the kumo CLI:
kcli bounce --help for more informtion.