Documentation Index

Fetch the complete documentation index at: https://docs.graphiant.com/llms.txt

Use this file to discover all available pages before exploring further.

/v2/childalertlist

Prev Next
Post
/v2/childalertlist
Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Body parameters
object
alertId
string Required

Alert id of the parent alert (required)

Exampleexample string
Responses
200

OK

Expand All
object
alertList
Array of object (alertserviceAlertRecord)
object
acknowledgedList
Array of string
string

List of users that have acknowledged the alert

Exampleexample string
acknowledgementReason
string

Reason put by users when acknowledged

Exampleexample string
alertBody
string

Latest event(s) behind the alert (required)

Exampleexample string
alertId
string

Unique id of the alert (required)

Exampleexample string
allowListed
boolean

whether entity in alert is put in allowlist/excludelist, disabling alert (required)

Exampletrue
childrenAlertList
object (alertserviceChildrenAlertListResponse)
alertList
Array of object (alertserviceAlertRecord)
object Recursive
descendantPresent
boolean

Whether or not descendants are present (required)

Exampletrue
deviceId
string

Internal device id to navigate to troubleshooting

Exampleexample string
endTime
integer (int64)

When this alert was last seen as a continuation (required)

Minimum0
Example12345678910
enterpriseId
string

Internal enterprise id to navigate to troubleshooting (required)

Exampleexample string
entity
string

Entity that triggered the alert. Edge, core, etc. (required)

Exampleexample string
interfaceName
string

Device Interface Name

Exampleexample string
muteListed
boolean

whether entity in alert is put in notification mutelist (required)

Exampletrue
notificationCreated
boolean

whether notification exists for this rule (required)

Exampletrue
occurrences
integer (int64)

Number of times alert was raised as a continuation (required)

Minimum0
Example12345678910
peerDeviceId
string

peer device id

Exampleexample string
peerInterfaceName
string

Peer Interface Name

Exampleexample string
peerName
string

Peer Name

Exampleexample string
plane
string

Plane of the rule generating the alert (required)

ExampleENUM_VALUE
reason
string

Reason why alert was generated (required)

Exampleexample string
recommendation
string

Recommendation to recover from alert (required)

Exampleexample string
ruleId
string

Unique id of the rule generating the alert (required)

Exampleexample string
severity
string

Severity of the rule behind the alert (required)

ExampleLow
siteId
string

Internal site id to navigate to troubleshooting

Exampleexample string
startTime
integer (int64)

When this alert was first triggered (required)

Minimum0
Example12345678910
status
string

Status of the alert whether active or inactive (required)

ExampleENUM_VALUE
troubleshootingDisabledReason
string

Reason to not navigate to troubleshooting

Exampleexample string
troubleshootingEnabled
boolean

Navigate or not navigate to troubleshooting dashboard (required)

Exampletrue
tunnelInterfaceName
string

Tunnel Interface Name

Exampleexample string
type
string

Type of alert (required)

Exampleexample string