1. REST API for Enterprise Communications Broker Release 3.3.0
  2. Tasks
  3. configuration management

Delete saved backup configuration files

delete

/rest/{version}/configuration/management/files

Deletes a saved backup configuration file from the standard backup file directory (/code/bkups) in the file system.

For more information, see Deleting Configurations in the Maintenance and Troubleshooting Guide.

Request

Path Parameters
  • REST API version string.
    Available values: v1.1
Query Parameters
  • Specifies the backup file to delete. This parameter must specify a valid backup file located in the /code/bkups directory. The value should be the filename only; specifying a path in the filename results in an error.
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

File 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 saved backup configuration files 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/management/files?filename=backupRunningConfig.gz"

Example of Accessing the API with Python

The following example shows how to delete saved backup configuration files 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/management/files?filename=backupRunningConfig.gz"
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 22:41:14 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 22:41:14 GMT
X-Appweb-Seq: 137

Example of the Response Body

This endpoint does not return a response body.

Back to Top