Version:

Version:

Version:

Version:


Table of Contents

Online Help

Get Alert Policy List

Description

Get all FortiCWP policies which can trigger alert.

URL

/api/v1/alert/policy/list

 

Method: GET

Request Headers

Key

Value

Type

Description

companyId <12345> String Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String  

Sample Request

Request URL

GET https://www.forticwp.com/api/v1/alert/policy/list

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 1

roleId: 36241

Content-Type: application/json

Response Variables

Name

Type

Description

name String policy name
category String category of the policy
id String policy code for identifying policy

Sample Response

[

{

"name":"DLP Birthdate Policy",

"category":"DLP",

"id":"FC-ACT-018"

},

{

"name":"DLP United States California Driver License Policy",

"category":"DLP",

"id":"FC-ACT-019"

},

{

"name":"DLP SSN Policy",

"category":"DLP",

"id":"FC-ACT-038"

},

{

"name":"DLP China Passport Number Policy",

"category":"DLP",

"id":"FC-ACT-016"

},

{

"name":"DLP JCB Policy",

"category":"DLP",

"id":"FC-ACT-039"

},

{

"name":"DLP Email Address Policy",

"category":"DLP",

"id":"FC-ACT-017"

},

{

"name":"DLP Polish Social Security Number Policy",

"category":"DLP",

"id":"FC-ACT-256"

}

]

 

 

 

 

 

Get Alert Policy List

Description

Get all FortiCWP policies which can trigger alert.

URL

/api/v1/alert/policy/list

 

Method: GET

Request Headers

Key

Value

Type

Description

companyId <12345> String Company ID in FortiCWP, can be obtained through Get Resource Map

roleId

<12345>

Long

Login user identity, can be obtained through Get Resource Map

Authorization Bearer <Authorization Token> String Authorization credential generated by FortiCWP
Content-Type application/json String  

Sample Request

Request URL

GET https://www.forticwp.com/api/v1/alert/policy/list

Request Header

Authorization: Bearer <Authorization_Token>

companyId: 1

roleId: 36241

Content-Type: application/json

Response Variables

Name

Type

Description

name String policy name
category String category of the policy
id String policy code for identifying policy

Sample Response

[

{

"name":"DLP Birthdate Policy",

"category":"DLP",

"id":"FC-ACT-018"

},

{

"name":"DLP United States California Driver License Policy",

"category":"DLP",

"id":"FC-ACT-019"

},

{

"name":"DLP SSN Policy",

"category":"DLP",

"id":"FC-ACT-038"

},

{

"name":"DLP China Passport Number Policy",

"category":"DLP",

"id":"FC-ACT-016"

},

{

"name":"DLP JCB Policy",

"category":"DLP",

"id":"FC-ACT-039"

},

{

"name":"DLP Email Address Policy",

"category":"DLP",

"id":"FC-ACT-017"

},

{

"name":"DLP Polish Social Security Number Policy",

"category":"DLP",

"id":"FC-ACT-256"

}

]