1. REST API for Session Border Controller Release 8.3
  2. Tasks
  3. configuration

Update the boot parameters

put

https://{managementIp}/rest/{version}/configuration/bootparams

Updates the boot parameters. The client making the PUT request must already possess the configuration lock or the request fails. The client should first retrieve the full set of current boot parameters using /configuration/bootparams GET, update the desired parameter(s), then issue the PUT request with the complete set of boot parameters in the request payload.

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 /rest/{version}/auth/token request.
Supported Media Types
Request Body ()
Contains the full set of boot parameters retrieved using /configuration/bootparams GET.
Root Schema : schema
Type: object
Show Source
Nested Schema : bootparam
Type: array
Show Source
Nested Schema : NameValuePair
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Boot parameters successfully updated. The updated boot parameters are returned as a series of name-value pairs in the data section of the response.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : bootparams
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : NameValuePair
Type: object
Show Source

400 Response

One or more boot parameter names or values supplied by the client is not valid, or the request is malformed and cannot be processed.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

403 Response

This request requires the client credentials to have administrator privileges.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
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: array
Show Source
Nested Schema : items
Type: object
Show Source

423 Response

The request requires the configuration lock and failed because the client does not currently own the lock. If another client or user currently owns the configuration lock, the error message is "Resource locked by another user". If no client or user owns the configuration lock, the error message is "User does not have the lock".
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to update the boot parameters by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X PUT \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/configuration/bootparams"

The following shows an example of the contents of the request.xml file sent as the request body. 

<?xml version="1.0" encoding="UTF-8"?>
<bootparams>
 <bootparam>
   <name>Target Name</name>
   <value>PRIMARY</value>
 </bootparam>
</bootparams>

Example of Accessing the API with Python

The following example shows how to update the boot parameters by submitting a PUT 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
from lxml import etree
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
data = etree.tostring(etree.parse("request.xml"))
url  = "https://10.0.0.2//rest/v1.1/configuration/bootparams"
resp = requests.put(url, headers=headers, data=data)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Fri, 11 Jan 2019 17:59:52 GMT
Cache-Control: no-cache
Content-Length: 237
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Fri, 11 Jan 2019 17:59:52 GMT
X-Appweb-Seq: 25

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>
    <bootparams>
      <bootparam>
        <name>Target Name</name>
        <value>PRIMARY</value>
      </bootparam>
    </bootparams>
  </data>
  <messages/>
  <links/>
</response>
Back to Top