All Security List¶
Overview¶
The All Security List API can get the security profiles of virtual servers or applications. The API also gets the protection mode and the percentage of bad traffic.
REST Endpoint: /mgmt/ap/query/v1/tenants/default/reports/AllSecurityList¶
Requests¶
GET /mgmt/ap/query/v1/tenants/default/reports/AllSecurityList¶
Query Parameters¶
Name | Type | Required | Description |
---|---|---|---|
%24timeframe | string | False | Specifies timeframe for results. Possible values are “HALF_HOUR”, “HOUR”, “THREE_HOURS”, “SIX_HOURS”, “TWELVE_HOURS”, “DAY” and “WEEK”. |
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
result | object | List of items describing security profiles. |
totalItems | number | The number of items in the list. |
Items | object | Each item describes profiles per virtual server or application. Contains the bot defense profile, DoS profile, log profile, policy, bot protection mode, Dos protection mode, ASM protection mode, and the percentage of bot traffic and the percentage of ASM bad traffic. |
type | string | “VirtualServer” indicates this Item is for a virtual server. “Application” indicates this Item is for an application. |
id | string | This item’s UUID. |
name | string | This item’s name. |
link | string | This item’s URL. |
device | string | This virtual server’s host device. |
address | string | This virtual server’s IP address. |
asmEnabled | boolean | The value is false if ASM is not enabled. |
isAdvanced | boolean | Is advanced defense enabled? Possible values are true or false. |
dosProfiles | object | A list of DoS profiles for this item. |
id | string | The UUID of the Dos profile. |
name | string | The name of the Dos profile. |
link | string | The URL of the Dos profile. |
partition | string | The partition of the Dos profile. This value can be “Common”. |
botProfiles | object | A list of bot defense profiles for this virtual server. |
id | string | The UUID of the bot defense profile. |
name | string | The name of the bot defense profile. |
link | string | The URL of the bot defense profile. |
partition | string | The partition of the bot defense profile. This value can be “Common”. |
logProfiles | object | A list of log profiles for this item. |
id | string | The UUID of the log profile. |
name | string | The name of the log profile. |
link | string | The URL of the log profile. |
partition | string | The partition of the log profile. This value can be “Common”. |
badTraffic | number | The percentage of bad traffic for ASM. |
badBotTraffic | number | The percentage of bad traffic for this bot. |
attacks | number | The number of attacks for this item. |
applicationSecurityPolicies | object | A list of application security policies for the item. |
id | string | The UUID of the application security policy. |
name | string | The name of the application security policy. |
link | string | The URL of the application security policy. |
partition | string | The partition of the application security policy. This value can be “Common”. |
kind | string | The kind of the application security policy. |
asmProtectionMode | string | The ASM protection mode for the item. Possible values are “Blocking”, “Transparent”, or “Not Protected”. |
dosProtectionMode | string | The Dos protection mode for the item. Possible values are “Blocking”, “Transparent”, or “Not Protected”. |
botDefenseProtectionMode | string | The bot defense protection mode for the virtual server. Possible values are “Blocking”, “Transparent”, or “Not Protected”. |
findings | string | The item’s findings. |
dosFindings | string | The item’s Dos findings. |
badTrafficGrowth | boolean | Does the bad ASM traffic grow over time? Possible values are true or false. |
dosBadTrafficGrowth | boolean | Does the bad Dos traffic grow over time? Possible values are true or false. |
as3 | boolean | Is this AS3? Possible values are true or false. |
Permissions¶
Role | Allow |
---|---|
Security Manager | Yes |
Examples¶
GET to retrieve a list for virtual servers¶
Following is an example of a response to the default API call, with no parameters.
GET https://<BIG-IQ>/mgmt/ap/query/v1/tenants/default/reports/AllSecurityList
Response¶
HTTP/1.1 200 OK
{
"kind": "ap:compose:Report",
"lastUpdateMicros": 13446061682,
"result": {
"totalItems": 3,
"items": [{
"type": "VirtualServer",
"id": "9f5a5433-856f-3df8-86d8-b7d4caa03f37",
"name": "bank.com",
"link": "https://localhost/mgmt/cm/security-shared/working-config/virtuals/9f5a5433-856f-3df8-86d8-b7d4caa03f37",
"device": "host-12-345-678-910",
"address": "10.240.186.7:80",
"asmEnabled": false,
"isAdvanced": false,
"dosProfiles": [],
"botProfiles": [],
"badTraffic": 0.0,
"badBotTraffic": 0.0,
"applicationSecurityPolicies": [],
"asmProtectionMode": "Not Protected",
"dosProtectionMode": "Not Protected",
"botDefenseProtectionMode": "Not Protected",
"findings": "None",
"dosFindings": "None",
"badTrafficGrowth": false,
"dosBadTrafficGrowth": false,
"as3": false
},
{
"type": "VirtualServer",
"id": "54dafa9d-ccac-3908-9686-05828dd00e3f",
"name": "owa",
"link": "https://localhost/mgmt/cm/security-shared/working-config/virtuals/54dafa9d-ccac-3908-9686-05828dd00e3f",
"device": "host-12-345-678-910",
"address": "10.240.186.7:8083",
"asmEnabled": false,
"isAdvanced": false,
"dosProfiles": [],
"botProfiles": [{
"id": "e8decad0-7e0e-3e55-9d06-3194a5b81fd1",
"name": "bot-defense",
"link": "https://localhost/mgmt/cm/security-shared/working-config/bot-defense-profiles/e8decad0-7e0e-3e55-9d06-3194a5b81fd1",
"partition": "Common"
}],
"logProfiles": [{
"id": "e33765fd-2d59-36ab-bc2b-ce72090daa9e",
"name": "asm_logger",
"link": "https://localhost/mgmt/cm/security-shared/working-config/log-profiles/e33765fd-2d59-36ab-bc2b-ce72090daa9e",
"partition": "Common"
},
{
"id": "712b23c3-2b89-3231-be83-129cf379cbe9",
"name": "bot_logger",
"link": "https://localhost/mgmt/cm/security-shared/working-config/log-profiles/712b23c3-2b89-3231-be83-129cf379cbe9",
"partition": "Common"
}
],
"badTraffic": 0.0,
"badBotTraffic": 28.57142857142857,
"applicationSecurityPolicies": [{
"id": "68981f45-00a0-35d8-947b-4741ead42012",
"name": "hackauction",
"link": "https://localhost/mgmt/cm/asm/working-config/policies/68981f45-00a0-35d8-947b-4741ead42012",
"partition": "Common",
"kind": "cm:asm:working-config:policies:policystate"
}],
"asmProtectionMode": "Blocking",
"dosProtectionMode": "Not Protected",
"botDefenseProtectionMode": "Transparent",
"findings": "None",
"dosFindings": "None",
"badTrafficGrowth": false,
"dosBadTrafficGrowth": false,
"as3": false
},
{
"type": "VirtualServer",
"id": "f0c81ade-4c23-333e-b22e-e597eb7c5d2a",
"name": "test",
"link": "https://localhost/mgmt/cm/security-shared/working-config/virtuals/f0c81ade-4c23-333e-b22e-e597eb7c5d2a",
"device": "host-12-345-678-910",
"address": "10.240.186.7:8082",
"asmEnabled": false,
"isAdvanced": false,
"dosProfiles": [],
"botProfiles": [{
"id": "f940b609-5ae2-3cd3-a499-a260f510faa7",
"name": "profile15",
"link": "https://localhost/mgmt/cm/security-shared/working-config/bot-defense-profiles/f940b609-5ae2-3cd3-a499-a260f510faa7",
"partition": "Common"
}],
"logProfiles": [{
"id": "712b23c3-2b89-3231-be83-129cf379cbe9",
"name": "bot_logger",
"link": "https://localhost/mgmt/cm/security-shared/working-config/log-profiles/712b23c3-2b89-3231-be83-129cf379cbe9",
"partition": "Common"
}],
"badTraffic": 0.0,
"badBotTraffic": 33.33333333333333,
"applicationSecurityPolicies": [],
"asmProtectionMode": "Not Protected",
"dosProtectionMode": "Not Protected",
"botDefenseProtectionMode": "Transparent",
"findings": "None",
"dosFindings": "None",
"badTrafficGrowth": false,
"dosBadTrafficGrowth": false,
"as3": false
}
],
"itemsPerPage": 10,
"startIndex": 0,
"totalPages": 1,
"pageIndex": 0,
"currentItemCount": 3
},
"requestDurationInMillis": 1669
}