API Reference

MXHook provides a REST API for managing domains, routes, messages, and the dead letter queue.

Base URL

http://localhost:8080

Authentication

All endpoints (except /health and /openapi.yaml) require an API key when one is configured:

X-API-Key: your-api-key

See Authentication for details.

Endpoints

Domains

Method	Path	Description
GET	/domains	List domains
POST	/domains	Create domain
DELETE	/domains/{id}	Delete domain

Routes

Method	Path	Description
GET	/routes	List routes
POST	/routes	Create route
DELETE	/routes/{id}	Delete route

Messages

Method	Path	Description
GET	/messages	List messages
GET	/messages/{id}	Get message

Dead Letter Queue

Method	Path	Description
GET	/dlq	List DLQ entries
DELETE	/dlq/{id}	Remove DLQ entry

Replay

Method	Path	Description
POST	/replay/{id}	Replay message

System

Method	Path	Description
GET	/health	Health check (no auth required)
GET	/openapi.yaml	OpenAPI 3.1 specification (no auth required)

Error Format

All errors return a JSON object:

{
  "error": "description of what went wrong"
}

OpenAPI Specification

The full OpenAPI 3.1 spec is available at /openapi.yaml on any running MXHook instance.