REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0

Update a single configuration element instance

put

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

Updates the specified configuration element instance in the system configuration. The client making the PUT request must already possess the configuration lock or the request fails. If the specified element instance is a singleton - meaning only one instance can exist in the system configuration - it must first have been created using POST. When editing any non-singleton element, the PUT request body must include the key attribute(s) that uniquely identify the instance being edited, as well as any attributes or sub-elements that are being changed. However, the client is free to send all of the element's attributes/sub-elements in the PUT request. Any attribute/sub-element in the request that is identical to the system configuration will be left unmodified in the system configuration. If one or more attributes/sub-elements in the request is syntactically invalid in any way, the PUT request fails and the system configuration is left unmodified.

Request

Path Parameters

version(required): string

REST API version string.
Available values: v1.2

Allowed Values: [ "v1.2" ]

Header Parameters

Authorization(required):

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

application/xml

Root Schema : schema

Type: object

Show Source

attribute: array attribute
elementType: string
subElement: array subElement

{
    "type":"object",
    "xml":{
        "name":"configElement"
    },
    "properties":{
        "elementType":{
            "type":"string"
        },
        "attribute":{
            "type":"array",
            "xml":{
                "wrapped":false
            },
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            }
        },
        "subElement":{
            "type":"array",
            "xml":{
                "wrapped":false
            },
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : attribute

Type: array

Show Source

Array of: object NameValuePair

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

Nested Schema : subElement

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "xml":{
        "wrapped":false
    },
    "items":{
        "type":"object"
    }
}

Nested Schema : NameValuePair

Type: object

Show Source

name(required): string
value(required): value

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

Nested Schema : value

Match One Schema

Show Source

string
integer
number
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ]
}

Nested Schema : items

Type: object

Response

Supported Media Types

application/xml

200 Response

Successful update of the requested instance. The complete configuration data (all supported attributes and sub-elements) are returned in the response body.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): object links
messages(required): object messages

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

Nested Schema : data

Type: object

Show Source

configElement(required): object configElement

{
    "type":"object",
    "xml":{
        "name":"data"
    },
    "required":[
        "configElement"
    ],
    "properties":{
        "configElement":{
            "type":"object",
            "required":[
                "elementType",
                "attribute"
            ],
            "properties":{
                "elementType":{
                    "type":"string"
                },
                "attribute":{
                    "type":"array",
                    "xml":{
                        "wrapped":false
                    },
                    "items":{
                        "$ref":"#/components/schemas/NameValuePair"
                    }
                },
                "subElement":{
                    "type":"array",
                    "xml":{
                        "wrapped":false
                    },
                    "items":{
                        "type":"object"
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : configElement

Type: object

Show Source

attribute(required): array attribute
elementType(required): string
subElement: array subElement

{
    "type":"object",
    "required":[
        "elementType",
        "attribute"
    ],
    "properties":{
        "elementType":{
            "type":"string"
        },
        "attribute":{
            "type":"array",
            "xml":{
                "wrapped":false
            },
            "items":{
                "$ref":"#/components/schemas/NameValuePair"
            }
        },
        "subElement":{
            "type":"array",
            "xml":{
                "wrapped":false
            },
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : attribute

Type: array

Show Source

Array of: object NameValuePair

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

Nested Schema : subElement

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "xml":{
        "wrapped":false
    },
    "items":{
        "type":"object"
    }
}

Nested Schema : NameValuePair

Type: object

Show Source

name(required): string
value(required): value

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

Nested Schema : value

Match One Schema

Show Source

string
integer
number
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"integer"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ]
}

Nested Schema : items

Type: object

400 Response

The request is missing required information and cannot be processed, or one or more attribute or sub-element names or values supplied by the client is not valid, or the request is malformed and cannot be processed.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link: 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":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: 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(required): object data
links(required): array links
messages(required): array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link: 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":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: 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(required): object data
links(required): array links
messages(required): array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link: 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":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

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

404 Response

Unsupported versionId in URI, or requested element type not supported, or element instance specified by key attribute(s) not found.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link: 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":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message 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(required): object data
links(required): array links
messages(required): array messages

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

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

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

Nested Schema : messages

Type: array

Show Source

Array of: object items

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

Nested Schema : items

Type: object

Show Source

link: 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":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

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

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

curl
Python

The following example shows how to update a single configuration element instance using curl.

curl -X PUT \
    -d@request.xml \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/configuration/configElements"

The following example shows how to update a single configuration element instance using Python.

import requests
from lxml import etree
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
data = etree.tostring(etree.parse("request.xml"), xml_declaration=True, encoding='utf-8')
url  = "https://" + sbcip + "/rest/v1.2/configuration/configElements"
resp = requests.put(url, headers=headers, data=data)

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>deny</value>
  </attribute>
</configElement>

Note:

This updates the access rule from 'permit' to 'deny'.

Example of the Response Body

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

<?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>deny</value>
      </attribute>
      ...
      <attribute>
        <name>last-modified-date</name>
        <value>2019-01-14 13:22:04</value>
      </attribute>
    </configElement>
  </data>
  <messages/>
  <links/>
</response>