Learn more:

• Enterprise Threat Protector Reporting API v3

• Enterprise Threat Protector Reporting API v1

• Download this API’s RAML and JSON schema descriptors.

Overview

The Enterprise Threat Protector (ETP) Configuration API offers a programmatic interface to manage policy settings to protect against enterprise security and acceptable user policy related events. A distributed configuration encapsulates all the rules for how to process DNS requests for your enterprise.

Who should use this API

This API is for site administrators, project managers, and technical support providers who implement Enterprise Threat Protector (ETP) for your organization. It assumes that you have a working knowledge of ETP and how the configurable objects interact. If you are not familiar with these topics, see ETP Configuration Resources for more information.

Get started

Before using the ETP Configuration API for the first time:

• Contact your Akamai representative to enable it for your account.

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named ETP Configuration API, and set the access level to READ-WRITE.

Object versioning

High-level objects such as Site, Policy, and CustomList use a timestamp for revision control. With each create, update, or delete, the object’s timestamp must be up to date. Requests fail with a 412 Precondition failed response if an older timestamp is provided in the request.

GET and POST operations pass the timestamp value in an Etag HTTP header. UPDATE and DELETE operations pass the timestamp in an If-Match HTTP header, with the correct ETag value.

TLS certificates

TLS termination is possible with an Akamai-issued certificate or a customer-provisioned certificate, so long as it is from an approved Akamai certificate authority (CA).

• To use an Akamai CA, you need to trust the Akamai CA and use an Akamai generated certificate. You also need to install the Akamai generated certificate manually or with the use of an MDM solution on the client device.

• To use a customer-owned certificate, you need to generate a certificate signing request (CSR) using the Enterprise Threat Protector Application, sign it, and upload the signed certificate using the API.

Resources

This section provides details on each API operation.

The following list provides a road map of all the conceptual objects you deal with when interacting with the Enterprise Threat Protector (ETP) Configuration API, and provides pointers to where you can learn more.

• Configuration: When you sign up for ETP, you receive a configuration and associated ID. This configuration contains settings for all of your sites, such as locations, policies, and quick lists.

• Site: A site is a named collection of public IP addresses that belong to a region or geographic area in your network, such as a CIDR block for an office branch or company headquarters. Use sites to compare the query’s source IP with the IPs of configured sites. A site configuration must include the IP address of your Active Directory or other local DNS server used to communicate with ETP. See the Site object type.

• Policy: A policy is the rule set that defines how Enterprise Threat Protector (ETP) handles known or suspected DNS threats. You assign a policy to a location or you can assign multiple locations to a policy. See the Policy object type.

• DNS Provisioning: Defines the IPv4 and IPv6 address information for the primary and secondary DNS recursive servers that are assigned to you. These DNS servers forward traffic from users to Akamai. See the DnsConfiguration object type.

• Response: When ETP receives a DNS query, it sends back a response. The responses must match the original query, which verifies there is a valid mapping from query type to response type.

• Category: The type of detected threat. The threat type can be malware, phishing, command and control (C&C), or an other category.

• Lists: A list is a Set of domain and IP addresses that are known or suspected to be malicious for a specific category of threat. Akamai Lists: By default, each policy is configured with Akamai Security Lists. These security lists contain domains and IP addresses verified as threats in the category assigned to the list. Various network security resources are used to maintain and update these lists.

  • Emergency Lists: Emergency lists are a fast and easy way to allow or deny domains or IP addresses in your network. You can add domains and IP addresses to a blacklist to block access or you can add the domains or IP addresses into the whitelist to permit access. You can add a maximum of 1,000 entries to each list. See the EmergencyList object type.

  • Custom Lists: In a custom list configuration, you define the known and suspected domains and IP addresses for a policy. Like the security lists, a custom list is assigned to a policy by default. You also select the action that Enterprise Threat Protector (ETP) completes to handle a known or suspected threat to your network. See the CustomList object type.

• List Quota: When creating a custom list, each domain or IP address entry is counted. ETP allows you to have a total of 200,000 custom list entries. See the ListQuota object type.

• List Deployment: After applying configuration changes to a custom list, you must deploy these changes to the ETP network to ensure the changes take effect. Changes typically deploy in 30 minutes. For example, when you add or modify a list item, the changes are not propagated until the deploy operation is complete. See the ListDeployment object type.

