Akamai APIs API Documentation
List policy metadata
GET https://{{host}}/etp-config/v3/configs/:configId/policy-metadata
Returns the policy metadata details.
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
| {
"applications": [
{
"categoryInfo": {
"avcVendorCode": "5",
"code": "",
"defaultActionId": 5,
"deprecated": false,
"id": 119,
"name": "IT Services",
"riskId": 2,
"subCategories": []
},
"deprecated": false,
"description": "MobileIron is a mobile device management (MDM) system that provides ITS with a means of governing mobile access to WCM resources, including email, calendar, contacts, and other central applications.",
"domainBasedApp": true,
"groups": [],
"id": 501,
"name": "Mobileiron",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"risk": {
"description": "Indicates the application has the lowest amount of risk for data loss or a security breach. These applications allow users to perform low-risk actions such as viewing content, listening to music, downloading files, and more.",
"groups": [],
"id": 1,
"name": "Low",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
"users": []
},
{
"categoryInfo": {
"avcVendorCode": "9",
"code": "BACKUP",
"defaultActionId": 5,
"deprecated": false,
"id": 20,
"name": "File Sharing",
"riskId": 4,
"subCategories": [],
"vendorCode": "47"
},
"deprecated": false,
"description": "ZipShare is a web application that users can upload, share files which the files are zipped using WinZip's legendary compression, making them faster to download and saving bandwidth.",
"domainBasedApp": false,
"groups": [],
"id": 560,
"name": "ZipShare",
"operationSettings": [
{
"deprecated": false,
"description": "Uploading files to web applications. This also includes inserting local files into content being edited online. Actions that correspond to 'File Transfer' and 'Sharing' are not included.",
"groups": [],
"id": 1,
"name": "Uploading",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Sharing files with other users via web applications. This also includes generating share links and publishing files. Sharing public content, like SNS posts and news articles, is not included.",
"groups": [],
"id": 4,
"name": "Sharing",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Logging into a service and authenticating users within the service.",
"groups": [],
"id": 15,
"name": "Login/Authentication",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Making financial transactions such as buying, selling, paying, and remittance.",
"groups": [],
"id": 18,
"name": "Paying And Transfering Money",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
}
],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"risk": {
"description": "Indicates the application is extremely at risk for data loss or a security breach. These applications allow users to perform high-risk actions such as sending or sharing files and making remote connections that can bypass enterprise security.",
"groups": [],
"id": 4,
"name": "Very High",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
"users": []
},
{
"categoryInfo": {
"avcVendorCode": "21",
"code": "PFINA",
"defaultActionId": 5,
"deprecated": false,
"id": 23,
"name": "Finance & Investing",
"riskId": 3,
"subCategories": [],
"vendorCode": "3"
},
"deprecated": false,
"description": "Cloud9 is a voice conversation platform for traders that allows one-click recording and voice analysis of phone contents. It is provided by Cloud9 Technologies.",
"domainBasedApp": true,
"groups": [],
"id": 334,
"name": "Cloud9",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"risk": {
"description": "Indicates the application is slightly at risk for data loss or a security breach. These applications allow users to perform slightly risky actions such as voting, rate scoring, text searches, translation, and more.",
"groups": [],
"id": 2,
"name": "Medium",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
"users": []
}
],
"categories": [
{
"categoryInfo": {
"avcVendorCode": "10",
"code": "CHAT",
"defaultActionId": 5,
"deprecated": false,
"id": 31,
"name": "Chat Site",
"riskId": 4,
"subCategories": [],
"vendorCode": "66"
},
"description": "Websites that enable users to chat in real time through chat rooms, online conferences, video chat, or instant messaging.",
"groups": [],
"id": 31,
"name": "Chat Site",
"operationSettings": [
{
"deprecated": false,
"description": "Uploading files to web applications. This also includes inserting local files into content being edited online. Actions that correspond to 'File Transfer' and 'Sharing' are not included.",
"groups": [],
"id": 1,
"name": "Uploading",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Posting articles and comments.",
"groups": [],
"id": 3,
"name": "Posting",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Editing or creating content/documents on web applications. Actions that correspond to 'Post' are not included.",
"groups": [],
"id": 5,
"name": "Editing",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": true,
"description": "Searching for keywords.",
"groups": [],
"id": 14,
"name": "Searching",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Logging into a service and authenticating users within the service.",
"groups": [],
"id": 15,
"name": "Login/Authentication",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Downloading files from web applications. Actions such as exporting content or data are also included.",
"groups": [],
"id": 2,
"name": "Downloading",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Making financial transactions such as buying, selling, paying, and remittance.",
"groups": [],
"id": 18,
"name": "Paying And Transfering Money",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Text-based chatting on a web application.",
"groups": [],
"id": 7,
"name": "Chatting",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Sending files to others. Messaging functions in messengers, SNS, and conference services are included. Other file transfer functions are included in 'Uploading'.",
"groups": [],
"id": 8,
"name": "File Transfer",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Making video and voice calls. Primarily this includes messenger, groupware, and conference service functions. Actions that correspond to 'Broadcasting' are not included.",
"groups": [],
"id": 13,
"name": "Calling",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Inviting individuals to use web applications and their functions.",
"groups": [],
"id": 19,
"name": "Inviting",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"deprecated": false,
"description": "Browsing content and files on web applications. This also includes multimedia playing actions that do not fall into 'Listening'.",
"groups": [],
"id": 6,
"name": "Viewing Contents",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
}
],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"categoryInfo": {
"code": "BLOG",
"defaultActionId": 5,
"deprecated": false,
"id": 35,
"name": "Blogging",
"subCategories": [],
"vendorCode": "22"
},
"description": "Websites that are blogs or host and publish blogs. These websites contain regularly posted entries that share views, commentary, or personal content. Blogs often include photos and multimedia.",
"groups": [],
"id": 35,
"name": "Blogging",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"categoryInfo": {
"code": "GORE",
"defaultActionId": 5,
"deprecated": false,
"id": 38,
"name": "Gore",
"subCategories": [],
"vendorCode": "54"
},
"description": "Websites that promote or feature excessive, graphic, or deliberate violence against humans or animals.",
"groups": [],
"id": 38,
"name": "Gore",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
}
],
"fileTypes": [
{
"fileTypeCategory": "message",
"groups": [],
"id": 159,
"name": "message/rfc822",
"operationSettings": [],
"responseId": 4,
"responseInfo": {
"id": 4,
"name": "Block - Error Page"
},
"responseOverrides": [],
"type": "message/rfc822",
"users": []
},
{
"fileTypeCategory": "application",
"groups": [],
"id": 27,
"name": "application/vnd.openxmlformats-officedocument.wordprocessingml.document (docx)",
"operationSettings": [],
"responseId": 4,
"responseInfo": {
"id": 4,
"name": "Block - Error Page"
},
"responseOverrides": [],
"type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"users": []
},
{
"fileTypeCategory": "application",
"groups": [],
"id": 28,
"name": "application/vnd.rn-realmedia (.rm , .ra , .rma , .ram , .rv , .rmvb)",
"operationSettings": [],
"responseId": 4,
"responseInfo": {
"id": 4,
"name": "Block - Error Page"
},
"responseOverrides": [],
"type": "application/vnd.rn-realmedia",
"users": []
}
],
"operations": [
{
"description": "Connecting to other computers via web applications.",
"groups": [],
"id": 16,
"name": "Remote Connecting",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"description": "Delivering live streaming from users. Actions that correspond to 'Calling' are not included.",
"groups": [],
"id": 17,
"name": "Broadcasting",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
},
{
"description": "Making financial transactions such as buying, selling, paying, and remittance.",
"groups": [],
"id": 18,
"name": "Paying And Transfering Money",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
}
],
"risks": [
{
"description": "Indicates the application has the lowest amount of risk for data loss or a security breach. These applications allow users to perform low-risk actions such as viewing content, listening to music, downloading files, and more.",
"groups": [],
"id": 1,
"name": "Low",
"operationSettings": [],
"responseId": 5,
"responseInfo": {
"id": 5,
"name": "Allow"
},
"responseOverrides": [],
"users": []
}
]
} |
Curl
curl -X GET 'https://undefined/etp-config/v3/configs/:configId/policy-metadata?accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS