Delete saved backup configuration files
delete
https://{managementIp}/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.
For more information, see Deleting Configurations in the Maintenance and Troubleshooting Guide.
Request
Path Parameters
-
version(required): string
REST API version string.
Available values: v1.2Allowed Values:[ "v1.2" ]
Query Parameters
-
filename(required): string
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
-
Authorization(required):
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 TopResponse
Supported Media Types
- application/xml
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.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
401 Response
Unauthorized - Request lacks valid authentication credentials.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
403 Response
This request requires the client credentials to have administrator privileges.
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
404 Response
File not found
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
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".
Nested Schema : data
Type:
object
Nested Schema : items
Type:
Show Source
object
-
link: string
If available, a message with possible valid API URL(s) for the client to invokeExample:
Available URL(s) message string
Examples
Examples of Accessing the API
See Authenticate for how to acquire a token.
The following example shows how to delete saved backup configuration files using curl.
curl -X DELETE \
--header "Accept: application/xml" \
--header "Authorization: Bearer $TOKEN" \
"https://${SBCIP}/rest/v1.2/configuration/management/files?filename=backupRunningConfig.gz"
The following example shows how to delete saved backup configuration files using Python.
import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url = "https://" + sbcip + "/rest/v1.2/configuration/management/files?filename=backupRunningConfig.gz"
resp = requests.delete(url, headers=headers)
Example of the Response Body
This endpoint does not return a response body.