Fortinet black logo

Administration Guide

Events

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

Retrieve events.

https://<servername>:8443/api/event

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

Return value

Type

Description

id

Integer

Event record ID

creationTime

Integer

Time alarm was created

name

String

Description of alarm

message

String

Event Detail

tag

String

Event 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://<servername>:8443/api/event?limit=1

Example XML format

<eventSearchResult>

<status>success</status>

<limit>1</limit>

<nextOffset>1</nextOffset>

<offset>0</offset>

<total>50724</total>

<events>

<event>

<creationTime>1484546536470</creationTime>

<element>

<id>2886</id>

<name>Aruba5000</name>

<type>1</type>

</element>

<id>2956873</id>

<message>SNMP error 2 occurred for device Aruba5000</message>

<name>SNMP Read Error</name>

<tag>SNMP_READ_ERROR</tag>

</event>

</events>

</eventSearchResult>

Retrieve events.

https://<servername>:8443/api/event

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

Return value

Type

Description

id

Integer

Event record ID

creationTime

Integer

Time alarm was created

name

String

Description of alarm

message

String

Event Detail

tag

String

Event 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://<servername>:8443/api/event?limit=1

Example XML format

<eventSearchResult>

<status>success</status>

<limit>1</limit>

<nextOffset>1</nextOffset>

<offset>0</offset>

<total>50724</total>

<events>

<event>

<creationTime>1484546536470</creationTime>

<element>

<id>2886</id>

<name>Aruba5000</name>

<type>1</type>

</element>

<id>2956873</id>

<message>SNMP error 2 occurred for device Aruba5000</message>

<name>SNMP Read Error</name>

<tag>SNMP_READ_ERROR</tag>

</event>

</events>

</eventSearchResult>