Reboot the system
post
/rest/{version}/admin/reboot
Reboots the system. Before rebooting itself, the system sends an immediate response to the client, indicating the reboot request was received. To determine when the reboot has completed and the system is again able to respond to requests, the client can issue requests periodically until a request no longer times out.
Request
Path Parameters
-
version(required):
REST API version string.
Available values: v1.2
Header Parameters
-
Authorization(required):
The value in the Authorization header must be the string "
Bearer {access token}", where{access token}is a valid, unexpired token received in response to a prior/rest/{version}/auth/tokenrequest.
Response
202 Response
Reboot request received; reboot begins within five seconds of the response being sent to the client
400 Response
The request is malformed in some way or is missing required information and therefore cannot be processed.
401 Response
Unauthorized - Request lacks valid authentication credentials.
403 Response
This request requires the client credentials to have administrator privileges.
404 Response
Unsupported versionId in URI.
500 Response
System is unable to execute the reboot due to some internal failure.
Examples
Examples of Accessing the API
See Authenticate for how to acquire a token.
The following example shows how to reboot the system using curl.
curl -X POST \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://${SBCIP}/rest/v1.1/admin/reboot"The following example shows how to reboot the system using Python.
import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url = "https://" + sbcip + "/rest/v1.1/admin/reboot"
resp = requests.post(url, headers=headers)Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
<data/>
<messages/>
<links>
<link>Rebooting in 5 seconds</link>
</links>
</response>