List the configured SNMP destination profiles

List the configured SNMP destination profiles. Only admin users can retrieve this information.

Request

URI

GET

https://vrni.example.com/api/ni/settings/snmp/profiles

COPY

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns SnmpProfileListResponse of type(s) application/json

{
    "results": [
        {
            "entity_id": "snmp-er67ght8kn67",
            "nick_name": "Aws collector profile",
            "target_ip": "10.11.11.102",
            "target_port": 161,
            "snmp_version": "string",
            "snmp_v2c": {
                "community_string": "string"
            },
            "snmp_v3": {
                "username": "string",
                "context_name": "string",
                "authentication_type": "string",
                "authentication_password": "string",
                "privacy_type": "string",
                "privacy_password": "string"
            }
        }
    ],
    "total_count": 0
}

array of SnmpProfileResponse

results

Optional

results

integer

total_count

Optional

total_count

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

403

Forbidden

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details