Akamai APIs API Documentation
List policies
GET https://{{host}}/etp-config/v3/configs/:configId/policies
Returns a list of all policies.
Body
PARAM
| Key | Datatype | Required | Description |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| [
{
"accessConfig": {
"configurable": true,
"delegatedAdmins": [
"delegatedAdmin@org.com"
],
"readable": true
},
"akamaiDefined": true,
"aupSettings": [
{
"categoryId": 1,
"categoryInfo": {
"code": "AKA-SOCIAL",
"defaultActionId": 5,
"deprecated": false,
"id": 1,
"name": "Social"
},
"groups": [
"groupName1"
],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [
{
"id": 4,
"name": "Block"
}
],
"users": [
"jsmith@org.com"
]
}
],
"authenticationMode": "NONE",
"basicSettings": {
"dnssec": false,
"edns0ecs": true,
"forwardProxyEnabled": false,
"proxyEnabled": false,
"safesearch": false,
"trustXFF": false
},
"createdBy": "adevi",
"createdDate": "2017-04-25T22:26:15.597+0000",
"description": "Default policy",
"id": 2480,
"ipaSettings": {
"enabled": false,
"randomCheck": false,
"zdp": false
},
"modifiedBy": "jperez",
"modifiedDate": "2020-06-25T20:20:33.114+0000",
"name": "Default",
"policyGeneralSettings": {
"aupMigrated": true
},
"riskyFileHandlingSettings": {
"hugeRiskyFileResponse": {
"id": 5,
"name": "Allow"
},
"largeRiskyFileResponse": {
"id": 5,
"name": "Allow"
}
},
"safeSearchSettings": {
"youtube": "open"
},
"securitySettings": [
{
"confirmedResponseId": 760,
"confirmedResponseInfo": {
"id": 760,
"name": "Sinkhole 1"
},
"listId": 1,
"listInfo": {
"categoryId": 1,
"id": 1,
"name": "Malware"
},
"shouldNotifyConfirmed": true,
"shouldNotifySuspected": true,
"suspectedResponseId": 760,
"suspectedResponseInfo": {
"id": 760,
"name": "Sinkhole 1"
}
},
{
"confirmedResponseId": 760,
"confirmedResponseInfo": {
"id": 760,
"name": "Sinkhole 1"
},
"listId": 3,
"listInfo": {
"categoryId": 3,
"id": 3,
"name": "C&C"
},
"shouldNotifyConfirmed": true,
"shouldNotifySuspected": true,
"suspectedResponseId": 760,
"suspectedResponseInfo": {
"id": 760,
"name": "Sinkhole 1"
}
},
{
"confirmedResponseId": 2,
"confirmedResponseInfo": {
"id": 2,
"name": "Block - DNS"
},
"listId": 4,
"listInfo": {
"categoryId": 5,
"id": 4,
"name": "DNS Exfiltration"
},
"shouldNotifyConfirmed": true,
"shouldNotifySuspected": true,
"suspectedResponseId": 2,
"suspectedResponseInfo": {
"id": 2,
"name": "Block - DNS"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 3785,
"listInfo": {
"categoryId": 1,
"id": 3785,
"name": "Costa Rica WB"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 4541,
"listInfo": {
"categoryId": 4,
"id": 4541,
"name": "Mchantor_LNS_List"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 3905,
"listInfo": {
"categoryId": 4,
"id": 3905,
"name": "Kartik"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 4021,
"listInfo": {
"categoryId": 4,
"id": 4021,
"name": "CR Akatec List"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 5562,
"listInfo": {
"categoryId": 1,
"id": 5562,
"name": "anon"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 5821,
"listInfo": {
"categoryId": 4,
"id": 5821,
"name": "BGLR"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 5823,
"listInfo": {
"categoryId": 2,
"id": 5823,
"name": "Mel_"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 5762,
"listInfo": {
"categoryId": 1,
"id": 5762,
"name": "ishamy_customlist"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 1,
"suspectedResponseInfo": {
"id": 1,
"name": "Monitor"
}
},
{
"confirmedResponseId": 1,
"confirmedResponseInfo": {
"id": 1,
"name": "Monitor"
},
"listId": 6942,
"listInfo": {
"categoryId": 1,
"id": 6942,
"name": "priya_"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 760,
"suspectedResponseInfo": {
"id": 760,
"name": "Sinkhole 1"
}
},
{
"confirmedResponseId": 10,
"confirmedResponseInfo": {
"id": 10,
"name": "Bypass"
},
"listId": 32336,
"listInfo": {
"categoryId": 4,
"id": 32336,
"name": "Allow List - migrated Quick List"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 10,
"suspectedResponseInfo": {
"id": 10,
"name": "Bypass"
}
},
{
"confirmedResponseId": 4,
"confirmedResponseInfo": {
"id": 4,
"name": "Block - Error Page"
},
"listId": 32337,
"listInfo": {
"categoryId": 4,
"id": 32337,
"name": "Deny List - migrated Quick List"
},
"shouldNotifyConfirmed": false,
"shouldNotifySuspected": false,
"suspectedResponseId": 4,
"suspectedResponseInfo": {
"id": 4,
"name": "Block - Error Page"
}
}
],
"sites": [
2160,
18217,
991731,
991733
],
"sitesInfo": [
{
"id": 2160,
"name": "Unidentified IPs"
},
{
"id": 18217,
"name": "DDNS"
},
{
"id": 991731,
"name": "aasdfsadfdsa"
},
{
"id": 991733,
"name": "11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf"
}
]
}
] |
Curl
curl -X GET 'https://undefined/etp-config/v3/configs/:configId/policies?accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS