FaultManager Service (3.1.0)

Download OpenAPI specification:Download

Extreme Networks: support@extremenetworks.com URL: https://www.extremenetworks.com License: Apache license

This is the spec that defines the APIs provided by the Fault Manager service to raise alerts and alarms

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Health

getHealth

Get the health of the faultmanager service

Authorizations:

bearerAuth

Responses

Response samples

Content type

application/json

{"Service": "string",
"MessageBus": "string"
}

Alerts

getAlertInventory

Pregnerated lists of all possible alerts that EFA could raise

Authorizations:

bearerAuth

query Parameters

alert_id	integer ID identifying EFA alert
resource	string Health resource path associated to the alert being sent

Responses

Response samples

Content type

application/json

{"Alerts": [{"AlertID": 31000,
"Severity": "Warning",
"Resource": "/App/System/Security/Certificate"
},
{"AlertID": 41000,
"Severity": "Warning",
"Resource": "/App/System/Security/Certificate"
}
]
}

getAlertHistory

Actual history of alerts generated by EFA

Authorizations:

bearerAuth

query Parameters

alert_id	integer ID identifying EFA alert
severity	string Enum: "Critical" "Major" "Minor" "Warning" "Info" Severity of EFA alert
sequence_id	integer Tracks the sequence in which messages are submitted
resource	string Health resource path associated to the alert being sent
limit	integer Limit the number of alerts to be displayed
before_timestamp	string Alerts being sent before a particular time stamp
after_timestamp	string Alerts being sent after a particular time stamp
	object {"sort_by":"asc\|desc"} Responses with sequence id in ascending or descending order {"offset" : "lt:30"} Responses searched with sequence id less than 30 {"page_size":20} Responses searched with limit of 20 entries

Responses

Response samples

200
401
409
500
default

Content type

application/json

{"Alerts": [{"AlertID": 31000,
"SequenceID": 47,
"Cause": "key expired",
"Severity": "Warning",
"Resource": "/App/System/Security/Certificate",
"Timestamp": "2022-09-22T14:06:01.000Z",
"Limit": 5
},
{"AlertID": 41000,
"SequenceID": 51,
"Cause": "token expired",
"Severity": "Warning",
"Resource": "/App/System/Security/Certificate",
"Timestamp": "2022-09-22T14:06:01.000Z",
"Limit": 2
}
]
}

clearAlertHistory

clear all alerts in history

Authorizations:

bearerAuth

Responses

Response samples

200
409
500
default

Content type

application/json

{"result": 0,
"error": "Unknown error"
}