Poll Collectors For Affected Polling Groups

Poll Collectors For Affected Polling Groups

API to check the polling groups associated with the collectors selected. This is used to inform the user about the polling groups affected before deleting a collector.

Request
URI
POST
https://{api_host}/tcsa/api/v1/snmp/collector/poll
COPY
Query Parameters
string
snmpIntegration
Optional

The name of the current snmp integration

snmpIntegration example
snmp-integration

Request Body

The list of colelctors to be deleted

Array of string of type(s) application/json
Optional
[
    "snmp-collector"
]
Authentication
This operation uses the following authentication methods.
Responses
200

OK Returned map of all the collectors and their affected polling groups.

Returns Array of PollObject of type(s) application/json
[
    {
        "name": "snmp-collector",
        "pollingGroups": [
            "GEN-WF7D2O658D-300"
        ]
    }
]

400

BAD REQUEST Error in the request sent

Returns SnmpError of type(s) application/json
"SnmpError Object"
string
code
Optional

This code refers to the internal error codes used in the code base.

string
reason
Optional

This specifies the reason for failure.

string
status
Optional

This specifies the HTTP status code error


500

INTERNAL SERVER ERROR Error on the server

Returns SnmpError of type(s) application/json
"SnmpError Object"
string
code
Optional

This code refers to the internal error codes used in the code base.

string
reason
Optional

This specifies the reason for failure.

string
status
Optional

This specifies the HTTP status code error


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/tcsa/api/v1/snmp/collector/poll