Update Intent
Intent Updation
Request
URI
PUT
https://{api_host}/api/ni/alert-configs/intents/{id}
COPY
Path Parameters
string
id
Required
The Entity ID of object requestion information on
Request Body
Update Intent Configuration
AlertConfigIntentObject
of type(s)
application/json
Required
{
"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
object
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
object
notificationSettings
Optional
notificationSettings
Responses
200
OK
Returns
AlertConfigIntentResponse
of type(s)
application/json
"AlertConfigIntentResponse Object"
string
alertType
Optional
Intent type
object
categories
Optional
categories
string
description
Optional
Intent description
boolean
enabled
Optional
enabled
array of
object
exceptionParams
Optional
Exclusion parameters
object
filterRules
Optional
filterRules
string
intentTypeId
Optional
Intent type
Possible values are :
APPLICATION_FLOW_HEALTH,
APPLICATION_FLOW_UTILIZATION,
DuplexMismatch,
DuplicateIPAddress,
DuplicateMacAddress,
HSRPConfiguration,
HsrpStpColocation,
Loop,
MtuMismatch,
NativeVlanMismatch,
NativeVlanTaggingMismatch,
PortChannelMismatch,
PortModeMismatch,
Reachability,
Segmentation,
StigAccountPasswd,
StigConsolePasswd,
StigDefaultPasswd,
StigMgmtPasswd,
StigPlaintextPasswd,
StpMetricInconsistency,
TrunkPortVlanMismatch,
string
modelKey
Optional
Intent model key
string
name
Optional
Intent name
string
notes
Optional
Intent notes
array of
object
notificationSettings
Optional
notificationSettings
array of
object
paramValues
Optional
Intent parameters
string
selected_scope
Optional
Intent scope
string
severity
Optional
Intent severity
Possible values are :
Warning,
Critical,
Moderate,
Info,
array of
string
tags
Optional
Intent tags
400
Bad Request
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
401
Un-authorized
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
404
Intent Not Found
Returns
ApiError
of type(s)
application/json
"ApiError Object"
integer As int32
As int32
code
Optional
code
string
message
Optional
message
array of
object
details
Optional
details
500
Internal Error
Operation doesn't return any data structure
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/ni/alert-configs/intents/{id}