Poll Masks For Affected Polling Groups

API to check the polling groups associated with the masks selected. This is to check the masks before deleting them

Request

URI

POST

https://{api_host}/tcsa/api/v1/snmp/masks/poll

COPY

Query Parameters

string

snmpIntegration

Optional

The name of the current snmp integration

Request Body

The list of Snmp masks to be deleted

Array of string of type(s) application/json

Optional

[
    "mask1",
    "mask2"
]

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

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

Returns Array of PollObject of type(s) application/json

[
    {
        "name": "CISCO-MEMORY-OLD",
        "pollingGroups": [
            "GEN-M6LI43PGZJ-200",
            "GEN-KZI0DGUWZ6-100",
            "GEN-RJNRKLWV65-300",
            "GEN-3R67JAUTFH-65",
            "GEN-WK4U77IIEP-150",
            "GEN-LVM1OJXVO0-300"
        ]
    }
]

400

BAD REQUEST Error in 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/masks/poll

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Snmp Operations

POST

Initialize Snmp Collector