REST API for Session Border Controller Release 8.2

Update the boot parameters

put

/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

version: string

For this release, the value is "v1.0".

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

Supported Media Types

application/xml

Contains the full set of boot parameters retrieved using /configuration/bootparams GET.

Root Schema : schema

Type: object

Show Source

bootparam(optional): array bootparam

{
    "xml":{
        "name":"bootparams"
    },
    "type":"object",
    "properties":{
        "bootparam":{
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            },
            "type":"array"
        }
    }
}

Nested Schema : bootparam

Type: array

Show Source

Array of: object NameValuePair

{
    "items":{
        "$ref":"#/components/schemas/NameValuePair"
    },
    "type":"array"
}

Nested Schema : NameValuePair

Type: object

Show Source

name: string
value:

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"integer"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    }
}

Response

Supported Media Types

application/xml

200 Response

Boot parameters succesfully updated. The updated boot parameters are returned as a series of name-value pairs in the <data> section of the response.

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/components/schemas/BootparametersInData"
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Show Source

bootparams: array bootparams

{
    "xml":{
        "name":"data"
    },
    "required":[
        "bootparams"
    ],
    "type":"object",
    "properties":{
        "bootparams":{
            "items":{
                "type":"object",
                "properties":{
                    "bootparam":{
                        "$ref":"#/components/schemas/NameValuePair"
                    }
                }
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : bootparams

Type: array

Show Source

Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "bootparam":{
                "$ref":"#/components/schemas/NameValuePair"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

bootparam(optional): object NameValuePair

{
    "type":"object",
    "properties":{
        "bootparam":{
            "$ref":"#/components/schemas/NameValuePair"
        }
    }
}

Nested Schema : NameValuePair

Type: object

Show Source

name: string
value:

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"integer"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    }
}

400 Response

The request is malformed. For example, a bootparameter name or value may be invalid.

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

401 Response

The client is not authorized.

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

403 Response

This request requires the client to have administrator privileges.

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

404 Response

Unsupported versionId in URI.

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

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".

Root Schema : response

Type: object

Show Source

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

{
    "xml":{
        "name":"response"
    },
    "required":[
        "data",
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Show Source

errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string"
        }
    }
}

Examples

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 \
    --header 'Accept: application/xml' \
    --header 'Authorization: Bearer <token>' \
    -d@request.xml \
    'https://10.0.0.2/rest/v1.0/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>

Note:

Dropping the '<?xml version="1.0" encoding="UTF-8"?>' in the request gives a 204 response but fails to make the change.

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 07 Aug 2018 21:28:23 GMT
Cache-Control: no-cache
Content-Length: 237
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Tue, 07 Aug 2018 21:28:23 GMT
X-Appweb-Seq: 87

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>