Get a List of Alarms
get
/{versionId}/fault/alarms
Use this (GET) method to retrieve alarms maintained by the fault management system in the SDM database. These alarms originate from events that SDM generated or were received from all the devices that Session Element Manager is managing. The query for alarms can be filtered by using the query parameters provided in the request.
Request
Path Parameters
Query Parameters
Back to Top
Response
200 Response
OK
400 Response
The user input is invalid.
401 Response
The session ID is invalid.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
Examples
Example of Accessing the API with cURL
The following example shows how to get a list of alarms by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/fault/alarms"Example of Accessing the API with Python
The following example shows how to get a list of alarms by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.
import requests
url = "https://example.com:8443/rest/v1.3/fault/alarms"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)Example of the Response Body
This endpoint does not return a response body.