Jump to

• Request
• Response
• Examples

Start, stop or restart HDR collection

put

/rest/{version}/statistics/collections

Executes Historical Data Records (HDR) collection command to start, stop or restart collection on one or all collection groups.

This API is only available for SBC and ESBC.

Request

Path Parameters

• version:
  REST API version string.
  Available values: v1.2

Query Parameters

• action:
  Collection action to take on data collections.
  Available values: start, stop, restart
• collectionObject(optional):
  Optional parameter to specify the collection group. This parameter is only valid for the "start" and "stop" collection actions. If this parameter is not specified, action is taken on all collection groups. The "restart" action is always taken on all collection groups.

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.

Back to Top

Response

200 Response

OK - Request successful

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

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to start, stop or restart HDR collection by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PUT \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/statistics/collections?action=start&collectionObject=fan"

Example of Accessing the API with Python

The following example shows how to start, stop or restart HDR collection by submitting a PUT 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?action=start&collectionObject=fan"
resp = requests.put(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 10:58:18 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>Collection process started</data>
  <messages/>
  <links/>
</response>

Back to Top