PoliciesΒΆ
Data StructuresΒΆ
Attribute |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Read-only, unique policy identifier. |
|
|
string |
yes |
Unique, case-insensitive policy name. |
|
string {ml, regexp} |
yes |
Immutable. Policy type. |
|
string {critical, high, medium, low} |
yes |
Expensive to use. |
|
boolean; default value |
yes |
|
|
boolean; default value |
yes |
|
|
boolean; default value |
yes |
|
|
boolean; default value |
yes |
|
|
boolean; default value |
yes |
|
|
boolean; default value |
yes |
|
|
string {avg, max, min} |
If |
|
|
number |
If |
|
|
datetime |
Read-only. Timestamp of creation. |
|
|
datetime |
Read-only. Timestamp of modification. |
|
|
boolean |
Read-only. |
Request for Retrieving Available Attributes ββββββββββββββββββββββββββββββββββββββββ
Request
Method |
|
Path |
|
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
Get Policies ListΒΆ
Request
Method |
|
Path |
|
Example Request
GET /api/v2/policy
curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/policy'
Response
{
"result": "success",
"policy": [
{
"id": "9124292845052624897",
"name": "PCP",
"type": "regexp",
"priority": "medium",
"email_send": true,
"input_match": false,
"snmp_trap": false,
"session_pause": false,
"session_terminate": false,
"user_block": false,
"created_at": "2024-06-11 22:52:18.44898-07",
"modified_at": "2024-06-11 22:52:18.44898-07"
},
{
"id": "9124292845052624898",
"name": "AI_Policy_1",
"type": "regexp",
"priority": "low",
"email_send": false,
"input_match": false,
"snmp_trap": false,
"session_pause": false,
"session_terminate": false,
"user_block": false,
"created_at": "2024-06-14 15:15:58.534771-07",
"modified_at": "2024-06-14 15:15:58.534771-07"
}
]
}
Get Policy by IDΒΆ
Request
Method |
|
Path |
|
Example Request
GET /api/v2/policy/<id>
curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/policy/9124292845052624897'
Response
{
"result": "success",
"policy": {
"id": "9124292845052624897",
"name": "PCP",
"type": "regexp",
"priority": "medium",
"email_send": true,
"input_match": false,
"snmp_trap": false,
"session_pause": false,
"session_terminate": false,
"user_block": false,
"created_at": "2024-06-11 22:52:18.44898-07",
"modified_at": "2024-06-11 22:52:18.44898-07"
}
}
Create PolicyΒΆ
Request
Method |
|
Path |
|
Headers |
|
Body |
|
Example Request
POST /api/v2/policy
curl -s -k -X POST \
-H 'Authorization: sgfeea6jsaz4mum9su8w6' \
-H 'Content-Type: application/json' \
'https://10.0.214.98/api/v2/policy' \
-d'{"name":"Policy_1","type":"regexp","priority":"medium","email_send":true,"session_pause":true}'
Response
{
"result": "success",
"policy": {
"id": "9124292845052624899"
}
}
Modify PolicyΒΆ
Request
Method |
|
Path |
|
Headers |
|
Body |
|
Example Request
PATCH /api/v2/policy/<id>
curl -s -k -X PATCH \
-H 'Authorization: sgfeea6jsaz4mum9su8w6' \
-H 'Content-Type: application/json' \
'https://10.0.214.98/api/v2/policy/9124292845052624927' \
-d'{"priority":"low","email_send":false,"user_block":true}'
Response
{
"result": "success"
}
Deleting PolicyΒΆ
Request
Method |
|
Path |
|
Example Request
DELETE /api/v2/policy/<id>
curl -s -k -X DELETE -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' https://10.0.214.98/api/v2/policy/9124292845052624899
Response
{
"result": "success"
}