CLclover
DEVICE

Send device debug logs

Allows a developer to remotely trigger a Clover device to send its debug logs to Clover's servers. The message in the request body is logged to the device log, allowing developers to mark specific sequences for easier troubleshooting.

Note: This endpoint is rate-limited to one successful request every 30 minutes per device to prevent server overload. It is intended for REST API integrations like Cloud Pay Display.

post/v1/device/send-debug

Request

  • Base URL
    https://deviceIpOrHost:12346/connect
  • URL
    https://deviceIpOrHost:12346/connect/v1/device/send-debug
  • Auth
    HTTP bearer

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

X-Clover-Device-Idstring required

The Clover device to route the request to.

X-POS-Idstring required

An identifier for the POS making the request.

Request body

messagestring required

A custom string that is logged to the device log. Use this to mark a specific event or sequence in the logs for easier identification during troubleshooting.

Response

The request to send debug logs was successfully accepted by the server.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.