The Set Debug Mode API

Using the Set Debug Mode API, you can set the debug mode of a collector.
METHOD PUT
URI 
https://<historianservername>/historian-rest-api/v1/collector/setdebugmode
SAMPLE URI 
https://<historianservername>/historian-rest-api/v1/collector/setdebugmode

Payload
{
   ?interfaceName":"RSSERVER2012-02_Simulation",
   ?debugMode ?:1                      
}
SAMPLE RESPONSE 
{
    "ErrorCode": 0,
    "ErrorMessage": ""
}
SAMPLE cURL COMMAND 
curl -i -H "Accept: application/json" -i -H "Content-Type: application/json" 
-H "Authorization: Bearer <TOKEN> -d  ?{ \ ?interfaceName\ ?:\ ?RSSERVER2012-02_Simulation \ ?,\ ?debugMode\ ?} -X PUT https://<historianservername>/historian-rest-api/v1/collector/setdebugmode

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
debugMode The debug log level for the collector. Yes
  • 0: Normal log level
  • 255: Debug log level

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.