Fortinet black logo

Administration Guide

Alarms

Copy Link
Copy Doc ID 8bec453a-b242-11e9-a989-00505692583a:864429
Download PDF

Retrieve alarms.

https://<servername>:8443/api/alarmhttps://<servername>:8443/api/alarm?tag={tag}

Return Value

Type

Description

id

Integer

Alarm record ID

acknowledgedTime

Integer

Time of acknowledgement (zero if not acknowledged)

creationTime

Integer

Time alarm was created

name

String

Alarm severity

tag

String

Alarm tag

Element

id

Integer

Element ID

Name

String

Element Name

Type

Integer

Element Type

Example request

curl -k -u 'username:password' -H "accept: application/xml" -X GET https://localhost:8443/api/alarm?limit=1\&tag=READ_CLIENTS_FAILURE

Example XML Format

<alarmSearchResult>

<status>success</status>

<limit>1</limit>

<nextOffset>1</nextOffset>

<offset>0</offset>

<total>61</total>

<alarms>

<alarm>

<acknowledgedTime>0</acknowledgedTime>

<creationTime>1484546536473</creationTime>

<element>

<id>2886</id>

<name>Aruba5000</name>

<type>1</type>

</element>

<id>33757</id>

<name>L2 Poll Failed</name>

<severity>Critical</severity>

<tag>READ_CLIENTS_FAILURE</tag>

</alarm>

</alarms>

</alarmSearchResult>

Retrieve alarms.

https://<servername>:8443/api/alarmhttps://<servername>:8443/api/alarm?tag={tag}

Return Value

Type

Description

id

Integer

Alarm record ID

acknowledgedTime

Integer

Time of acknowledgement (zero if not acknowledged)

creationTime

Integer

Time alarm was created

name

String

Alarm severity

tag

String

Alarm tag

Element

id

Integer

Element ID

Name

String

Element Name

Type

Integer

Element Type

Example request

curl -k -u 'username:password' -H "accept: application/xml" -X GET https://localhost:8443/api/alarm?limit=1\&tag=READ_CLIENTS_FAILURE

Example XML Format

<alarmSearchResult>

<status>success</status>

<limit>1</limit>

<nextOffset>1</nextOffset>

<offset>0</offset>

<total>61</total>

<alarms>

<alarm>

<acknowledgedTime>0</acknowledgedTime>

<creationTime>1484546536473</creationTime>

<element>

<id>2886</id>

<name>Aruba5000</name>

<type>1</type>

</element>

<id>33757</id>

<name>L2 Poll Failed</name>

<severity>Critical</severity>

<tag>READ_CLIENTS_FAILURE</tag>

</alarm>

</alarms>

</alarmSearchResult>