Get Polling Groups

Get Polling Groups

API to get a list of polling groups.

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/v1/snmp/pollingGroups
COPY
Query Parameters
integer
offset
Optional

Requested index for start of resources to be provided in response

integer
limit
Optional

Requested number of resources to be provided in response

string
snmpIntegration
Optional

The name of the current snmp integration

snmpIntegration example
snmp-integration

Authentication
This operation uses the following authentication methods.
Responses
200

OK Returned list of all polling groups

Returns Array of PollingGroupResponse of type(s) application/json
[
    {
        "snmpAgentsIPGroupNames": [],
        "pollingMaskNames": [
            "CISCO-MEMORY-OLD",
            "GENERIC-SYSUPTIME",
            "CISCO-MEMORY",
            "CISCO-PROCESS-POST12.2(3.5)",
            "GENERIC-INTERFACES"
        ],
        "pollingPeriod": 200,
        "startAtDefinedPeriod": false,
        "startTimeOffset": 0,
        "enabled": true,
        "assignedTo": "collector-b",
        "groupName": "group",
        "snmpAgentsExplicitGroupNames": [],
        "snmpAgentIps": [],
        "uniformTimestamps": false,
        "name": "GEN-M6LI43PGZJ-200",
        "oneOrNone": true,
        "snmpAgentNames": [
            "10.107.116.242:161"
        ],
        "tableDiscoveryTime": "00:00:00"
    },
    {
        "snmpAgentsIPGroupNames": [],
        "pollingMaskNames": [
            "CISCO-MEMORY-OLD",
            "GENERIC-SYSUPTIME",
            "CISCO-MEMORY",
            "CISCO-PROCESS-POST12.2(3.5)",
            "GENERIC-INTERFACES"
        ],
        "pollingPeriod": 100,
        "startAtDefinedPeriod": false,
        "startTimeOffset": 0,
        "enabled": true,
        "assignedTo": "snmp-collector",
        "groupName": "group",
        "snmpAgentsExplicitGroupNames": [],
        "snmpAgentIps": [],
        "uniformTimestamps": false,
        "name": "GEN-KZI0DGUWZ6-100",
        "oneOrNone": true,
        "snmpAgentNames": [
            "10.107.119.1:161"
        ],
        "tableDiscoveryTime": "00:00:00"
    }
]

400

BAD REQUEST Error in request sent

Returns SnmpError of type(s) application/json
{
    "code": "SNMP_COLLECTOR_API_006",
    "reason": "No Snmp collector running, discovery cannot be performed",
    "status": "404 Not Found"
}
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
{
    "code": "SNMP_COLLECTOR_API_006",
    "reason": "No Snmp collector running, discovery cannot be performed",
    "status": "404 Not Found"
}
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