Delete Collector

Delete Collector

Delete a collector

Request
URI
DELETE
https://{api_host}/dcc/v1/collectors/{collector-name}
COPY
Path Parameters
string
collector-name
Required

ID of the instantiated collector

collector-name example
demo-collector

Authentication
This operation uses the following authentication methods.
Responses
200

returns message "collector successfully deleted"

Returns deleteBlockResponse of type(s) application/json
{
    "instanceId": "smarts-metrics035f8121-aaed-4d66-83eb-ae3a7841f720",
    "message": "Block instance successfully deleted",
    "time": "2019-04-09 05:42:21.204886"
}
string As ^.*$
instanceId
Required
Constraints: default:

Instance id of the collector object

string As ^.*$
message
Required
Constraints: default:

Message for the deletion of collector instance is successful

string As ^.*$
time
Required
Constraints: default:

Time of deletion in YYYY-MM-DD hh:mm:ss


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/dcc/v1/collectors/{collector-name}