Get Intent
Intent Fetch
Request
URI
GET
https://vrni.example.com/api/ni/alert-configs/intents/{id}
COPY
Path Parameters
string
id
Required
The Entity ID of object requestion information on
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": "integer",
"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": [
[
"[email protected]"
]
],
"schedule": [
{
"type": "string",
"periodInMS": "integer",
"startTimestamp": "integer"
}
]
}
]
}
string
name
Optional
Intent name
string
alertType
Optional
Intent type
string
intentTypeId
Optional
Intent type
object
filterRules
Optional
filterRules
string
selected_scope
Optional
Intent scope
string
description
Optional
Intent description
boolean
enabled
Optional
enabled
string
severity
Optional
Intent severity
string
notes
Optional
Intent notes
array of string
tags
Optional
Intent tags
400
Bad Request
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
401
Un-authorized
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
404
Intent Not Found
Returns ApiError of type(s) application/json
{
"code": "integer",
"message": "string",
"details": [
{
"code": "integer",
"message": "string",
"target": [
"string"
]
}
]
}
integer As int32 As int32
code
Optional
code
string
message
Optional
message
500
Internal Error
Operation doesn't return any data structure