1.2.39 /api/v1/restart

This API end point lets you send a restart command to a given M&C.

Supported HTTP methods: PUT, HEAD, OPTIONS

PUT /api/v1/restart/{mncName}

Sends a restart command to the given M&C.

Parameters:

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

Expected Payload: A RestartCmd document with cmd set to 'RESTART'. With other values of cmd the restart command is ignored.

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

Return Codes:

Code Description
200 OK, the echoed RestartCmd document is returned.
400 Either the RestartCmd passed to the call did not contain cmd=RESTART or the requested M&C system is offline and cannot be restarted. In this case an ApiError document is returned, describing details of the error.
404 The requested M&C system does not exist. 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.