Restart server

This function reboots the server.

Authorizations:
query Parameters
force
integer
Default: 0

Whether to use a forceful reboot.

  • 1 - Use a forceful reboot.
  • 0 - Do not use a forceful reboot.

Warning:

A forceful reboot may result in data loss if active processes exist on the server.

Enum: 0 1
Example: force=0

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  reboot

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "reboot",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}