The Delete Instance API

Using the Delete Instance API, you can delete a collector instance.
METHOD PUT
URI 
https://<historianservername>/historian-rest-api/v1/collector/deleteinstance
SAMPLE REQUEST 
https://<historianservername>/historian-rest-api/v1/collector/deleteinstance
Payload
{
"interfaceName":"<source server>_<type of the collector>_<destination server>",
"deleteTags":true
}
SAMPLE RESPONSE 
{
"ErrorCode":0,
"ErrorMessage":null,
}
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>\",\"deleteTags\":true}” -X PUT 
https://<historianservername>/historian-rest-api/v1/collector/deleteinstance

Query Parameters

Parameter Description Required? Values
interface name The interface name of the collector whose details you want to delete. Yes String
deleteTags Identifies whether you want to delete the tags. The valid values are true and false. Yes Boolean

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.