Skip to content

GET /api/admin/inspect-message/v1

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.

Retrieve information about a message given its spool id.

This API endpoint is used by the kcli inspect-message command.

Query Parameters

  • id - required SpoolId. The spool identifier for the message whose information is being requested
  • want_body - optional boolean. If true, return the message body in addition to the metadata

Responses

Status 200

Obtained message information

Content-Type: application/json

This is an object value, with the following properties:

Examples

{
  "id": "d7ef132b5d7711eea8c8000c29c33806",
  "message": {
    "data": "From: user@example.com\nSubject: Hello\n\nHello there",
    "due": "1990-12-31T23:59:60Z",
    "meta": {},
    "num_attempts": 42,
    "recipient": "recipient@example.com",
    "scheduling": {},
    "sender": "sender@sender.example.com"
  }
}