Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function reboots the server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/reboot?force=0
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/reboot?force=0
 Command Line
whmapi0 reboot force=0

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "reboot":"normal"
}
 Output (XML)
<reboot>
    <reboot>normal</reboot>
</reboot>

   

Parameters

ParameterTypeDescriptionPossible valuesExample
forceBoolean

Whether to use a forceful reboot.

Warning:

A forceful reboot may result in data loss if there are active processes.

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

 

Returns

ReturnTypeDescriptionPossible valuesExample

reboot

string

The server's hostname.

 

normal

normal