The relayer provides a comprehensive HTTP API for inspecting database contents and managing operations. Each endpoint below includes an interactive playground where you can test the API directly.Documentation Index
Fetch the complete documentation index at: https://docs.hyperlane.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Make sure to update the server URL to match your relayer instance before testing endpoints.
API Endpoints
The following endpoints are available for interacting with the relayer:Messages API
- Get Messages - Query messages by domain and nonce range in the database
- Insert Messages - Add new messages to the database
Operation Management
- List Operations - View pending messages in operation queues
- Retry Messages - Trigger retry of failed messages (resets retry count)
- Reprocess Message - Re-queue messages for processing on demand
Retry vs Reprocess: Retry handles failed messages currently in the operation queues (memory), while reprocess re-queues messages from the database (storage) for processing - either already-delivered messages that need reprocessing or to allow external services to trigger message delivery instead of relying on queue backoff.
Data Inspection
- Get Merkle Tree Insertions - Query merkle tree insertion in the database
- Insert Merkle Tree Insertions - Insert merkle tree insertion
IGP Management
- List IGP Rules - View current gas payment rules
- Add IGP Rule - Create new gas payment rules
- Remove IGP Rules - Delete existing gas payment rules
IGP endpoints are only available when gas enforcers are configured (
mod.rs:82-83).