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

Get a list of all supported configuration element types

get

/rest/{version}/configuration/elementTypes

Retrieves a list of all the configuration element types supported by the target system. The name string returned for each type is the string the client must use in all other REST requests where element type must be supplied. The platform and entitlements affect some of the configuration element types that are available, so the response from one system may not be identical to the response received from a different system.

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The name and description of each configuration element type supported by the target system is returned in the data section of the response. The string returned as the "name" value must be used by the client in all requests where element type must be supplied. Configuration element types that are singletons are indicated by the elementType attribute single="true".
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Show Source
Nested Schema : messages
Type: object
Nested Schema : elementTypes
Type: array
Show Source
Nested Schema : elementType
Type: object
Show Source

400 Response

The request is malformed or missing required information.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source

401 Response

The client is not authorized.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
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: object
Show Source
Back to Top

Examples

The following example shows how to get a list of all supported configuration element types by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -X GET \
    --header 'Accept: application/xml' \
    --header 'Authorization: Bearer <token>' \
    'https://10.0.0.2/rest/v1.0/configuration/elementTypes'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 Aug 2018 12:29:42 GMT
Cache-Control: no-cache
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 08 Aug 2018 12:29:42 GMT
Transfer-Encoding: chunked
X-Appweb-Seq: 145

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>
    <elementType>
      <name>access-control</name>
      <description>configure a static or dynamic access control list</description>
    </elementType>
    <elementType single="true">
      <name>account-config</name>
      <description>configure Quality of Service accounting</description>
    </elementType>
    <elementType>
      <name>account-group</name>
      <description>configure accounting group</description>
    </elementType>
    <!-- More elements not shown -->
  </data>
</response>
Back to Top