• Accepted Usage Policy (AUP): Defines how ETP handles violations to an Acceptable Use Policy (AUP). ETP enforces the policy by denying DNS queries from sources that have deemed inappropriate in the AUP, and returns an error page in response. ETP includes AUP categories for content that is traditionally blocked with an enterprise. See the Policy.aupSettings[] object type.

• Honeypot: A honeypot action directs a known or suspected malicious domain or IP address to a security device that monitors activity and collects information regarding the domain or IP address. When creating or editing a policy, you have the option to select a sinkhole as the action for the list. See the Honeypot object type.

• Configuration Deployment: After applying configuration changes to a site, policy, emergency list, or honeypot, you must deploy these changes to the Enterprise Threat Protector (ETP) network to ensure the changes take effect. Changes typically deploy within 20–30 seconds. For example, when you add or modify a location, the configuration changes are not propagated to the ETP network until the deploy operation is complete. See the ConfigurationDeployment object type.

• Certificate: TLS certificates allow you to establish a secure connection using the public key provided by your certificate authority (CA). You can specify an Akamai-issued certificate or a customer-provisioned certificate using a trusted third-party CA. See the Certificate object type.

API summary

Download the RAML descriptors for this API.

Get all Akamai built-in security lists

Returns a list of all available Akamai built-in Lists.

[
    {
        "id": 110,
        "name": "Akamai List",
        "description": "Akamai's List",
        "securityCategoryId": 1,
        "securityCategoryInfo": {
            "id": 1,
            "name": "Malware"
        }
    }
]

List Akamai built-in responses

Returns a list of all available Akamai built-in responses.

[
    {
        "id": 2,
        "name": "Deny",
        "description": "Deny",
        "allowedForAUP": false
    }
]

List AUP category predefined configurations

Returns a list of all available predefined AUP categories.

[
    {
        "id": 1,
        "name": "Social",
        "description": "Social"
    }
]

List security category predefined configurations

Returns a list of all available predefined security categories

[
    {
        "id": 3,
        "name": "C&C",
        "description": "C&C"
    }
]

List configurations

Returns a list of ETP configuration IDs. Use this value for a configId parameter in subsequent operations.

[
    1,
    2
]

List DNS provisioning configurations

Returns a list of DNS provisioning configurations.

{
    "ipv4Addrs": {
        "primary": "192.168.10.10",
        "secondary": "192.160.10.20"
    },
    "ipv6Addrs": {
        "primary": "2021:D32::88/124",
        "secondary": "2021:D32::89/124"
    }
}

List sites

Returns a list of all Sites for a configuration.

[
    {
        "id": 101,
        "description": "This is Akamai's site 1",
        "name": "Akamai Site 1",
        "exitPoints": [
            {
                "ipAddr": "10.10.10.10",
                "addrType": "ADDR_TYPE_IPV4"
            }
        ],
        "policyId": 1030,
        "policyInfo": {
            "id": 1030,
            "name": "Policy 1"
        }
    },
    {
        "id": 102,
        "description": "This is Akamai's site 2",
        "name": "Akamai Site 2",
        "exitPoints": [
            {
                "ipAddr": "20.20.20.20",
                "addrType": "ADDR_TYPE_IPV4"
            }
        ],
        "policyId": 1040,
        "policyInfo": {
            "id": 1040,
            "name": "Policy 2"
        }
    }
]

Create a site

Creates a new site.

{
    "description": "This is Akamai's site",
    "name": "Akamai Site 1",
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ],
    "policyId": 1030
}

Get a site

Returns the details of a specific Site.

{
    "id": 101,
    "description": "This is Akamai's site",
    "name": "Akamai Site",
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ],
    "policyId": 1030,
    "policyInfo": {
        "id": 1030,
        "name": "Policy 1"
    }
}

Update a site

Modifies Site details.

{
    "description": "This is Akamai's site",
    "name": "Akamai Site 1",
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ],
    "policyId": 1030
}

Remove a site

Deletes a specific site.

List policies

Returns a list of all Policies.

[
    {
        "id": 1050,
        "description": "Akamai's Policy",
        "name": "Akamai Policy",
        "sites": [
            101,
            102
        ],
        "sitesInfo": [
            {
                "id": 101,
                "name": "Akamai Site 1"
            },
            {
                "id": 102,
                "name": "Akamai Site 2"
            }
        ]
    }
]

Create a policy

Creates a new policy.

