Fortinet white logo
Fortinet white logo

Rest API

7.4.0

Get /policy/security-rule-trigger

Get /policy/security-rule-trigger

Description

Returns a list of Security Trigger 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-rule-trigger

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-06T22:45:48.893Z",

"dbid": 0,

"name": "string",

"timeLimit": 0,

"numberOfMatches": 0,

"activities": [

{

"dbid": 0,

"triggerID": 0,

"type": "string",

"subtype": "string",

"description": "string",

"threatID": "string",

"vendor": "string",

"occurrences": 0,

"minSeverity": 0,

"maxSeverity": 0,

"useDestination": true,

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditString": "string",

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-06T22:45:48.893Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

}

}

],

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-06T22:45:48.893Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

],

"filtered": 0,

"total": 0

}

Get /policy/security-rule-trigger

Get /policy/security-rule-trigger

Description

Returns a list of Security Trigger 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-rule-trigger

Request Header

Authorization: Bearer <Authorization_Token>

Content-Type: application/json

Sample Response

{

"status": "string",

"errorMessage": "string",

"results": [

{

"lastModifiedBy": "string",

"lastModifiedDate": "2024-02-06T22:45:48.893Z",

"dbid": 0,

"name": "string",

"timeLimit": 0,

"numberOfMatches": 0,

"activities": [

{

"dbid": 0,

"triggerID": 0,

"type": "string",

"subtype": "string",

"description": "string",

"threatID": "string",

"vendor": "string",

"occurrences": 0,

"minSeverity": 0,

"maxSeverity": 0,

"useDestination": true,

"attributes": {

"additionalProp1": "string",

"additionalProp2": "string",

"additionalProp3": "string"

},

"auditString": "string",

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-06T22:45:48.893Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

}

}

],

"yamsEventTag": "string",

"auditObj": {

"user": "string",

"action": "string",

"timestamp": "2024-02-06T22:45:48.893Z",

"liveObj": {

"yamsEventTag": "string",

"auditObj": "string"

},

"auditDBID": 0,

"liveDBID": 0,

"yamsEventTag": "string",

"auditObj": "string"

},

"auditObjectName": "string",

"auditObjectType": {

"auditTableName": "string",

"mysqlTableName": "string",

"idnameQuery": "string"

}

}

],

"filtered": 0,

"total": 0

}