1. REST API for Enterprise Communications Broker Release 3.3.0
  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
  • REST API version string.
    Available values: v1.1
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 /rest/{version}/auth/token request.
Back to Top

Response

204 Response

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

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

403 Response

This request requires the client credentials to have administrator privileges.

404 Response

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

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

Examples

Example of Accessing the API with cURL

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.1/configuration/configElements?elementType=access-control&realm-id=core&source-address=10.4.4.0/24&application-protocol=SIP&transport-protocol=TCP"

Example of Accessing the API with Python

The following example shows how to delete a single configuration element instance by submitting a DELETE 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/configElements?elementType=access-control&realm-id=core&source-address=10.4.4.0/24&application-protocol=SIP&transport-protocol=TCP"
resp = requests.delete(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Mon, 14 Jan 2019 16:11:46 GMT
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Mon, 14 Jan 2019 16:11:46 GMT
X-Appweb-Seq: 13

Example of the Response Body

This endpoint does not return a response body.

Back to Top