{
    "description": "Akamai's Policy",
    "name": "Akamai Policy",
    "sites": [
        100
    ],
    "basicSettings": {
        "dnssec": false,
        "edns0ecs": false
    },
    "aupSettings": [
        {
            "categoryId": 2,
            "responseId": 2
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "confirmedResponseId": 1,
            "suspectedResponseId": 1,
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}

Get a policy

Returns the details of a specific Policy.

{
    "id": 115,
    "description": "Akamai's Policy",
    "name": "Akamai Policy",
    "sites": [
        100
    ],
    "sitesInfo": [
        {
            "id": 100,
            "name": "Akamai Site"
        }
    ],
    "basicSettings": {
        "dnssec": true,
        "edns0ecs": true
    },
    "aupSettings": [
        {
            "categoryId": 1,
            "categoryInfo": {
                "id": 1,
                "name": "Social"
            },
            "responseId": 1,
            "responseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "listInfo": {
                "id": 1,
                "name": "Akamai List"
            },
            "confirmedResponseId": 2,
            "confirmedResponseInfo": {
                "id": 2,
                "name": "Deny"
            },
            "suspectedResponseId": 1,
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}

Update a policy

Modifies a Policy’s details.

{
    "id": 120,
    "description": "Akamai's Policy",
    "name": "Akamai Policy",
    "sites": [
        100
    ],
    "basicSettings": {
        "dnssec": false,
        "edns0ecs": false
    },
    "aupSettings": [
        {
            "categoryId": 2,
            "responseId": 2
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "confirmedResponseId": 1,
            "suspectedResponseId": 1,
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}

Remove a policy

Deletes a specific policy.

Get all lists

Returns a list of all available custom security lists.

[
    {
        "id": 225,
        "name": "Akamai List",
        "description": "Akamai's List",
        "securityCategoryId": 2,
        "securityCategoryInfo": {
            "id": 2,
            "name": "Phishing"
        },
        "itemCount": 800,
        "knownCounts": {
            "ips": 200,
            "domains": 200
        },
        "suspectedCounts": {
            "ips": 200,
            "domains": 200
        }
    }
]

Create a list

Creates a new List.

{
    "securityCategoryId": 1,
    "name": "Example List name",
    "description": "A short description of the example List"
}

Get global list quota

Returns the remaining list item quota for all lists globally.

{
    "count": 1000,
    "remainingCount": 990
}

Get a list

Returns the details of a specific List.

{
    "id": 225,
    "name": "Akamai List",
    "securityCategoryId": 2,
    "securityCategoryInfo": {
        "id": 2,
        "name": "Phishing"
    },
    "description": "Akamai's List",
    "itemCount": 800,
    "knownCounts": {
        "ips": 200,
        "domains": 200
    },
    "suspectedCounts": {
        "ips": 200,
        "domains": 200
    },
    "remainingCount": 200
}

Update a list

Modifies list properties and all items for a specific list. Full update only.

{
    "name": "Akamai List",
    "securityCategoryId": 1,
    "description": "Akamai's List"
}

Remove a list

Deletes a specific list.

Patch a list

Modifies individual list items entries. Add or delete only.

{
    "delete": [
        "192.160.100.100",
        "220.10.100.11"
    ],
    "add": [
        {
            "type": "LIST_TYPE_IP",
            "value": "115.65.10.134",
            "confidenceLevelId": 2
        }
    ]
}

Search in a list

Filters items in a list by search parameters (Optional).

{
    "items": [
        {
            "type": "LIST_TYPE_IP",
            "value": "192.168.0.10",
            "confidenceLevelId": 1
        }
    ],
    "totalCount": 200
}

Modify list items

Updates list items (overwrite).

[
    {
        "type": "LIST_TYPE_IP",
        "value": "192.168.100.100",
        "confidenceLevelId": 1
    }
]

List recent changes

Returns a list of all changes made to customer lists since the previous list deployment.

{
    "created": [
        {
            "id": 1,
            "name": "Akamai 1"
        }
    ],
    "deleted": [
        {
            "id": 2,
            "name": "Akamai 2"
        }
    ],
    "modified": [
        {
            "id": 3,
            "name": "Akamai 3"
        }
    ]
}

Get all list deployments

Returns a list of all changes made to customer lists since the last list deployment.

[
    {
        "id": 101,
        "status": "COMPLETED",
        "message": "File successfully deployed to Akamai network (Succeeded)",
        "startTime": "2016-09-23",
        "endTime": "2016-09-23",
        "deployedBy": "internal-user"
    }
]

Create a list deployment

Creates a new lists deployment.

{
    "id": 102,
    "status": "PENDING"
}

Get a list deployment

Returns the details of a specific list deployment.

{
    "id": 101,
    "status": "COMPLETED",
    "message": "File successfully deployed to Akamai network (Succeeded)",
    "startTime": "2012-04-23T18:22:43.511Z",
    "endTime": "2012-04-23T18:25:43.511Z",
    "deployedBy": "internal-user"
}

Get all emergency lists

Returns the whitelist and blacklist, including entries.

{
    "whitelist": {
        "ipAddrs": [
            "192.160.10.10",
            "10.12.22.33"
        ],
        "domains": [
            "www.akamai.com",
            "www.google.com"
        ]
    },
    "blacklist": {
        "ipAddrs": [
            "172.16.77.80",
            "188.111.10.11"
        ],
        "domains": [
            "www.malwaresite.com",
            "www.phishingsite.com"
        ]
    }
}

Get an emergency list

Returns an emergency list by type. Valid values are whitelist or blacklist.

{
    "ipAddrs": [
        "192.169.19.29",
        "180.220.11.110"
    ],
    "domains": [
        "www.google.com",
        "www.facebook.com"
    ],
    "itemCount": 4,
    "remainingCount": 996
}

Update an emergency list

Updates the properties and all items for a specific list by ip or domain.

{
    "ipAddrs": [
        "10.10.0.8"
    ],
    "domains": [
        "www.akamai.com"
    ]
}

List honeypots

Returns a list of all Honeypots.

[
    {
        "id": 1,
        "name": "Honeypot 1",
        "description": "Akamai's Honeypot",
        "ipv4Addrs": [
            "196.168.1.1",
            "199.100.232.1"
        ],
        "ipv6Addrs": [
            "2019:D30::88/124",
            "2021:D32::88/124"
        ]
    }
]

Create a honeypot

Creates a new Honeypot.

{
    "name": "Honeypot 1",
    "description": "Akamai's Honeypot",
    "ipv4Addrs": [
        "196.168.1.1",
        "199.100.232.1"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ]
}

Get a honeypot

Returns the details of a specific Honeypot.

{
    "id": 1,
    "name": "Example Honeypot",
    "description": "Example of a Honeypot configuration ",
    "ipv4Addrs": [
        "196.168.1.1",
        "199.100.232.1"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ]
}

Update a honeypot

Modifies a Honeypot’s features

{
    "name": "Honeypot 1",
    "description": "Akamai's Honeypot",
    "ipv4Addrs": [
        "196.168.1.1",
        "199.100.232.1"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ]
}

Remove a honeypot

Deletes a specific Honeypot.

List configuration deployments

Returns all deployment history that the user has access to for the current ETP configuration.

[
    {
        "id": 101,
        "status": "COMPLETED",
        "message": "null",
        "startTime": "2016-08-31",
        "endTime": "2016-08-31",
        "deployedBy": "internal_user",
        "progressPct": 100
    }
]

Create a configuration deployment

Creates a new ETP configuration deployment.

Get a configuration deployment

Returns details of a specific ETP configuration deployment.

{
    "id": 101,
    "status": "COMPLETED",
    "message": "null",
    "startTime": "2012-04-23T18:22:43.511Z",
    "endTime": "2012-04-23T18:25:43.511Z",
    "deployedBy": "internal_user",
    "progressPct": 100
}

Get recent changes

Returns a list of all changes made since the last ETP configuration deployment.

{
    "created": [
        {
            "sites": [
                {
                    "id": 10,
                    "name": "Akamai Site 10"
                }
            ],
            "policies": [
                {
                    "id": 5,
                    "name": "Akamai Policy 5"
                }
            ],
            "honeypots": [
                {
                    "id": 5,
                    "name": "Akamai Honeypot 5"
                }
            ]
        }
    ],
    "deleted": [
        {
            "sites": [
                {
                    "id": 3,
                    "name": "Akamai Site 3"
                }
            ],
            "policies": [
                {
                    "id": 2,
                    "name": "Akamai Policy 2"
                }
            ],
            "honeypots": [
                {
                    "id": 8,
                    "name": "Akamai Honeypot 5"
                }
            ]
        }
    ],
    "modified": [
        {
            "sites": [
                {
                    "id": 1,
                    "name": "Akamai Site 1"
                }
            ],
            "policies": [
                {
                    "id": 4,
                    "name": "Akamai Policy 4"
                }
            ],
            "honeypots": [
                {
                    "id": 12,
                    "name": "Akamai Honeypot 12"
                }
            ],
            "whitelists": [
                {
                    "id": 1,
                    "name": "Akamai whitelists 1"
                }
            ],
            "blacklists": [
                {
                    "id": 1,
                    "name": "Akamai blacklists 1"
                }
            ]
        }
    ]
}

List certificates

Returns a list of all available certificates.

[
    {
        "certificateId": 5001,
        "fingerprint": "D1:AB:01:1C:A1:DE:CA:FC:0F:FE:E1:5F:EA:51:B1:E0",
        "issuedDate": "2016-10-11T00:15:38+0000",
        "expiredDate": "2019-10-11T00:15:38+0000",
        "status": "PENDING_ACTIVATION",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n",
        "caMode": "AKAMAI"
    },
    {
        "certificateId": "5002",
        "fingerprint": "BA:AD:CA:FE:F0:0D:AC:CE:55:1B:1E:15:AB:E1:1A:00",
        "issuedDate": "2015-10-11T00:15:38+0000",
        "expiredDate": "2018-10-11T00:15:38+0000",
        "status": "ACTIVATED",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n",
        "caMode": "CUSTOMER"
    }
]

Create a new certificate

Creates a new Certificate.

{
    "caMode": "AKAMAI"
}

Get a certificate

Returns the details of the specified certificate.

{
    "certificateId": 5001,
    "fingerprint": "D1:AB:01:1C:A1:DE:CA:FC:0F:FE:E1:5F:EA:51:B1:E0",
    "issuedDate": "2016-10-11T00:15:38+0000",
    "expiredDate": "2019-10-11T00:15:38+0000",
    "status": "PENDING_ACTIVATION",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n",
    "caMode": "AKAMAI"
}

Modify a certificate

Updates the value of a certificate.

{
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
}

Activate a certificate

Transitions the certificate’s state from PENDING_ACTIVATION to ACTIVE.

Deactivate a certificate

Transitions the certificate’s state from any of ACTIVATED, PENDING_ACTIVATION, PENDING_DOWNLOAD, PENDING_DISTRIBUTION and INCOMPLETE to DEACTIVATING.

Confirm download

Transitions the certificate’s state from PENDING_DOWNLOAD to PENDING_ACTIVATION or INCOMPLETE.

Confirm distribute

Transitions the certificate’s state from PENDING_DISTRIBUTION to PENDING_ACTIVATION.

Data

This section provides you with the data model for the ETP Config API.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Site

Specifies IP addresses and CIDR blocks of a region or geographic area in your network to compare incoming requests against an assigned policy.

Download schema: site-retrieve-specific.json

Sample GET response:

{
    "id": 101,
    "description": "This is Akamai's site",
    "name": "Akamai Site",
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ],
    "policyId": 1030,
    "policyInfo": {
        "id": 1030,
        "name": "Policy 1"
    }
}

Site members

Policy

This object encapsulates the security policy to assign to a site. You can configure the Accepted Use Policy (AUP) and set responses for known and suspected threats under specified categories.

Download schema: policy-retrieve-specific.json

Sample GET response:

{
    "id": 115,
    "description": "Akamai's Policy",
    "name": "Akamai Policy",
    "sites": [
        100
    ],
    "sitesInfo": [
        {
            "id": 100,
            "name": "Akamai Site"
        }
    ],
    "basicSettings": {
        "dnssec": true,
        "edns0ecs": true
    },
    "aupSettings": [
        {
            "categoryId": 1,
            "categoryInfo": {
                "id": 1,
                "name": "Social"
            },
            "responseId": 1,
            "responseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "listInfo": {
                "id": 1,
                "name": "Akamai List"
            },
            "confirmedResponseId": 2,
            "confirmedResponseInfo": {
                "id": 2,
                "name": "Deny"
            },
            "suspectedResponseId": 1,
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}

Policy members

CustomList

This object is a custom a security list of domains and IP addresses, with a set confidence level for each.

Download schema: list-retrieve-specific.json

Sample GET response:

{
    "id": 225,
    "name": "Akamai List",
    "securityCategoryId": 2,
    "securityCategoryInfo": {
        "id": 2,
        "name": "Phishing"
    },
    "description": "Akamai's List",
    "itemCount": 800,
    "knownCounts": {
        "ips": 200,
        "domains": 200
    },
    "suspectedCounts": {
        "ips": 200,
        "domains": 200
    },
    "remainingCount": 200
}

CustomList members

EmergencyList

This object contains a whitelist or blacklist of domains and IP addresses to allow or block on your domain. These lists are applied globally across site configurations and override individual policy settings.

Download schema: emergency-list-retrieve-specific.json

Sample GET response:

{
    "ipAddrs": [
        "192.169.19.29",
        "180.220.11.110"
    ],
    "domains": [
        "www.google.com",
        "www.facebook.com"
    ],
    "itemCount": 4,
    "remainingCount": 996
}

EmergencyList members

ListItem

This object provides details for a list entry.

Download schema: list-set-items-content.json

Sample GET response:

[
    {
        "type": "LIST_TYPE_IP",
        "value": "192.168.100.100",
        "confidenceLevelId": 1
    }
]

ListItem members

ListPatch

This object contains items to add or delete when performing a patch operation on a list.

Download schema: list-modify-items-content.json

Sample GET response:

{
    "delete": [
        "192.160.100.100",
        "220.10.100.11"
    ],
    "add": [
        {
            "type": "LIST_TYPE_IP",
            "value": "115.65.10.134",
            "confidenceLevelId": 2
        }
    ]
}

ListPatch members

ListQuota

This object returns the global count of entries in all lists and the remaining entries available to provision.

Download schema: list-get-global-quota.json

Sample GET response:

{
    "count": 1000,
    "remainingCount": 990
}

ListQuota members

Honeypot

This object specifies a honeypot for receiving and monitoring malicious requests. Honeypots are monitored resources within a network that provide secure responses to the request in order to gain insight into an attack and the methods they use.

Download schema: honeypot-retrieve-specific.json

Sample GET response:

{
    "id": 1,
    "name": "Example Honeypot",
    "description": "Example of a Honeypot configuration ",
    "ipv4Addrs": [
        "196.168.1.1",
        "199.100.232.1"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ]
}

Honeypot members

ListDeployment

Encapsulates data describing the status and details of a list configuration deployment.

Download schema: list-deployment-retrieve-specific.json

Sample GET response:

{
    "id": 101,
    "status": "COMPLETED",
    "message": "File successfully deployed to Akamai network (Succeeded)",
    "startTime": "2012-04-23T18:22:43.511Z",
    "endTime": "2012-04-23T18:25:43.511Z",
    "deployedBy": "internal-user"
}

ListDeployment members

ConfigurationDeployment

Encapsulates data describing the status and details of an ETP configuration deployment.

Download schema: etp-configuration-deployment-retrieve-specific.json

Sample GET response:

{
    "id": 101,
    "status": "COMPLETED",
    "message": "null",
    "startTime": "2012-04-23T18:22:43.511Z",
    "endTime": "2012-04-23T18:25:43.511Z",
    "deployedBy": "internal_user",
    "progressPct": 100
}

ConfigurationDeployment members

DnsConfiguration

Contains the IPv4 and IPv6 address information for the primary and secondary DNS recursive servers that are assigned to you. These DNS servers forward traffic from users to Akamai.

Download schema: dns-configuration.json

Sample GET response:

{
    "ipv4Addrs": {
        "primary": "192.168.10.10",
        "secondary": "192.160.10.20"
    },
    "ipv6Addrs": {
        "primary": "2021:D32::88/124",
        "secondary": "2021:D32::89/124"
    }
}

DnsConfiguration members

Certificate

Encapsulates data about a TLS certificate.

Download schema: certificate.json

Sample GET response:

{
    "certificateId": 5001,
    "fingerprint": "D1:AB:01:1C:A1:DE:CA:FC:0F:FE:E1:5F:EA:51:B1:E0",
    "issuedDate": "2016-10-11T00:15:38+0000",
    "expiredDate": "2019-10-11T00:15:38+0000",
    "status": "PENDING_ACTIVATION",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n",
    "caMode": "AKAMAI"
}

Certificate members

Errors

This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

EdgeGrid responds with HTTP Problem error objects that provide details useful for debugging. For example:

{
    "type": "https://problems.omni.akamaiapis.net/http/forbidden",
    "title": "Forbidden",
    "detail": "Insufficient permissions. Code-01",
    "status": 403,
    "instance": "3e3f11da-e205-409a-be77-24e459f29fa8"
}

HTTP status codes

The API produces the following set of HTTP status codes for both success and failure scenarios: