Get Intent

Get Intent

Intent Fetch

Request
URI
GET
https://{api_host}/api/ni/alert-configs/intents/{id}
COPY
Path Parameters
string
id
Required

The Entity ID of object requestion information on

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AlertConfigIntentObject of type(s) application/json 
{
    "name": "mtuCheck",
    "alertType": "Intent",
    "intentTypeId": "MtuMismatch",
    "filterRules": {
        "isValid": "string",
        "filterType": "string",
        "rules": [
            {
                "membership": {
                    "membershipType": "string",
                    "objectType": 0,
                    "entities": [
                        {
                            "modelKey": "string",
                            "name": "string"
                        }
                    ],
                    "query": "string"
                }
            }
        ]
    },
    "paramValues": [
        {
            "id": "min-violation-duration",
            "values": "VIOLATION_DURATION_FIVE_MINUTES",
            "valueType": "FIXED_MULTI_CHOICE_SINGLE_VALUE"
        }
    ],
    "selected_scope": "All Applications",
    "description": "Monitor traffic rate and total bandwidth for applications",
    "enabled": true,
    "severity": "Info",
    "notes": "Mtu check",
    "tags": [
        " [\"Device Health\", \"MTU\", \"dummy\"]"
    ],
    "notificationSettings": [
        {
            "type": "string",
            "frequency": "string",
            "enabled": true,
            "receivers": [
                "string"
            ],
            "schedule": [
                {
                    "type": "string",
                    "periodInMS": 0,
                    "startTimestamp": 0
                }
            ]
        }
    ]
}
string
name
Optional

Intent name

string
alertType
Optional

Intent type

string
intentTypeId
Optional

Intent type

Possible values are : MtuMismatch, HsrpStpColocation, PortModeMismatch, Reachability, Segmentation, NativeVlanMismatch, TrunkPortVlanMismatch, DuplexMismatch, PortChannelMismatch, DuplicateMacAddress, DuplicateIPAddress, StpMetricInconsistency, StigAccountPasswd, StigConsolePasswd, StigDefaultPasswd, StigMgmtPasswd, StigPlaintextPasswd, Loop,
object
filterRules
Optional

filterRules

array of IntentParam
paramValues
Optional

Intent parameters

string
selected_scope
Optional

Intent scope

string
description
Optional

Intent description

boolean
enabled
Optional

enabled

string
severity
Optional

Intent severity

Possible values are : Warning, Critical, Moderate, Info,
string
notes
Optional

Intent notes

array of string
tags
Optional

Intent tags

array of IntentNotification
notificationSettings
Optional

notificationSettings


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

Un-authorized

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

Intent 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


500

Internal Error

Operation doesn't return any data structure

On This Page
Intents Operations
POST
Create Intent
DELETE
Delete Intent
GET
Get Intent
POST
Intent Disable
POST
Intent Enable
PUT
Update Intent