REST API for Session Border Controller Release 8.3

Reboot the system

post

https://{managementIp}/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: string

REST API version string.
Available values: v1.1

Header Parameters

Authorization:

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/token request.

There's no request body for this operation.

Response

Supported Media Types

application/xml

202 Response

Reboot request received; reboot begins within five seconds of the response being sent to the client

Root Schema : response

Type: object

Show Source

data: string

Example: Rebooting in 5 seconds
links: object links
messages: object messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"string",
            "example":"Rebooting in 5 seconds"
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

Root Schema : response

Type: object

Show Source

data: object data
links: array links
messages: array messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            },
            "type":"array"
        },
        "links":{
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "type":"string",
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "example":"Available URL(s) message string"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "type":"string",
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "example":"Available URL(s) message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

link(optional): string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Root Schema : response

Type: object

Show Source

data: object data
links: array links
messages: array messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            },
            "type":"array"
        },
        "links":{
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "type":"string",
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "example":"Available URL(s) message string"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "type":"string",
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "example":"Available URL(s) message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

link(optional): string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

403 Response

This request requires the client credentials to have administrator privileges.

Root Schema : response

Type: object

Show Source

data: object data
links: array links
messages: array messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            },
            "type":"array"
        },
        "links":{
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "type":"string",
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "example":"Available URL(s) message string"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "type":"string",
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "example":"Available URL(s) message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

link(optional): string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Unsupported versionId in URI.

Root Schema : response

Type: object

Show Source

data: object data
links: array links
messages: array messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            },
            "type":"array"
        },
        "links":{
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "type":"string",
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "example":"Available URL(s) message string"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "type":"string",
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "example":"Available URL(s) message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

link(optional): string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

500 Response

System is unable to execute the reboot due to some internal failure.

Root Schema : response

Type: object

Show Source

data: object data
links: array links
messages: array messages

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            },
            "type":"array"
        },
        "links":{
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "type":"string",
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "example":"Available URL(s) message string"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "type":"string",
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "example":"Available URL(s) message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

link(optional): string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage(optional): string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

Examples

Example of Accessing the API with cURL

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.1/admin/reboot"

Example of Accessing the API with Python

The following example shows how to reboot the system by submitting a POST request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://10.0.0.2/rest/v1.1/admin/reboot"
resp = requests.post(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Fri, 04 Jan 2019 21:03:38 GMT
Cache-Control: no-cache
Content-Length: 158
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Fri, 04 Jan 2019 21:03:38 GMT
X-Appweb-Seq: 21

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>