Fortinet black logo

Administration Guide

Specific alarm

Copy Link
Copy Doc ID 825689eb-200d-11e9-b6f6-f8bc1258b856:36807
Download PDF

Retrieve a specific alarm.

https://<servername>:8443/api/alarm/{id}

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/33757

Example XML Format

<alarmResult>

<status>success</status>

<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>

</alarmResult>

Retrieve a specific alarm.

https://<servername>:8443/api/alarm/{id}

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/33757

Example XML Format

<alarmResult>

<status>success</status>

<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>

</alarmResult>