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

Add a single configuration element instance

post

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

Adds a single instance of the specified configuration element type to the system configuration. The client making the POST request must already possess the configuration lock or the request fails. If the configuration element type is a singleton - meaning only one instance can exist in the system configuration - the instance must first be created using POST, supplying only the element type in the POST request. The instance can then be edited via a subsequent PUT request. For any element type that supports multiple instances, the key attribute(s) sent in the POST request must not duplicate the key attribute(s) for any already-configured instance. The client can supply as many non-key attributes and sub-elements in the POST request for an element type that supports multiple instances. If the client attempts to create a singleton element type that has already been created, or if the key attributes duplicate an existing instance, 409 Conflict is returned. If one or more attributes/sub-elements in the request is syntactically invalid in any way, the POST request fails and the system configuration is left unmodified.

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 ()
The client must supply the element type in all POST requests. If the element type being created is a singleton, no other information is required in the request body. If the element type being created can have multiple instances, the key attribute(s) for the type must be provided using tags.
Root Schema : schema
Type: object
Show Source
Nested Schema : attribute
Type: array
Show Source
Nested Schema : subElement
Type: array
Show Source
Nested Schema : NameValuePair
Type: object
Show Source
Nested Schema : items
Type: object
Back to Top

Response

Supported Media Types

200 Response

Successful creation of the requested instance. The complete configuration data (all supported attributes and sub-elements) are returned in the response body.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : configElement
Type: object
Show Source
Nested Schema : attribute
Type: array
Show Source
Nested Schema : subElement
Type: array
Show Source
Nested Schema : NameValuePair
Type: object
Show Source
Nested Schema : items
Type: object

400 Response

One or more attribute/sub-element values supplied by the client is not syntactically 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, or requested element type not supported.
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

409 Response

Attempt to create an existing singleton element type, or the supplied key attribute values already exist for a configured element instance.
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 add a single configuration element instance by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. 

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

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" standalone="yes"?>
<configElement>
  <elementType>access-control</elementType>
  <attribute>
    <name>realm-id</name>
    <value>core</value>
  </attribute>
  <attribute>
    <name>source-address</name>
    <value>10.4.4.0/24</value>
  </attribute>
  <attribute>
    <name>application-protocol</name>
    <value>SIP</value>
  </attribute>
  <attribute>
    <name>transport-protocol</name>
    <value>TCP</value>
  </attribute>
  <attribute>
    <name>access</name>
    <value>permit</value>
  </attribute>
</configElement>

Example of Accessing the API with Python

The following example shows how to add a single configuration element instance 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
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/configElements"
resp = requests.post(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: Mon, 14 Jan 2019 13:14:05 GMT
Cache-Control: no-cache
Content-Length: 2124
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Mon, 14 Jan 2019 13:14:05 GMT
X-Appweb-Seq: 97

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>
    <configElement>
      <elementType>access-control</elementType>
      <attribute>
        <name>realm-id</name>
        <value>core</value>
      </attribute>
      <attribute>
        <name>description</name>
        <value/>
      </attribute>
      <attribute>
        <name>source-address</name>
        <value>10.4.4.0/24</value>
      </attribute>
      <attribute>
        <name>destination-address</name>
        <value>0.0.0.0</value>
      </attribute>
      <attribute>
        <name>application-protocol</name>
        <value>SIP</value>
      </attribute>
      <attribute>
        <name>transport-protocol</name>
        <value>TCP</value>
      </attribute>
      <attribute>
        <name>access</name>
        <value>permit</value>
      </attribute>
      <attribute>
        <name>average-rate-limit</name>
        <value>0</value>
      </attribute>
       ...
      <attribute>
        <name>last-modified-date</name>
        <value>2019-01-14 13:14:05</value>
      </attribute>
    </configElement>
  </data>
  <messages/>
  <links/>
</response>
Back to Top