Purge collected HDR files
delete
/rest/{version}/statistics/collections
Executes Historical Data Records collection command to purge all HDR files. This operation deletes all data files but does not stop HDR collection.
This API is only available for SBC and ESBC.
Request
Path Parameters
-
version:
REST API version string.
Available values: v1.2
Header Parameters
-
Authorization:
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.
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
Resource not found
Examples
Example of Accessing the API with cURL
The following example shows how to purge collected HDR files from the SBC 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://${SBCIP}/rest/v1.1/statistics/collections"
Example of Accessing the API with Python
The following example shows how to purge collected HDR files from the SBC 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://" + sbcip + "/rest/v1.1/statistics/collections"
resp = requests.delete(url, headers=headers)
Example of the Response Body
This endpoint does not return a response body.