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

Get the metadata for a configuration element type

get

https://{managementIp}/rest/{version}/configuration/elementTypes/metadata

Retrieves the metadata (schema) for the specified configuration element type. The metadata enables the client to know the characteristics of each attribute/sub-element that comprises the element type, so the client can self-validate its instance data before submitting a POST or PUT request. Note that the values for certain metadata tags may vary based on the platform or entitlements of the target system, as certain attribute ranges depend on the platform. The metadata returned for a given element type by one system may not be identical to the metadata returned by a different system.

Request

Path Parameters
Query 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The metadata for the requested configuration element type is returned 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 : attributeMetadata
Type: array
Show Source
Nested Schema : attributeMetadata
Type: object

400 Response

The request is malformed in some way or is missing required information and therefore 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

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
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get the metadata for a configuration element type 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.1/configuration/elementTypes/metadata?elementType=access-control"

Example of Accessing the API with Python

The following example shows how to get the metadata for a configuration element type by submitting a GET 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
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://10.0.0.2/rest/v1.1/configuration/elementTypes/metadata?elementType=access-control"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Mon, 14 Jan 2019 15:17:31 GMT
Cache-Control: no-cache
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Mon, 14 Jan 2019 15:17:31 GMT
Transfer-Encoding: chunked
X-Appweb-Seq: 113

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>access-control</elementType>
    <singleInstance>false</singleInstance>
    <attributeMetadata>
      <name>realm-id</name>
      <help>ingress realm</help>
      <descriptions>name of realm for access control</descriptions>
      <required>true</required>
      <key>true</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>description</name>
      <help>access control description</help>
      <descriptions>access control description</descriptions>
      <required>false</required>
      <key>false</key>
      <valueType>string</valueType>
    </attributeMetadata>
    <attributeMetadata>
      <name>untrust-cac-failure-threshold</name>
      <help>allowed maximum cac failures within tolerance window, untrusted</help>
      <descriptions>
        <description>allowed maximum number of admission failures within tolerance window, untrusted</description>
        <description>e.g. 1000</description>
      </descriptions>
      <required>false</required>
      <key>false</key>
      <defaultValue>0</defaultValue>
      <valueType>uint</valueType>
      <validNumericRanges>
        <validNumericRange>
          <min>0</min>
          <max>4294967295</max>
        </validNumericRange>
      </validNumericRanges>
    </attributeMetadata>
  </data>
  <messages/>
  <links/>
</response>
Back to Top