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

Delete a single configuration element instance

delete

/rest/{version}/configuration/configElements

Deletes the specified configuration element instance in the system configuration. The client making the DELETE request must already possess the configuration lock or the request fails. For configuration element types that are singletons, which have no key attributes, the only query parameter included in the URI is elementType. For element types that can have multiple instances, the query string must include &name=value for each key attribute, where name is a key attribute name and value is the associated value. The order of the key attributes in the query string does not matter. The key attributes for an element type are identified in the metadata (/configuration/elementTypes/metadata).

Request

Path Parameters
Query Parameters
  • Indicates the configuration element type being deleted.
  • Specifies the name and value for one key attribute of the elementType. For elementTypes having multiple key attributes, each one must be represented by "&name=value" in the query string. This query parameter is omitted entirely for singleton element types, which by definition have no key attributes.
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

204 Response

Successful deletion of the requested instance. There is no response body for a succesful delete.

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

403 Response

This request requires the client to have administrator privileges.
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, or requested element type not supported, or element instance specified by key attribute(s) not found
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
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: object
Show Source
Back to Top

Examples

The following example shows how to delete a single configuration element instance by submitting a DELETE request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -X DELETE \
    --header 'Accept: application/xml' \
    --header 'Authorization: Bearer <token>' \
    'https://10.0.0.2/rest/v1.0/configuration/configElements?elementType=ntp-config'

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Wed, 08 Aug 2018 12:20:18 GMT
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Wed, 08 Aug 2018 12:20:18 GMT
X-Appweb-Seq: 139

Example of the Response Body

This endpoint does not return a response body.

Back to Top