DashboardApi

All endpoints are under /api/v1/dashboard. When Swagger is enabled, interactive documentation is available at /swagger.

Returns all registered connections with their queue counts.

Returns all queues for a specific connection.

Returns all scheduled jobs for a connection.

Returns message counts by status:

Returns which features are enabled for the queue (priority, status, heartbeat, etc.).

Returns a paged list of messages.

Returns the total message count, optionally filtered by status.

Returns a single message by ID.

Returns the decoded message body and type information. If the queue uses message interceptors, you must register the same interceptors on the dashboard so that it can decode the body. See Dashboard Configuration.

Returns the deserialized message headers.

Returns messages with stale heartbeats (Processing status, no heartbeat within the threshold).

Resets a stale message from Processing back to Waiting status. Returns 204 on success, 404 if not found.

Resets all stale messages from Processing back to Waiting status. Returns the count of reset messages.

Returns a paged list of error messages.

Returns the error retry history for a specific message.

Moves an error message back to Waiting status for reprocessing. Returns 204 on success, 404 if not found.

Requeues all error messages back to Waiting status. Returns the count of requeued messages.

Deletes all error messages for the queue. Returns the count of deleted messages.

Deletes a single message. Returns 204 on success, 404 if not found.

Updates a message body. The dashboard re-encodes the body with the queue's serialization and interceptors.

Request body:

{
  "body": "<JSON string>"
}

Returns the raw queue configuration as JSON.

Returns the maintenance service status for the queue. The status is only meaningful when HostMaintenance is enabled for the queue in the dashboard configuration. See Maintenance Mode.

Consumer tracking endpoints are available when EnableConsumerTracking is enabled (default: true). See Dashboard Client for a typed client that manages registration and heartbeats automatically.

Registers a consumer with the dashboard. Returns a ConsumerId and the recommended HeartbeatIntervalSeconds.

Request body:

{
  "queueName": "OrderQueue",
  "machineName": "WORKER-01",
  "processId": 12345,
  "friendlyName": "Worker-1"
}

Sends a heartbeat for a registered consumer. Call this endpoint at the interval returned during registration.

Request body:

{
  "consumerId": "guid"
}

Unregisters a consumer.

Returns all active consumers. Optionally filter by queue with ?queueId={guid}.

Returns a dictionary of consumer counts keyed by queue ID.

History endpoints return data only when IHistoryConfiguration.Enabled = true on the queue. When history is disabled, the list returns empty, the count returns 0, and the purge returns 0.

See Message History for configuration details.

Cancellation is cooperative: the message handler must check workerNotification.MessageCancellation.Token for it to take effect. Cancellation works only when the dashboard and the consumer run in the same process.