8.2.37 /api/v1/debug

This API end point lets you send debug commands to the (already opened) debug terminal of a M&C.

Supported HTTP methods: POST, HEAD, OPTIONS

POST /api/v1/debug/{mncName}

Sends one line containing a debug command to the debug terminal of the given M&C. The websocket connection for the debug terminal must already be open to make the command work. Echoes the original command after the request has been processed.

Parameters:

Parameter Description
mncName The name of the M&C to send the debug command to.

Expected Payload: A DebugMessage document containing the line with the command to send.

Replied Payload: A copy of the DebugMessage which has been sent.

Return Codes:

Code Description
200 OK, the echoed DebugMessage document is returned.
404 The requested M&C system does not exist, is actually offline or another user is already connected to the debug terminal at this M&C. In this case an ApiError document is returned, describing details of the error.
401 Not logged in. In this case an ApiError document is returned, describing details of the error.