GET /api/admin/task-dump

Info

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

Returns a dump of the runtime task state.

Since: Dev Builds Only

The functionality described in this section requires a dev build of KumoMTA. You can obtain a dev build by following the instructions in the Installation section.

The output is not machine parseable and may change without notice between versions of kumomta.

Capturing the dump is very expensive and can take several seconds. Capturing a dump is not guaranteed to succeed.

At the time of writing, capturing a dump can cause a subsequent graceful shutdown to get stuck, unless you repeatedly trigger this API endpoint a few more times to "clock through" the shutdown process and enable it to complete successfully.

Responses

Status 200

data was returned