Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /policy/security-event

Get /policy/security-event

Description

Returns a list of Security Event records matching the supplied filter.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/policy/security-event

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"eventDate": "2024-01-31T22:34:32.372Z",

"deviceID": 0,

"sourceIP": "string",

"sourceMac": "string",

"destinationIP": "string",

"destinationMac": "string",

"alertType": "string",

"subtype": "string",

"severity": 0,

"threatID": "string",

"eventDescription": "string",

"sourceLocation": "string",

"destinationLocation": "string",

"vendor": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-31T22:34:32.372Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

}

}

],

"filtered": 0,

"total": 0

}

Get /policy/security-event

Get /policy/security-event

Description

Returns a list of Security Event records matching the supplied filter.

Request Headers

Key

Value

Type

Description

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiNAC
Content-Type (option 1) application/json String

Content-Type (option 2)

application/xml

Request Body Parameters

Name

Required

Type

filter Optional Array
start Optional Integer
count Optional Integer
sortKey Optional String
sortDir Optional String

Sample Request

Request URL

Get https://10.106.94.152:8443/api/v2/policy/security-event

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"dbid": 0,

"eventDate": "2024-01-31T22:34:32.372Z",

"deviceID": 0,

"sourceIP": "string",

"sourceMac": "string",

"destinationIP": "string",

"destinationMac": "string",

"alertType": "string",

"subtype": "string",

"severity": 0,

"threatID": "string",

"eventDescription": "string",

"sourceLocation": "string",

"destinationLocation": "string",

"vendor": "string",

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-01-31T22:34:32.372Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

}

}

],

"filtered": 0,

"total": 0

}