1. REST API for Session Border Controller Release 8.2
  2. Tasks
  3. admin

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 able to respond to requsts again, the client can issue requests periocally until a request no longer times out.

Request

Path Parameters
Header Parameters
  • 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 /auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

202 Response

Reboot request received; reboot begins within five seconds of the response being sent to the client
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : messages
Type: object

400 Response

The request is malformed or missing required information.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

401 Response

The client is not authorized.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

403 Response

This request requires the client to have administrator privileges.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

404 Response

Unsupported versionId in URI
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

500 Response

System is unable to execute the reboot due to some internal failure.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source
Back to Top

Examples

The following example shows how to reboot the system by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -X POST \
    --header 'Accept: application/xml' \
    --header 'Authorization: Bearer <token>' \
    'https://10.0.0.2/rest/v1.0/admin/reboot'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Tue, 07 Aug 2018 12:18:08 GMT
Cache-Control: no-cache
Content-Length: 158
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Tue, 07 Aug 2018 12:18:08 GMT
X-Appweb-Seq: 5

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data/>
  <messages/>
  <links>
    <link>Rebooting in 5 seconds</link>
  </links>
</response>
Back to Top