The Stop Collector API

Using the Stop Collector API, you can stop a collector.
METHOD PUT
URI 
https://<historianservername>/historian-rest-api/v1/collector/stop
SAMPLE URI 
https://<historianservername>/historian-rest-api/v1/collector/stop

Payload

{
“interfaceName":"<source server>_<type of the collector>_<destination server>"
“winUserName”:”TestAdmin”,
“winPassword”:”TestAdminPassword”                    
}
SAMPLE RESPONSE 
{
    "ErrorCode": 0,
    "ErrorMessage": null,
    "Data": "Collector Stop Initiated"
}
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" 
-H "Authorization: Bearer <TOKEN>” -d 
“{ \”interfaceName\”:\”<source server>_<type of the collector>_<destination server>\”}” 
-X PUT https://<historianservername>/historian-rest-api/v1/collector/stop

Query Parameters

Query parameters include the Payload parameter, which is a JSON file, which contains the following properties.

Parameter Description Required? Values
interfaceName The interface name of the collector. Yes String
winUserName The Windows username. Yes (only if you want to use the command-line mode) String
winPassword The Windows password Yes (only if you want to use the command-line mode) String

Response Parameters

Parameter Data Type Required? Description
ErrorCode Integer Yes For example, ErrorCode = 0 implies the operation was successful.
ErrorMessage String Yes For example, NULL.
Data String No Indicates if the task has been initiated.