REST API Reference

This section describes the endpoints implemented by ScaleOut Messaging REST service.

HTTP Methods

POST /Messages/{module}/{instanceId}

Sends a JSON-formatted event or message in the request body to the specified Module instance for processing.

Parameters

  • module (string) – Name of the module to which to send the event.

  • instanceId (string) – Unique ID of the module instance to which to send the event.

Query Parameters

  • apiKey (string) – Optional API key used for authorization.

Status Codes

  • 200 OK – The message was successfully delivered to and processed by the Module instance.

  • 202 Accepted – The message was accepted for processing by the Module instance, but processing has not yet completed.

  • 400 Bad Request – The message could not be sent to the Module instance.

  • 401 Unauthorized – The API key was invalid.

  • 413 Request Entity Too Large – The message payload was larger than 64KB.