loading

Enterprise Threat Protector Configuration API v1

Manage policy settings to protect against events that compromise your security with ETP.

Learn more:


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

To configure this 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 error 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. You can configure network configurations, global settings, and add or remove connectors to your base ETP configuration.

  • 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. You can have a total of 200,000 custom list entries. See the ListQuota object type.

  • List Deployment (Deprecated): 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[n] 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.

  • Proxy 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.

  • Sinkhole: Forwards suspicious or malicious traffic to identify machines that are infected with malware, attempt to download malware, or make requests to command and control servers.

  • ETP Proxy: Enables the ETP Proxy to authorize connections from the on-premises proxy in a proxy chaining configuration. This setting adds the Proxy-Authorization header to these connections. The Proxy-Authorization header contains proxy credentials that are used to authenticate the on-premises proxy. ETP Proxy validates these credentials before it allows connections from the on-premises proxy.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Built-in Lists  
Get all Akamai built-in security lists GET /etp-config/v1/akamai-lists
Responses  
List Akamai built-in responses GET /etp-config/v1/responses
AUP Categories  
List AUP category predefined configurations GET /etp-config/v1/aup-categories
Security Categories  
List security category predefined configurations GET /etp-config/v1/securityCategories
Configurations  
List configurations GET /etp-config/v1/configs
List DNS provisioning configurations GET /etp-config/v1/configs/{configId}/dnsConfiguration
Get acknowledgement info GET /etp-config/v1/configs/{configId}/acknowledgement
Create acknowledgement info POST /etp-config/v1/configs/{configId}/acknowledgement
Get client configuration GET /etp-config/v1/configs/{configId}/client-configuration
Update client configuration PUT /etp-config/v1/configs/{configId}/client-configuration
List client versions GET /etp-config/v1/configs/{configId}/client-versions
Updates the client version details PUT /etp-config/v1/configs/{configId}/client-versions/{clientVersionId}
Download client version details GET /etp-config/v1/configs/{configId}/client-versions/{clientVersionId}/download
Rotate client version entitlement code POST /etp-config/v1/configs/{configId}/client-versions/op/rotate-entitlement-code
List client devices GET /etp-config/v1/configs/{configId}/client/devices
Blacklist a client device POST /etp-config/v1/configs/{configId}/client/devices/{deviceId}/op/blacklist
Whitelist a client device POST /etp-config/v1/configs/{configId}/client/devices/{deviceId}/op/whitelist
Get client status GET /etp-config/v1/configs/{configId}/client/status
Get custom error page GET /etp-config/v1/configs/{configId}/custom-error-page
Update the custom error page PUT /etp-config/v1/configs/{configId}/custom-error-page
Get a delegated access user GET /etp-config/v1/configs/{configId}/delegated-access
Edit a delegated access user PUT /etp-config/v1/configs/{configId}/delegated-access
List dedicated access users GET /etp-config/v1/configs/{configId}/delegated-access/all
Get DNS-VIPs GET /etp-config/v1/configs/{configId}/dns-vips
Get the first time wizard GET /etp-config/v1/configs/{configId}/firstTimeWizard
Update first time wizard PUT /etp-config/v1/configs/{configId}/firstTimeWizard
Get global settings GET /etp-config/v1/configs/{configId}/global-settings
Update global setting PUT /etp-config/v1/configs/{configId}/global-settings
List sites GET /etp-config/v1/configs/{configId}/sites
Create a site POST /etp-config/v1/configs/{configId}/sites
Get a site GET /etp-config/v1/configs/{configId}/sites/{siteId}
Update a site PUT /etp-config/v1/configs/{configId}/sites/{siteId}
Remove a site DELETE /etp-config/v1/configs/{configId}/sites/{siteId}
List policies GET /etp-config/v1/configs/{configId}/policies
Create a policy POST /etp-config/v1/configs/{configId}/policies
Get a policy GET /etp-config/v1/configs/{configId}/policies/{policyId}
Update a policy PUT /etp-config/v1/configs/{configId}/policies/{policyId}
Remove a policy DELETE /etp-config/v1/configs/{configId}/policies/{policyId}
Get all lists GET /etp-config/v1/configs/{configId}/lists
Create a list POST /etp-config/v1/configs/{configId}/lists
Get Global list quota GET /etp-config/v1/configs/{configId}/lists/quota
Get a list GET /etp-config/v1/configs/{configId}/lists/{listId}
Update a list PUT /etp-config/v1/configs/{configId}/lists/{listId}
Remove a list DELETE /etp-config/v1/configs/{configId}/lists/{listId}
Search in a list GET /etp-config/v1/configs/{configId}/lists/{listId}/items{?numItemsPerPage,page,type,confidence,search}
Modify list items PUT /etp-config/v1/configs/{configId}/lists/{listId}/items
Patch a list PATCH /etp-config/v1/configs/{configId}/lists/{listId}/items
Bulk patch a list PATCH /etp-config/v1/configs/{configId}/lists/{listId}/items/bulk
Add the list to the policy POST /etp-config/v1/configs/{configId}/lists/{listId}/op/add-to-policies
Remove the list from policy POST /etp-config/v1/configs/{configId}/lists/{listId}/op/remove-from-policies
List recent changes GET /etp-config/v1/configs/{configId}/lists/recentChanges
Get all list deployments GET /etp-config/v1/configs/{configId}/lists/deployments
Create a list deployment POST /etp-config/v1/configs/{configId}/lists/deployments
Get a list deployment GET /etp-config/v1/configs/{configId}/lists/deployments/{listDeploymentId}
Get all emergency lists GET /etp-config/v1/configs/{configId}/emergency-lists
Get an emergency list GET /etp-config/v1/configs/{configId}/emergency-lists/{listType}
Update an emergency list PUT /etp-config/v1/configs/{configId}/emergency-lists/{listType}
List honeypots GET /etp-config/v1/configs/{configId}/honeypots
Create a honeypot POST /etp-config/v1/configs/{configId}/honeypots
Get a honeypot GET /etp-config/v1/configs/{configId}/honeypots/{honeypotId}
Update a honeypot PUT /etp-config/v1/configs/{configId}/honeypots/{honeypotId}
Remove a honeypot DELETE /etp-config/v1/configs/{configId}/honeypots/{honeypotId}
List configuration deployments GET /etp-config/v1/configs/{configId}/deployments
Create a configuration deployment POST /etp-config/v1/configs/{configId}/deployments
Get a configuration deployment GET /etp-config/v1/configs/{configId}/deployments/{configDeploymentId}
Get recent changes GET /etp-config/v1/configs/{configId}/recentChanges
List sinkholes GET /etp-config/v1/configs/{configId}/akamai-sinkholes
Create a sinkhole POST /etp-config/v1/configs/{configId}/akamai-sinkholes
Get sinkhole SC latest version GET /etp-config/v1/configs/{configId}/akamai-sinkholes/sc-latest-versions
Get sinkhole latest version GET /etp-config/v1/configs/{configId}/akamai-sinkholes/latest-version
Get a sinkhole GET /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}
Delete sinkhole DELETE /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}
Replacement of the sinkhole PUT /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/policy-assignment
Generate activation code for sinkhole POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/generate-activation-code
Change local sinkhole password POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/change-local-password
Upgrade the sinkhole POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/upgrade
Get site meta info GET /etp-config/v1/configs/{configId}/sites-meta-info
Get proxy credentials GET /etp-config/v1/configs/{configId}/proxy-credentials
Create proxy credential POST /etp-config/v1/configs/{configId}/proxy-credentials
Get proxy credential user details GET /etp-config/v1/configs/{configId}/proxy-credentials/{userName}
Remove a proxy credential DELETE /etp-config/v1/configs/{configId}/proxy-credentials/{userName}
Get the network configuration GET /etp-config/v1/configs/{configId}/network-configuration
Create a network configuration POST /etp-config/v1/configs/{configId}/network-configuration
Update the network configuration PUT /etp-config/v1/configs/{configId}/network-configuration
Get notification configuration GET /etp-config/v1/configs/{configId}/notifications-config
Create notifications configs POST /etp-config/v1/configs/{configId}/notifications-config
Update the notifications configs PUT /etp-config/v1/configs/{configId}/notifications-config
Delete the notification configuration DELETE /etp-config/v1/configs/{configId}/notifications-config/{notificationConfigId}
Certificates  
List proxy certificates GET /etp-config/v1/tls/customers/{configId}/certificates{?debug,include-certificate}
Create a new proxy certificate POST /etp-config/v1/tls/customers/{configId}/certificates
Get a proxy certificate GET /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}{?debug,include-certificate}
Modify a proxy certificate PUT /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}
Activate a proxy certificate POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/activate
Deactivate a proxy certificate POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/deactivate
Confirm proxy certificate download POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-download
Confirm proxy certificate distribution POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-distribution

Get all Akamai built-in security lists

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

GET /etp-config/v1/akamai-lists

Status 200 application/json

Download schema: akamai-security-lists.json

Response body:

[
    {
        "id": 1,
        "name": "Malware",
        "description": "Malware",
        "securityCategoryId": 1,
        "allowedForDnsPolicy": true,
        "createdDate": "2016-06-30T08:30:14.391+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 1,
            "name": "Malware"
        }
    },
    {
        "id": 2,
        "name": "Phishing",
        "description": "Phishing",
        "securityCategoryId": 2,
        "allowedForDnsPolicy": true,
        "createdDate": "2016-06-30T08:30:14.393+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 2,
            "name": "Phishing"
        }
    },
    {
        "id": 3,
        "name": "C&C",
        "description": "C&C",
        "securityCategoryId": 3,
        "allowedForDnsPolicy": true,
        "createdDate": "2016-06-30T08:30:14.395+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 3,
            "name": "C&C"
        }
    },
    {
        "id": 4,
        "name": "DNS Exfiltration",
        "description": "DNS Exfiltration",
        "securityCategoryId": 5,
        "allowedForDnsPolicy": true,
        "createdDate": "2018-05-16T13:06:12.395+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 5,
            "name": "DNS Exfiltration"
        }
    },
    {
        "id": 8,
        "name": "Risky domains",
        "description": "Risky domains",
        "securityCategoryId": 6,
        "allowedForDnsPolicy": false,
        "createdDate": "2018-03-05T09:52:29.339+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 6,
            "name": "Risky domains"
        }
    },
    {
        "id": 9,
        "name": "File sharing",
        "description": "File sharing",
        "securityCategoryId": 7,
        "allowedForDnsPolicy": false,
        "createdDate": "2018-03-05T09:52:29.345+0000",
        "createdBy": "Portal Admin",
        "securityCategoryInfo": {
            "id": 7,
            "name": "File sharing"
        }
    }
]

List Akamai built-in responses

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

GET /etp-config/v1/responses

Status 200 application/json

Download schema: akamai-responses.json

Response body:

[
    {
        "id": 3,
        "name": "Drop",
        "description": "Drop",
        "allowedForAup": false,
        "allowedForSecurity": false,
        "allowedForDnsPolicy": true
    },
    {
        "id": 4,
        "name": "Block - Error Page",
        "description": "Error",
        "allowedForAup": true,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": true
    },
    {
        "id": 7,
        "name": "Warn",
        "description": "Warn",
        "allowedForAup": false,
        "allowedForSecurity": false,
        "allowedForDnsPolicy": false
    },
    {
        "id": 1,
        "name": "Monitor",
        "description": "Allow",
        "allowedForAup": false,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": true
    },
    {
        "id": 2,
        "name": "Block - DNS",
        "description": "Deny",
        "allowedForAup": true,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": true
    },
    {
        "id": 5,
        "name": "Allow",
        "description": "Allow",
        "allowedForAup": true,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": true
    },
    {
        "id": 6,
        "name": "Classify",
        "description": "Classify",
        "allowedForAup": true,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": false
    },
    {
        "id": 8,
        "name": "DNS On-Ramp",
        "description": "DNS On-Ramp",
        "allowedForAup": false,
        "allowedForSecurity": false,
        "allowedForDnsPolicy": false
    },
    {
        "id": 9,
        "name": "Allow and Scan",
        "description": "Allow and Scan",
        "allowedForAup": false,
        "allowedForSecurity": false,
        "allowedForDnsPolicy": false
    },
    {
        "id": 10,
        "name": "Bypass",
        "description": "Bypass",
        "allowedForAup": true,
        "allowedForSecurity": true,
        "allowedForDnsPolicy": true
    },
    {
        "id": -1,
        "name": "N/A",
        "description": "N/A",
        "allowedForAup": false,
        "allowedForSecurity": false,
        "allowedForDnsPolicy": false
    }
]

List AUP category predefined configurations

Deprecated. This operation is no longer supported.

GET /etp-config/v1/aup-categories

Status 200 application/json

Response body:

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

List security category predefined configurations

Returns a list of all available predefined security categories.

GET /etp-config/v1/securityCategories

Status 200 application/json

Download schema: security-categories.json

Response body:

[
    {
        "id": 6,
        "name": "Risky domains",
        "description": "Risky domains",
        "userSelectable": false
    },
    {
        "id": 7,
        "name": "File sharing",
        "description": "File sharing",
        "userSelectable": false
    },
    {
        "id": 4,
        "name": "Other",
        "description": "Other",
        "userSelectable": true
    },
    {
        "id": 1,
        "name": "Malware",
        "description": "Malware",
        "userSelectable": true
    },
    {
        "id": 2,
        "name": "Phishing",
        "description": "Phishing",
        "userSelectable": true
    },
    {
        "id": 3,
        "name": "C&C",
        "description": "C&C",
        "userSelectable": true
    },
    {
        "id": 5,
        "name": "DNS Exfiltration",
        "description": "DNS Exfiltration",
        "userSelectable": true
    },
    {
        "id": 8,
        "name": "Too Large",
        "description": "Too Large",
        "userSelectable": false
    },
    {
        "id": 10,
        "name": "Broken Domain",
        "description": "Broken Domain",
        "userSelectable": false
    },
    {
        "id": 12,
        "name": "Infrastructure",
        "description": "Infrastructure",
        "userSelectable": false
    },
    {
        "id": 11,
        "name": "No Proxy",
        "description": "No Proxy",
        "userSelectable": false
    }
]

List configurations

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs

Status 200 application/json

Download schema: etp-configuration-container.json

Response body:

[
    1,
    2
]
  1. Make a GET request to /etp-config/v1/configs.

List DNS provisioning configurations

Returns a list of DNS provisioning configurations.

GET /etp-config/v1/configs/{configId}/dnsConfiguration

Sample: /etp-config/v1/configs/342/dnsConfiguration

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Object type: DnsConfiguration

Download schema: dns-configuration.json

Response body:

{
    "ipv4Addrs": {
        "primary": "192.168.10.10",
        "secondary": "192.160.10.20"
    },
    "ipv6Addrs": {
        "primary": "2021:D32::88/124",
        "secondary": "2021:D32::89/124"
    }
}
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/dnsConfiguration.

Get acknowledgement info

Returns a list of ETP keys.

GET /etp-config/v1/configs/{configId}/acknowledgement

Sample: /etp-config/v1/configs/342/acknowledgement

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: acknowledgement-response.json

Response body:

[
    {
        "key": "ETP 1.1"
    }
]

Create acknowledgement info

Create an acknowledgement number for the configuration.

POST /etp-config/v1/configs/{configId}/acknowledgement

Sample: /etp-config/v1/configs/342/acknowledgement

Content-Type: application/json

Download schema: acknowledgement.json

Request body:

{
    "key": "ETP 1.1"
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get client configuration

Provides a client configuration details.

GET /etp-config/v1/configs/{configId}/client-configuration

Sample: /etp-config/v1/configs/342/client-configuration

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: client-configuration.json

Response body:

{
    "forwardDnsTraffic": true,
    "endUserControl": true,
    "clientIdentityReporting": true,
    "uninstallEnable": true,
    "downgradeEnable": true,
    "entitlementCode": "07156ca7-ebd0-46c9-a285-e6e87d1ef047",
    "httpProxyOverride": 2,
    "httpProxyPort": 8080,
    "securityPatchAutoUpgrade": true,
    "modifiedDate": "2020-08-06T23:31:30.477+0000",
    "createdDate": "2017-10-02T13:33:30.371+0000"
}

Update client configuration

Updates the client configuration.

PUT /etp-config/v1/configs/{configId}/client-configuration

Sample: /etp-config/v1/configs/342/client-configuration

Content-Type: application/json

Download schema: client-configuration-put-body.json

Request body:

{
    "forwardDnsTraffic": true,
    "endUserControl": true,
    "clientIdentityReporting": true,
    "uninstallEnable": true,
    "downgradeEnable": true,
    "entitlementCode": "07156ca7-ebd0-46c9-a285-e6e87d1ef047",
    "httpProxyOverride": 2,
    "httpProxyPort": 8080,
    "securityPatchAutoUpgrade": true
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

List client versions

Provides a list of client versions.

GET /etp-config/v1/configs/{configId}/client-versions

Sample: /etp-config/v1/configs/342/client-versions

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: client-versions.json

Response body:

[
    {
        "versionId": 273,
        "versionName": "3.2.1",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 271,
        "versionName": "3.2.0",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Beta",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 272,
        "versionName": "3.2.0",
        "osId": 45,
        "osName": "Mac",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Beta",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 270,
        "versionName": "3.1.5",
        "osId": 45,
        "osName": "Mac",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 269,
        "versionName": "3.1.3",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 267,
        "versionName": "3.1.2",
        "osId": 45,
        "osName": "Mac",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 268,
        "versionName": "3.1.2",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 265,
        "versionName": "3.1.1",
        "osId": 45,
        "osName": "Mac",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-01-14T00:00:00.000+0000"
    },
    {
        "versionId": 266,
        "versionName": "3.1.1",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Security Patch",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 263,
        "versionName": "3.1.0",
        "osId": 45,
        "osName": "Mac",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Beta",
        "releaseDate": "2020-01-14T00:00:00.000+0000"
    },
    {
        "versionId": 264,
        "versionName": "3.1.0",
        "osId": 61,
        "osName": "Windows",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Beta",
        "releaseDate": "2020-03-14T00:00:00.000+0000"
    },
    {
        "versionId": 221,
        "versionName": "3.0.4",
        "osId": 61,
        "osName": "Windows",
        "entitlementCode": "eda95f66-5f2a-4bf3-9cff-4cf60463ce37",
        "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
        "supportedUntil": "2021-01-14T00:00:00Z",
        "downloadDate": "2020-04-08T13:31:00Z",
        "approvalStatus": "APPROVED_ON_DEMAND",
        "approvalDate": "2020-03-24T15:28:53Z",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseDate": "2020-01-14T00:00:00.000+0000"
    },
    {
        "versionId": 241,
        "versionName": "3.0.4",
        "osId": 45,
        "osName": "Mac",
        "sha256": "852e7ab3b1f46d5efcbceb53ae955385ced24a4057ac45872222435062179eea",
        "supportedUntil": "2021-02-05T00:00:00Z",
        "approvalStatus": "PENDING",
        "autoupgradeEnabled": true,
        "unsupported": false,
        "releaseStatus": "Beta",
        "releaseDate": "2020-02-05T00:00:00.000+0000"
    }
]

Updates the client version details

Updates the details of teh specific client version.

PUT /etp-config/v1/configs/{configId}/client-versions/{clientVersionId}

Sample: /etp-config/v1/configs/342/client-versions/273

Content-Type: application/json

Request body:

{
    "versionId": 271,
    "versionName": "3.2.0",
    "osId": 61,
    "osName": "Windows",
    "sha256": "daea7915e7e9328a31a36bf5dbbc73770e05b18bc79bee93a2472a2ac05a9429",
    "supportedUntil": "2021-01-14T00:00:00Z",
    "approvalStatus": "PENDING",
    "autoupgradeEnabled": true,
    "unsupported": false,
    "releaseStatus": "Beta",
    "releaseDate": "2020-03-14T00:00:00.000+0000"
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
clientVersionId Integer 273 A unique identifier for the client version.

Status 200

Download client version details

Provides the link to download client version details.

GET /etp-config/v1/configs/{configId}/client-versions/{clientVersionId}/download

Sample: /etp-config/v1/configs/342/client-versions/273/download

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
clientVersionId Integer 273 A unique identifier for the client version.

Status 200 application/json

Download schema: client-version-download.json

Response body:

{
    "location": "http://172.25.174.252/content/ETPClient/Windows/EtpClientSetup_3.2.0-1709.dev.a24a7b61_testing.msi?token=st=1597092182~exp=1597095782~acl=%2F%2A~hmac=75cc6bfcb1ae207b9f986c144bc7d088ae0f9515a5f36ad1db829fb4d0192028"
}

Rotate client version entitlement code

Rotates global entitlement code

POST /etp-config/v1/configs/{configId}/client-versions/op/rotate-entitlement-code

Sample: /etp-config/v1/configs/342/client-versions/op/rotate-entitlement-code

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

List client devices

Provides a list of client devices and its details.

GET /etp-config/v1/configs/{configId}/client/devices

Sample: /etp-config/v1/configs/342/client/devices

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: client-devices-all.json

Response body:

[
    {
        "id": "211edc0dfb5b4588b50df5f22246fddf",
        "name": "BOS-WP7XS",
        "registeredTime": 1597350058,
        "blacklist": false,
        "user": "user_id",
        "software": "Windows-3.2.0",
        "mac": "02-00-4C-4F-4F-50",
        "reportedState": "PROTECTED",
        "reportedTime": 1597684417,
        "originalId": "211edc0d-fb5b-4588-b50d-f5f22246fddf"
    },
    {
        "id": "563b533d8c494bbaade7adcbdd6fba5c",
        "name": "MacBook-Air.local",
        "registeredTime": 1597460084,
        "blacklist": false,
        "user": "",
        "software": "Mac-3.2.0",
        "mac": "98-01-A7-BF-AA-31",
        "reportedState": "NOT_PROTECTED_OTHER",
        "reportedTime": 1597684800,
        "originalId": "563b533d-8c49-4bba-ade7-adcbdd6fba5c"
    },
    {
        "id": "630ace6b4f2641dfb411cd652512cb04",
        "name": "Lab-Mac-19818179159.local",
        "registeredTime": 1593227576,
        "blacklist": false,
        "user": "",
        "software": "Mac-3.1.1",
        "mac": "38-C9-86-3D-D0-E2",
        "reportedState": "NOT_PROTECTED_OTHER",
        "reportedTime": 1597684260,
        "originalId": "630ace6b-4f26-41df-b411-cd652512cb04"
    },
    {
        "id": "6bff165ca84b41acb57056a79f49dc3f",
        "name": "Jacks-MacBook-Pro.local",
        "registeredTime": 1597457344,
        "blacklist": false,
        "user": "",
        "software": "Mac-3.2.0",
        "mac": "18-65-90-DA-CB-9B",
        "reportedState": "NOT_PROTECTED_OTHER",
        "reportedTime": 1597684799,
        "originalId": "6bff165c-a84b-41ac-b570-56a79f49dc3f"
    },
    {
        "id": "c0f06dc383774fcb92b41b7fb2f928e5",
        "name": "DESKTOP-6BDEKKS",
        "registeredTime": 1597678280,
        "blacklist": false,
        "user": "user_id",
        "software": "Windows-3.2.0",
        "mac": "00-0C-29-FD-77-4A",
        "reportedState": "NOT_PROTECTED_OTHER",
        "reportedTime": 1597684542,
        "originalId": "c0f06dc3-8377-4fcb-92b4-1b7fb2f928e5"
    },
    {
        "id": "dc475a9ec1924b0ba34ea95c0f8dfcad",
        "name": "WIN81-ENT-210",
        "registeredTime": 1592853974,
        "blacklist": false,
        "user": "user_id",
        "software": "Windows-3.1.1",
        "mac": "00-0C-29-D5-22-87",
        "reportedState": "PROTECTED",
        "reportedTime": 1597684516,
        "originalId": "dc475a9e-c192-4b0b-a34e-a95c0f8dfcad"
    }
]

Blacklist a client device

The specified client device is blacklisted.

POST /etp-config/v1/configs/{configId}/client/devices/{deviceId}/op/blacklist

Sample: /etp-config/v1/configs/342/client/devices/273/op/blacklist

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
deviceId Integer 273 A unique identifier for the client device.

Status 200

Whitelist a client device

The specified device is whiteListed.

POST /etp-config/v1/configs/{configId}/client/devices/{deviceId}/op/whitelist

Sample: /etp-config/v1/configs/342/client/devices/273/op/whitelist

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
deviceId Integer 273 A unique identifier for the client device.

Status 200

Get client status

Provides details of software installed with device counts. Also specifies errors and device count with errors.

GET /etp-config/v1/configs/{configId}/client/status

Sample: /etp-config/v1/configs/342/client/status

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: client-status.json

Response body:

{
    "installed": [
        {
            "name": "Windows-3.2.0",
            "total": 2
        },
        {
            "name": "Windows-3.1.1",
            "total": 1
        },
        {
            "name": "Mac-3.2.0",
            "total": 2
        },
        {
            "name": "Mac-3.1.1",
            "total": 1
        }
    ],
    "error": [
        {
            "name": "NOT_PROTECTED_OTHER",
            "total": 4
        }
    ]
}

Get custom error page

Gets the custom error page for the configuration.

GET /etp-config/v1/configs/{configId}/custom-error-page

Sample: /etp-config/v1/configs/342/custom-error-page

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: custom-error-page.json

Response body:

{
    "modifiedDate": "2020-07-21T13:26:45.638+0000",
    "createdDate": "2017-05-11T20:39:30.961+0000",
    "backgroundTop": {
        "value": "#D7D7D7"
    },
    "logo": {
        "value": "url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAA8CAYAAACZ1L+0AAAgAElEQVR4Xkycd5RkVfXvPzffyrlz7umenBNDziAgiooBAUVFQB8KqGD8gQHMgZ9ZogRBlCQ552GYnHumcw5VXTlX3fBWleut9e7qtfqvut3n7HP23t+wSzivQ7ObAzKiIrBxWzdTMxla29zIksLE8QVESaS9tZmmzi7SsSl01csTT+9gImFSqsJQooANCILA5rDCsaSBZYNh2xQtGxOQRIG1rTpBVaBaMtk9X6Vq2awMyJy/PsjLA0n8TRLLwxGW9rdi5bM0d3Tw75ffp+AoMTFlMrFgoAVFTBNi0yayBJYJtg3tbonek1SO7ysT9oh4e2X8HmgICLT5XexMl1nIVNmytIWDR+dw+CCkCTgkCRuZ0ekC03MmkiLQ0i5RrkKbW2E8apCdq7I8KBHqVBmdLJOXgBmbatkm4hFxWCJlw2K+YmIXwahCR0QkpGkMTJdwKQK9YQebN/QyOD3F/HyB2UyVhaqFXQBhY0ixz90YYmAmi9Oj8d6BNJ/6UBOKCIcPJuq/16xpoaE1gmoKKJLKgy8fY8d4io7mZsrZPDMLMURBwC+LJA2LSm1XAAOB2k/tWeWVKRs2qgRHs7WwwIaAzAUnhnj5eAZNa0S38mxa6Wb46DxnnbeRD2bG2b5njlzUJuOwqZoCxbj13xf+f8/S5QqpnEA6VkFzCfhaJRpaRLobRLodEgfKFpJbxKuKxNMmLh0imogbHUEWGBvJMjFvkXdDc0DEsCA+a1Is2ISDItF5k83LVRZEG68uoM1IzObKLHGoOESV7EKZwWSZjGUTz1ps6NNJxA2yWYuegMxpaxrJlaoMLGShZFEL+1zBYGbRQlgVkO0z1oZ4Ye8iRQNEC9b1Oomny4xGq3QHZTSHwsr+AC0BL7Pzee7/YJ6+tia+ff3V9K7dzLdu/DY79+6ntjW1rbUQ6reitvlLm/yURY1MdJGyaeKRROZrKwSanSKbVnlpbNnAkbEo89EFlkXyjC2UWbvGyzv7M2TyFq3NIqmSzfy0hSDY2P8vqoCmCazZqDE1XsUybTIZm9YVMsvWyCxmLTo0ESUoMB2zWJwxaWlXWBvxMZnLUiyYhIIKkbzGu5NZUpJFT6eMmLOZOlwhWYI1y1RGMgbtAZF0FQKGQCigkluo0CQruGSJiZkSpmmTsK16ZpBdAu0+BVdFZOPydgq5ApPRJMWKSdghIYs2sarBkXEDYUuDYi/v9PGvvXEqpo0sgE8VcckCc3kTvypSMaEzKHHGujCposYLQ1muuuRcPnTxx0hlC0yPDfPo3++hXC7i84VZtqSDLUu7SFfAodrsmC6yJqyQzecYn4wyMDnN8ckFvD6Rm67/Jpdd9SUWJ47ztRu/g2UuEMtFic8YzGdNOhokdLdAYsKiULUxRMiU7fopqoWxrUWlu0VB8usMjmUINgsEOySCAZlk3sSVsYl4JY7nTRILJh/Z3Eq2UGI0lSGLhVmxWSNqbJ8vYgnQ0C8hztlMTRgE3BLtEY2D8RL+oAi1vx+3CCCimwLtjbV8BOl07VSDu5bSFIFo3qBiQMSh09/VxHsHxsnlTCJ+maYGjUq1ymLRIJG3EJZ5Fdvnltg9V64vSBdtFFmgWLbrKaR2lhXAKQmcs8JDb2szOxeVerDWdTWyrdfPCe025VySt48m2HjCVkqCk2R8EaNi8a/3x7jm5BYaI17GYnmyZYvndwzyvQvbKQpOXhspM5CW0SSJ4alZurtb2fHSU8wlTdwNIp1NEkNHjPoJk2WRTMnEMGwUUURXoHOlilqycHa5GZ3KsPRsjSa/Rqji4fholKWWg9lCmSG3jdOwOakjzK5MhsRsGaqgKNCBwKGcRbBVrKcca9GqpwfVLyIIkIqatcyBXa69A4IukXZdpWAbNCgSJdHCKoJu1V+JWhTIe20cVZlo3MAMWAQMkZBbQ9ElYoUCsgj5go1w0+kN9h/ejtbThlkLow2iCFbtTf/fIwqwsUGhu7ebX193DkdHorT5NdwujX0f7GLfRI4lq1cSbgyjiTb5TI5dRyfYfXyOq09fguT1UbFsFrNVdh0cpE0scmaHQvualURNN0PzRQ6OLbJmSYQ7H3oeo3YauySESZtk0cIwQZWEeh3RRPC4BXSXgKaLtDa5yYQNMt4KTid0tgRozTcxuTBBYbxYL9z6aRGEeG3Tq6Q0jUqyTDpVZT5dokkXGM9adHWrONwKR4fzxKZMWpsk9ICAaQtYll2vCS1BkWZdRDMF9LyMYZqURQt3WqMiVRFtAbkAsYJBJKBhllXSch7TYRIUZJy6SrVqkrIqhE0nwtG/f9r+4u2vsGMojuwVMWuF0ilQjtv1YPy/R5RsNnXprFu/hZ9cthVJlOuRyowe4d3RPO1tzSQsjVffPcJMIkvGEBiLJijlC0QCXrYsacYolVnV38KZ6zvZc3CY+MAkpmZx5QXrKFsiTreTWAWu/snDNLcJKBXw5wVUh4jbIeFUJGzbAtXG61bqp7NsgOx3kvBkSclVnLqC1+NFKal4TIvJaILoosG287YSm56mUi4jRhTyc1UyRoXFTJpWn5vhVBZPSCVXNjl8qERteV4VXD6Rig1NIQnVBS5DQJdsREQ8RRXNFvAaGnYWpoppWpxeGtwuovN5dLeTbNGgkC9Sskq0d3sp5ksYFYGcWCCs+hAyR/9mxydmOeGKn1FwVKnkbTo2Kkzvr1JK29R6SsUlUFt3/3KZ6KjMB/f/gKA/TGJikFt/9xifO38lrxyOMXB8kh9+9UJC4UZ+/+DLlHI5RheyxAUXF65v41On9HDPc3u488Uj/OILZ+GTKoS7ezlxfX+tj8WIjzJnBvnTQ/dTiWdwSgqaYaB6ZDy6hq5qeHQoyCYWBtVChZxtUtAMcp0CtmDjcbpxigqFjEGHM0h8IcqCp0xTqInFbJbEdBZTraVaB4upAtNTVc5aH8aHwGvzSdwRgX07KjgDQj3VaJZNpFNGMCHsVRBtq56iC4aNLyZilA1aXA2EVBfzmVk000ObP4hgiMQLeQx0ivkcFkWKlkE1Wcbl17HdVTILJkJ26O82ls41P/omeX+CyXEDX4tEet5kep9Rz7frT9JwN8kEm0R2vFhieXc337/oQxiHD3DlHz/grpsvorGzGwJt/On+J1lcTLCxK8xcKs9CqkSjS6Ej4qSxMcRpJ64lGo0zfPQIPW6T+549ylc+tRGrYz2DRwewfAFe/89/yCYMUCQcokVri4I/qGDVWjhdpGRatLY2k4zNkzeqzEsF5GaRkt9GLSkoloNyyaLXtYTBiSHm7Qxlh0CDU0dcEJiq3cp+lcVohXjGwq8L5OZgWZcLU7f4YCRPoF0i5BYQina9O2z2C+QsqJRsnN5aZRTwFmysgo0aE3HqGo0eJ0E5iCYoVEolomYclxpCLFuUczmqFQuXriDUGhtHiWylgPDKM5fYy9rW8dr7j7K7OMvO3RUCNSDhE5FTUJFtIi0KzS0BdE3nnTencIYkvtHxEd55+gN2lbz84qZPI4U6+c29z1IuZSE+xWfPWs2e4zMMTKbZtCTIB4MzvD8Sw+1y8+vbrqfLK0Amys///DidDovTP34huw4eIpueJzk8RUlQESwRwSrT0uYCxcQnq4TCYRQBNHeAaHwKUZFIVgxi7iQxPU+lYOMUnZSKJuuDmxmYOUyMFCnZpkNy0JB3M1KKI/cplKsGqZxJKmmRjlmU8jbLu1UqDgstLFFIW8wPGwiqQNArYGoCfr9Qb3X9ARFnmXqjISzaiBK0iE663T4iio+5RJJhaZGI7qZJilBIG5jFIl6vRiKbId9UQpJA+NKdPluq2AQ0ATHsYGQkj88v0h7xIQsBspOTlCWLUFeIsOlnLLNIJlnk1NzJNHj9/ODJAf7+oy9TMTV2TRZwVFMceutF8uUKo1OL9DV5WL+ii+HJKJ/44lUs2XoRhfkBZLtManA3z7z8Aef0iLhau9i7MElmfhTFrOX62mnLYksWZdnAXanldJlIcwuWajM0M0zBZeFUHVQqVaJCgXlHnnzRpFVxISDhljwYSpWpTIz5rEWrotHqcFOWKhTlKjNmpQ6ckkkLM2vjcwv4nSLOIKQtgfFjBmbBxuUVKNSaEg2WrFYoTpo4HSJyBUzRIpWxGd5eweEX+dDyMGrJQHXZFJ0mDlEkXPHilrwIRhWXplF0VJhf7iBTTSFc/XufXanYyIrI0tY2LNOgmE9RqVbQnQrpfLle7Fy6QFhuJexqI5Lcisss4BZsfvDAG3z1Mx/i32/s5zOf/BiPP/AAl335yxx65JdYuTyqIvPGeIUvXXcV6aLJfAGee/VNPnH6OiqJWX779Afcfc2pvLRjgI9efAqGNc/Y2ABFqYRQKBN0+LF1FacSwF2pURsVJsxZ0kqeoiWSyxZxWTJZqVivBYHagvVWVN3JVHmWxXSOvGDV19KS1+v/z4KcRihp5BST2WyZYq5W1EVU4b80R16GimFTyUOjW6Bo2+Qt6hSFQ4HVAZFgk0ZVd5Kfz6C6ROJTFYQ0rF3Zj6WUELwxRIcHIW8hpw20pIxYNSkXyzj9PsYbDZKODMLlP/LYwUaVhkAQTXIxNDtO2C8hShrVjIBZLlOWqvjRWBVZx9bOT3PLd/7M1R/dxvuHRvB73Kxau4Y9g9OEGlrRq3nm5ufRx94hOZdG0DWcfgeODRfREAjh6V7Go3f/iR/eeCVf+MZP2dYbYk1PA21tYQ5MFvj4uZsZHtvOaGYMo5wmqHsRxQCi4oBSDkutMCnMs961hJ0Lg8TFDE6vTLFQQUXGazlpa+gjLAdZKEwxkBplJFUgEtTotGpAMk3Ra7OYLmEItZ5boJC3UHQboQSiLZISTOKLFo0hiZAskS0KDMXL9VtZWLBoaRdZ0+vDr+vMVxLIzlrwRJrlNsq6i/zwFEVHDrlRRC5BtWyhFcCXVclLBhWXygwFsoaF8PMHO+ykWMa0RSRqxaJMqMlFMl3GzHsRpBReUWCF0M8ZG65iPObhpSceZTZv4ysuMju7QGDpFkbmFjnnlPWsCwm8/NB9NIV0ArkCVUFmQRQZKzj51NduZHBoBMnpp8sn8uXv3ckvL9/Ar148zjM3n8n3HzvMd67/HC4zxfH8fhZyg/iVAFRlcnKJpBJFJ0DOk6NZCDOeO4Ipqig13FEq41B1upxL8NsNVAtFFq1hLM3LQjJB2UqTzdhEUxUqtkCwwUehWKQvGEaYczKenULpNihmbQTTQnAKNRYRv+Go0zKDiRK2JFCJmrgdIuFWla1NDSS0BHHTwGNJBEMdLKSnSc6VaAzqWD6rzqXpCQlDtjGqZQq6SBmRgmHUsYbws4d77dlSAqdHxLYF7KpJwOEkNpXDUgQEWyToCnCqdx3rN9zI40+8TEdHG3+9+yFuPL+HQzsP4Np0ES+9+G/8YonVJ5zB/OtvstSVp5yzcOswmLVJWAorLzibR556C0mBVWu2ok/v56ytXXzh7j28+8+fc9nN/8ttN3yB/o4QxfxRDi68jqq5sNQS8WqUlJZBMkVklxvLqmLZFVRJw4n8XwLQNOp0gaJ6sUsqyeQUaVlEFAUEy2JouEzZkHDbIvFsCS1qs6zXj7Pdi1WRWfTMUq7a2KZFqR4ICIZ1rJKG6NWIZpNU8hZWycARkIjoTgpGHqdfRFNrTKiEUTQRDIuI7kBUgxi6RK48jy3bWLaFaGv1Lk6STGTTRLj3mZPsmdIshUoGQxaRBZNSyUaXJSRJwUMIHY1Pr7geTe9l974BVp90Js/e/RuCLoWXnniCQLAZx/ItTAzuYnI6x41bIijxIXIpE0WGiZRJ2xnn89sXdnHuGhnLtwpd9vDmi89yxUUncHwuwUVfvJmf/Pr3XHXRqWw9cTN2+hB75p9Gs1QK7jwLhUkQbGRJRHD6yZQzFK1cfc8DmhelWqRaqTBTsFE0UAQJp60QXSzWT3WDw890Ks1c0sCf/y+SrpQsSglo36Sx6DDRFIH5mInuEWhUHAgYSKKCZPvIaHl0RaJqGjhdAqlMHsm063ggEpFJJWv0vI1bEXDULo9h09zQjZXLkgnl65SOYVUJepooGllkE6LZHMKvnl5l59JRTF1A10MUqkmKteLn9uBQeshXFmkR/Hx85TcQXb08/uQLnHjq6aQmjmJWi1z5le/wrfVukobKlbf+jBuv/x4XBLJsWhfGLhvk82VS6TL37MyRbm7n3nv/xLe/fgv9xjTvp0WuuPTDhFpb6dtyFo888i/OP20zrZ0dKIUhto89xGJ1hKxdwIGGO1NAMQMUfA5yzhRzpTTlAqxQ4OiiBTJkkla9i3PW1uMWaZS8VGct8lhk5RxCQsfMO7DsDAv5Gn2t0NTlZyGXYDJR21wRy7bZ3NpLRHZTIUvSKZNllga5i+m5IVzNSj0wai7PgmyhOQRSs1b9c10NCoZoUS6DLUlotoiiyKSzeZweAY8jQkXIo5lOkrkkwu+fXGKTNcg7pBpWI10qUSpb9V467G0ik1/khOYzOGv5tZQNnT/9/i8cHZ9iYnKKDcv7SS1G6a1McEKHG0nzEp1dZEmDRseaZdiVCoZRYeroIHsH86R8TZx71kaO7dxF1azwz1Gbr1z3ecbmkrT0r+K+e+7lc5+4iM0b1hLx5Hlr6j4OLL5bJ+r8qodwxSCeKZNx2VQdBkYtZdrQKzSSThdgsYQbgahdJiGYdNbAlBaCfI3Pkah6SlQyNtWShLPkwNZ0PJ4m0voiI7FhkmkDq6ZrOCVaw2EarSUg5ag4ZGLyOLoYpCrZZHJTzI8UCQdEbJeMUxCwDYtsxcYry1Q8EtVyCdWEgNdDvlREEDRksYAoCURzFmZZwLAshF8/3GK7hAaychXJsolWo8SzBh2uIJYtoKFywdpr6O34KIYlMzcxxI9/9FNamyOce/o2cvkS87tepEstEJaqWPk0vpZmfA0tSKpeV8eS00MsjE5RUT24gyEGxhfYnxI588MX89ahCd587wOy+QLJXIHPXnQ23/3+t7GzYxzNfsDzg/fi0QRCTgmfqSDbXtJqgZiZI5qo4QCBpc4GnNEQpcUYbodOVigQFeJ1FUu3PaiCgGaFERUVVW1kJDeNs4aOxSIerYOiVWHRmMLraMZVS5u6Qk4ogOSiJGRRVSex1DwOJQhugVwxQbVs0OxspEKcYixDOB+i3GRg5/LMO0zyeRtZhYhXpZytYsoyLsGoq3iFGu1s2AiKhPCLe1faDnegHlVLVKjIGRAdBIouvJqfqlrlws134PesoLg4yfR0lP2HD+Lzh9i2aTVP//sx+iMaMwd2cXq3g4nBMTpWrcAdaawrMrYgkRgbZfbYESIdjYznVPbN5lE7V9HQ3MGZZ59Jpljlf376OwJymdt//jOc/giF6ABH5t7j3ZEHMNUiVUwCThG3rZIwKsgeF4VsjlqzEpT9eMwIyaF5dMFJ3lMiP5dEE2V03USKOPB4PQTzjdihFmbtBVwOAcnOYltlxKqTklKudzkeuYdKJc1MfhRBd5JL1/BGjnxaoMPlY8pMkihXiTgEPJoLW6igeERUvOQrWfL5Em4ZcrZQ3+SagtftF5kp2oSaRRyaE1HUEHMGhUwV4bo7Gm2Px41uGDQGu5iShzEqJt3lCAk5QWPLei5Zdzuy5KFayGNaNgsLUZ555gX8TpXB48fIZTJ8bbWBR1NJ50q09PWjeQPYlolplFkYOk5ibp6GsItkqshBfQnTRpDTN/axfzSKoqo89/yrfP+Wr7F66ykouptiZpa9A8/x1PZf0NOg4nS6cZkW2bzBrJUn0tdHdHqKklFAl8GPk2YjTIvdRkaJEpF0FDVCsRrDVgXMSgUkJ5YiMpwbQtJkXLq/Tp55NYGstMhsNo1d8dEoe0BOUHBJFKJ5qloVS42gGTppw2B4YYQOrwKSVde4PbWWsyRSqpSpaStyFbJ2tV6IXSUZpWBTYxFTullvRb3+YL2rqmTzCBd9y233Nek06kEaHG28W9hLedFiW0MvO0ujrGo+mU9u/CaKpdT1xqpRu14l/v3UCyzEk/QEFbo8sFSO4XE5yKXSNPT01pls06giYpFbXGRwcJL2iINkIs0TUxKjGYGvX3sFz7+1mx37Bjhr8wo+/qlLaWzvRVI1ZFnm6LEnGZj/B2KpgqsgEhWzeDSF44kopiHQ1hpgJpOiUKjSEWnDWxN154qEGjXCto8os0i6jaZ4KclFFHcY3TRYYI6sVaKCiYcgQYeb+cIMedsgWPLhtHyUnAnEuBNDUnG5K8RyVXSPh8MzE8zMFehp0slmazVHRvBY9dRkTUGLQ0P1eTBFA6lqE9BdpItl4maFAhUiegDFa5I30+haGOGrvwna/f4mJBR8Qphd1SN0F4JozkZei+9ha89JbGv/MP1NWymkMlSrFeYW4vVoP/jw4zQ2txMSMnyoT8UjG+yLGqxYtx5XJcrCzAxVFFp0i3i2jK6qDExEMRv6qUoqj799iB07dvE/N3yR7p5umtu78QdDZNIJ3B43peIsg0P3cdAYoFPtRBTzOMRmEtkJ9EUFvUXFROTQ+Aw+ICxFcFYrrGruI1kUeHd8hkafh1NWNFKQFbYfm62njUhklJhSqKtcJUXD4aiQMstUKlm6XGvRbRdzxkEqaQPJ5UAXK3Xp0uWo4QU3hbEspbzATGKaBp8bV4OHqqOEjlTnryJikJFcjLjloK29hebxEm4xwgH3KKbTS6vWQjhfxnYZCF/9VcCu9cjuQDMeU2XfwiBnezdxTI4xlJ6knFG5ZP0nWBLYQtjfRCqVRXW5SSTSDA8NMzI0yLr+NoTkJJVElEVvH9WDuzi7u4FyTX1Kp3h8JsflV13G+DtPs1CzYkR6mY4XODw0Rtjn5tJLLmTllm11pSgZmyMU8BGdGkMwDaafe4jGlgAVWWM+Y3PGlh6efOcY6VyFr1yyoQ6+3n7vKC1NAR59d5RrL1jFB4MLVDU3l5zaz/j0IocHJjlr20pe3TnI2wMxAn4n1354LX6XSDGTxhSrFDSFV3YeYfdskZAucv4WBdFnslhOkzcyKIqEoqiUHR6kvE78cIxsKkNwlYTocFEolZieTVEWYW1/C2VZpFw1ySXLVI5lmcsbBNcJpMZMeh0+ej0Rkk4D4Zd3L7MVb5B0Yp4GPcKe2AAXtVzC9tK7HBlewIOPK0/9Kt5KBH+4hWSmQCZbINLQUNdoo4spRg/swimb9AQFWrZezD8ee5Il7z2Fs1zmj2aIO37+Y0qTRyhnoyiNvew8OEZLZzd+rxd/OFT3FOXy/wUrUyMjLG0LUKzaDOzbizw/zsL4KOdtaqGk+dE8PiJBJ1+9632+ct5yTtu2jHKpws6D47g9LvYMzPCZc1bwvXu388kzV7JtXSfFTJaXXzvAhz+0iUdeOsBThxfpDupcffFGOtrD2Kk4mtdHdCHBUy/v40vXfBjNF6B47Ah4vbz89nH2TiU5cWMDa9aGyBWjTAzOc2zOYFmbiqNRZLY6TbRUwLRKBHweKlqOatKgUPTjtn3k5AWkiI3HlKiYVt0A4MCL8JuHemxJ8aFXBXyEOBY9QId/I0erx8jnSkSkFgJmGwFxHauX9VC1RAzVxQe7j3Jg/0EuPP809u8b4PRtK5kdOkzJklm57TSeefhB5sbHuO5732b4+CRvvfYShUyGL37+Ug5OZlm3aQPRhRjpZIplfZ1U8mkUh4v0+DHKU8M4G1s4NDBJcHpfjV0gli9w1roGZgpOzjihj73H5/jRs4M89p0P1Tuc+bkY9781zmdP7EDx+8nEU3z9od385gsns7K/hdT0NHpNqtRk7vjzizi8Hs7p9/Gd/4zw9++cS7gpwr1/eIxtZ5zAyg3L69qxlU7y1PO7eWTnNPfd8dl6WrSrZSb3HEZ26DS1RCgWq4zPJnlu5xQrlzhwrptmQZ3BUBUU24FUqvFpfmwljaz58RerxErTJCjT4O9DuOehdXaumiZdyOEuqei6j1QNuSlpFBz4y04KGR3zWANnX3AO/mAD8VyFocHjRONJpqM5gh6NwSOHWbl6OQ0BL5qqECsaxGJx+tsaKWYz6A6daCLDWDTPquV9NDY34/F6oVxiSX8Pk6OjdReZUCqQ2vc+wwfeR1B1tvS6eWH7NOlKlZsvauLwgkBHa4hwU5jfvTRBJODhcxesAUHk9d3DPLFzhls/s4lQ2Me9j7/P2+M5br3iRHrbA1AsYVkWlsPJnQ++zdJmN1ZikYsvOxMzm+WW25/gS1+6iJXrlmFMjzF4bIIfPn2UX15zDu09LXWfU+02PfzEdg5PZep0fG9nmOXLOlje00QsnuTlHYO09Cr4u/KMlBZxNGnoWhCpkMEuWXjlEAvKKGmxJubUUtBfOu1qLI9QAwllCYceZlqOo4R1Ot29WBUVK6+SOt5B0C2wckk7i+NDZLQQE9EcE2NDdLa1kTckXnnzPU5Z24OlOjk2NIqq68iiSH9bhLd3H0F2eDn3vHNwiDYOVWPF8qWoqoKmO0hHZxBzCYToGNLUQQaz4Cyn2NCts/94mh1DKW4618tgQmbVylZEzc1Ussw9O2L87OrTycYXyVYlfvDA+5y1eQmXf3Rr3VRwx12vcWg+z02XbmXT6jaEUhnR5WZsYIg/P7mH+alp/v6H68nOTHHBTY/y0l+vQ7HK2Lkktz3wAY0NQb72uXMxEvPMZSr8+IH3sAWRK07r56Qty5E9PkqZFOmFGOPzGTas6617lg4PTDGnpCj15evcz2w0hluysQWVI/E4Td0qhayF8I2f+G0lpiNX8tiyzGy5jOARWd7fQVukgcH0EH2uLex+qorb72Vl2EJSXew5PMbYbILmtgYmF4uItZZTkrji85dxcP9hvL4gnb2dvPLCK7REPBiCzKNPv057WysfOec0xEKyLtj4V2wgOzGOR9MJuQSk2UE8doK39h+v35SAEaNUzHNwJMeZK1SOzFRZu76TTN6mtTXAo7sSXH7eKkRZ5qW3j3D6iSv54v++wR9vOI9gU6xmPsAAACAASURBVBgjleTW+95hf8zgqxes5aLTV2AVCliSyOe/fS/VbJZH7/8uQ4cHufvBl/j57V+hNDVGPLrAHU8d4zdfOx9ZtMjOz3DtXXuIFkr842tnE4n466ai+eND9drj6egGRcUsFZkcHOPNg7N0uuBAVsPZapLrHsYVVBlZTJFM2kSCYn0Nwtd+GLCV6SphWadYgahdoqWnCVdEJy3WVP0il/k+zuvbFzkyneDcDd0cPXQMkSqT8QLelmaq+Tx+nxe37qB37RYaarKhUaFczNZBncsX5MiBA7z3zJN0hTyE/F7mcjZFU2Npox+nUaCxqxM5s4Dk8BEsDjFRVPCaUWSnF93MMTebpK3BSbZQweH1UVIchFwSB+YNVvU00trVwu7j81iIjMxlSBRNvn7VOdilEuP79vOrl8YYSJt8+9Mnce7mHjAtfvHHfzKeKPHH//kszzz3LutW9tDRv4RMbJHb/vwi1156En1djRjFAj+86yUWMwV+eNlmQgEP8fkoNbNSoLO7bmg7ODDFy3snUYslQh6VRp+GO+ChrauNBq/K6EyUhyePEDo9SSJdxYpZhMNehJt/FrTNxQptqp/FhRKViFTnqRedFaQGmdP1TZwcOJGFosh3f/sIZ564hqXNLsYmFsjlC3hbO5GsKp3dnQwcOICteQiEG8lXRYrFbN2HU04lceejeCq10gNvHs8RcjjYKOfx9SxFFQzk9By+phY0hw7BVsqLoxiihlqN0eAWmZ6I4tPF/7rGdCcNHWFmEyaWbXJkusBnPnICs/EC37x/B7+5+mTuf24fN37xApxOjfTYMEOjUR7eF2U8B/fedAEiNrH4IgOTcS46fS13P/gCV3/+4jpifv71/SzrbKBvRQ+JiXH++OwBHJrGDZefAbkUyYUFRM2BKxRiamKWPYfGKJYtNvQEaetoJFaRKRXLLMzMc+DYDDPpIql8ha5mP97lIqWehTqBt1jzLt/2swZ7MlFgk6+FWNWsI0SlUiQqW+Rkk1tXfxGt6sbX2MKX/+dvFFG45ZqPM3TgAOOzMYJOgc2nnkXFNNmzd4AlXWEeevY9Xtt9DK8q89GVAfpDLrxBX92SmE2VuWyNC8WoUg6spjBxkKbW9jpno+WiOPtPJLMwg+hzEovnkM0c/a1OyokYiXSFsE/BF3LjaWzk1f0xNrU7GZrIsfXUVeAJ8e0/vIQ74OX/fHQzv/vHu9z+9Y+QypW48S+vc+W6ILe9McsZy5o5eWmAai7BOeefRimf59d3vch3v34JA0fHCHrdtDb6yRfK/OD+d1jml7n6yx+lOHoczetBDjYyeXyYJ57fy+b+IMcnkxRrZGJJ5MB8FqdocdPFK1jR18TU2ByWJLEQTXDCyWtILCzy1vgco31TCG06wm2/aLArokWX3EPSKiEulEnGE2i9TrANruz5DPlcmaauPp55ax8/vf95LrnwbD56ykr+9fRrnHPGVjIVibnpKdavW8lf//kCjz//Nudt7OFjJy3FaeV448AcFHKsa5Rp1iw0wWQqblCoqrR6JHTRAH87gco4sqbzbKyBc/o19k7kWRKWaNQKlFIpUikDt0emo8mBq7WV2/41zA1nNuFvbkbUnKDqHNlziNtenuesjV187Mx1BBQDNdjIjb98ksvP6OPoZJKHds3y8Y0Rpsdj/PDbn+WJl/dg57OsXb8CD2Uagw5e++A4bw3EuWBrLyetbsc0DUSnu94JHfzgEPuPTNcDG8sUWcyUCLgVTl3fzZrlHbS0BLEKOUYPHeHYYJS+tf2kihUefW+U1HySk5cFOPn0XvY1xRDuvK3ZnqpmsV0hgqEQsfkoEWczQVunTZPpazgJKkXCDWFmMjbf+tUD6G4/N139KUaHhog0RuqDGm1d3Tzx/Bvc9/DjXLCln2s/cSoTo+OMTy3QqpZo94rYuRTVqlHP2zMLJU5slHC7VJySiag760MXbqXEU6M661oU9sc1LlwqEY9lcUsl4kkDzSmztMOFo6GB7z89waYWnY+duQJBVjELWcZn0xwYTnDH9gXu/z/nsG7zWqxKiUee3l4fCjl3QztX/vplLj1lCYvxHNdc9RF++8CLXHZSO816hYW5KH97Y4rBeIk/ffMS2hv9WIbJ5EKa48Oz7Nk7SixfRRJNVndGaI04WN/bgL8pVPcY5XMFwg6BufEJ0qkssq7zzP4oiqazYWkDXSGVQ8emOWNNI2LAifD9m/22prtJlAvEZBOHw1GnAFrUCJ/tPZNC0Yvf46xP0Ci+dh577i0eemEHn/3Y+Zywtp9gYzOVqs2f73mIwYEBTt64lI+eu5VdOw7ilwo0qXlkq0w1myaerfDb12Msd5uc2azUZxH8XoGaLcapiXhbm1DLCfZOW4wkbZZEVDb1+xgeTuLVq5QqNdVLZUmLgu4P8atX5hiOF7nnq9tAdVAoFBk6PEJni5+bnpjAFEX+ceeNCDUxPJvh+l/9h+svXMk3/vIqP7r+YkYnF+nrbOTo0DQnNxZwKfCRO3dyYn+E33zjEgTbZmYmyU8e2slcukC6XKFBhZ9cvpm+1UtrxiUsQWRyPMojLxyoj8d87NQu5iZjDEzn6G52MDid4/KPb6n7RHd9cJw3945z09Vn4nI5uPvx7QjfvMZrp0QLvabWKzJBh0ZRgHBZ54YLb+H9vcfYsHop77/3ARtO2EK0IHLptT/glK0buf7aK2hsaOTVV99gYmqKkEfntG0bKMTnID2DLlvYlSLFYpGHXjvG1OQiZzZCAAh4JIJ+mXKpRqeB063i8WgkchXMqsieqEG3B/oaJIbnqrgcIgGXTLwssaRRxhUJ88SeGL97Y45Xb1yHHgxiyG5u+OObfPPcNv6xZ5EnjiR46TdX09LahOgK8Ps/P4pVyPL4O8f4xIe2srq/m5GRMVrUIj6K3PzYYdZ3e7nj8ydhVwxu/8deXhpM0hLQ+NI5K+lrctPssJmMlxmcSjKeKiPki7R5ZVav7qx3NQc+OEI8XaKtI0JXswfZG2LngTEGj8+wojfIiSevqXNE377nHY6OJxBuv6bRLgYlFAOyHo2gC+bzJdrlMNed+z1+8odH+D+fv5ixo8fp6O1EdAZ49PHneOzV3fz6pz/A43IxPDiIbFc49eRtFBZGsAuLWJUi2VyRXQOT/OuNo2yM2JzdIZOanEdVZVxuFanm/cREqzmiJLluet03WsBV49llnYBaM1SJJJMGoiaxpElibFGir8OJpmu8dizNDY+N8OYN62loj2Crbm5/9AArW3SWt3r59H2HuOPzZ/DxT36kPrczPz7O/977DEGHwPapPOduWUlrow9naordRyb4565pHv/6RhKpEj/61wCHomXO7Aty9RndRDNVxtMm08kS8+kcfo8Lv22wrcdJoLGBVCpNOV9lebefpiY/gsPNe7tGGBqapy3iYuu2FYRbWqiWi/zivtd4ec80azo9CL/9RpOdztg4ZY2CW6LQWEWxLU73n8SJ267ga7f8kvPPO4UTV3aSSyfxNXdRFl1cc+P3+dbXr6Ozt5/Y1DD9S3uRjSJGMUuhXOadXUf56Z//SToe5+lbP4xbtogf2o9VzFMV1Lq24A15kMq1Ib+akdAkV7F443AWTRbZ2u9HE6qk8ia6Q2Imb7Opx8lk1KC/N4CkqRwYjHPZA8P888plrNmyou5Ee/i5XewbTfH9y9bx1T9sx+Fz8dCffwi6i2oxyyN/e5D+djefv/M1zti6mp72RlYF4JcPv8XFmzroUkrc8PQoiarBzeuCrOlv4Iyz1qL5G7AUnaopYhll7FIeiilefGuQpw9E2dwToD+ssKK/leaONg4fHuWJN49xYrtG5+qVLFvVX+MeeOXdg/ztsZ3sS5Z54eZTEP76g5W2QxLwO9wUa9eLSZSigw+v/jJN3SvZvecod//7dX7xP1/HLmWwanZxfxN/f+hfrFq7FofLy+plnXVrI4LEu+/u5K5/PM3BfQf4xKlL+ew56/FJBQrzU5Sj05TSBUqCA49DoFqu1ocnPHptVMjgqYMlNjbYFESVsC7idkmMRKv0tescnqpy2movIzMVVvb5kRxOjozGuPS+Qf73wnbOO38joupgLF7hil+/yF+uO5OR0Xl+9/oIL99/K9ViCUHWiE6PYxdiXHnH02xa2UNrRxuNmsFfHn+HKze38rs3RylWTe76VB8nr2lmMCHxz/enSS1mCGgypiDhVqEtqNPd4kGomZwkBaNaS50GbrHK5hNW8+wbRxmZjuOuteIXbKCpraWOMa76yeMUi2W+ftFKTljdivCTP/fanryEYFYJ2h7S4gLrW07GIW6gb+1qLNXLL3/xZzqXLuXskzeiGAUUj59YssD07CIbtm2tO9OqtsAzTz7H9nffqRtyLzxtDS5dxUjNIxeilGMzZOfmSMTLlCRnfV7KqdYUkQJm2WA4WiWfreBSJGRdxa3VHMgq7x4psmWVj9H5EietcDMxV2J5jQtSdI7PZLjsr/u5/fxOLjhvHZInjOAKcNWPH0UVLc5aFuFnzx7l5ftuRXIH+PVv7uI7N30ROznFF3/0AP5gEFlW8Xld7Nh1kBM7vTy8a5IfntfF0haNv29fZO9oso5keyJuNnQFOf+U5cjeIFotfWpS/UA+8tQORF3jxNUddRa1u7+b6clp7n1iF20+jSuvOAfTsvjpPa+wZzjOR7a08cWPbcNMRRH+8r9LbNWhkk0mkHQJnxLm/BWfIT2XJtK1DMnhZzGZ44bv/Jwrv3AFm1Z2o6oaZVMglsjSvWxFXax46dX3aFGzOF0OIn4numxTTs5j5JMsTk9hTR0jF12sixc167mnNisVL9HiMajkSuw4lKenQWYsY7Oqy1EfQ6qJvTPRCppHI5c32dDvJZ4q09PpQ3G767MHl/zhIDef3sqlH92GGGhB1L38/pHX+NOzezm9v4PXjgzz+t9uIdy9jAuuvIULN/dxw43X8fd/PMED/3qJT37iYt7duR+zWKgreCd0e2nzqdy9fZavbApyyaldBLr7mZua49f/Ocrbw2lkSaA96MIlw4e2dHHW2jYWxqfQGtsQKgV6lvbUDQm33/k0l5+3gq6VK9h/6Djfu+ddLt/azCc/ejJWOookKwh//fsS22P7wTJQLYXTln8GpVrBiM1x7MgUfZu3IvpbiaUK3HnPv1i3eRPnnbKBcrGIKTto7u4nU/OAxidJTQ3VC6lXLNSxg1DJItkG5WyGzOgA0yNJHJFAzXKJYhv1tk+wSiQXy2TSBoIksjMhcPGKmou5Ju8qeB1wJAo13TrkstgxWOC0jc0EIgEmoyk+/seD/PjD/axa1kr3qrUowVYOHjrGxTf/jUKliltXefXuW2nrW86VX/sRR48P88xdP2Y2VeJL37yDqy77GG9s38vqpR1MDw3R7zI5Np0gXqzUb3WmbNb17ZrrrWqa9IcdrO5ppC3kp2pUmInlOHlpGJcqU1V0Ni6JEE8W6F/azq/veZGPnbaUaCLPY9tH0EWZ2649t653G4sTSOE2hN/+pc12Z3Wcip/NzeuJhJrqdgq7UCI9cZS3xmDrtk2U0CjYKq+9tZNl6zbQHtKo2VnaV5+AXM2SGdrJB++8R1dbBK9cwqFKVEt5SqkkVj7F+JERDs1VUVSdjrBOk7vmwayp/FUyqQpG2WJH1KDJo7GhXUFQZBarMr2NCm8cL3HWukA9KLc/OcVXzuukp7+DWMHk0p+/wY8+uQ5bd7FuyxaaOnrI5XN86dt38uLeYXRF5tW7fsDyDZu5+8Gn+N6v7uazZ27gc1/6HF/+5u10dLaTzWRZuWIJk8MjhBSDtw9OMZcvsq7Fw6Y2NxeuaWF5VwjN6cTp0pFDbdhGhdrclqDoPPP6fjb1hXh7zzinrWlicirOxo393P7ge0Qkk90TaZZ3h/n6Z05FtM26P8k2qswmKwi//0O7LSQsgqrOecvOR/SEoGyTPr4bSw/w3ntHeGnK5PILtnDo+AxbTzuRqimzb2ia9UvbWHPqRWilKIW5IYb3vlcnp1SzzNK+lnqOrKQTHDs0xAPbk2zrcnP6Sk993kym5q6oEl8oYNTGPz0irw6VWRJSWN/nBo+HeCxD35IQ7xzKcNraEFVB4dYnx7jloh66ViylaBhc89tXuHhjN5MFm1LJ4sc/vplqucy///MS3/jtP+szXa/c82P61mzg3ff3cOl1360DrId+913ufezlOqWsSBJt7W1MjQ0RMDI8u3uMz29o5NqPrECzq9Qm9hSHE1vW6htnV8rI4WYo5euFPRFbrJ/6p/bMsbrdR9CpsHZ5M996cA9vHpjmhZ98jOYGL6KkYpv17w+oA8ob7nwe4dU/fduuieAt8hySUEAwoLQYZWIySt7WMEyL7z10AEuTOX1JiGVrVtO6ZCljk9OMz6e4+rqv4CgtUJncRSU+z65D4xyayvLOQJSQz0G3X2eZu8KWXg8KBkZt3LMMc7ESpWSp/tUFtSnEvx4tcUGrSn+bi/4OB6bDgVU18TWFeHHHAh85eym2JHPLXe/zg8u30r6khwIy1/3sCS46YSkv7Z9iYGyal+65DW9DG+/sPMAnrr8Djyrx4v130LN8HW9s381VN95KJl/knp/dwpMvv0skHGQ+mmDLllpaLZCeH+edD47wt2tPpRJf4OE3j7N3Lke6ZNPu0VgS0Zkr2ViGTcEWWR+UaQy52dCh8Ze35/j0tg40VSbU3MTn/vA6a1sC/O7mS+u4aGFsmKbWJmzVyZ1P7eVvz+xC2P/Iz+0GKY7mKGMXi1AokEkXGByZZWg2R0dnE2/tGuG10XSdwt3c28Tmk7aSL5ZxaSKnn30uQTlLcXwv2cV4vd92KgKlXJbJY6OEPf+d702kDRaT5frXEHhrc7WSgWjapIoWL/zfGs49uq6yTOO/ffbe534/OSf3mvSSttAboFQGcUSBAjoFpyIWHaozxUHHcSFrcFxLEcvSEWd0vCDjiDozDhWtYMV6QSyUcrVQLr1ATZumSZqkuZ0kJ2efc/Z971nfVyf/ZK2s5Kyd/b3f+z7v+z7Pc9bhLzujmChU8nE2rs4Ry6clujKTbTx6YIi//8ClWIrG333rAJ+6bh1b3nsVlq/y1Qcfo6+zyCMHjzE0PsOvvn0nay56O0dODHPrp7+E2Wqy7/u76O1fyf6nnuG3Tx1k0wUredumC9m97zluvnkbTz71LGs3XURci1CdmeLpg8/xyfcM8J1HXpA0moFilNuu6GHjuj5K5TxnT5/l1FiVlpbih8+Msr4U5ZoNBb739CRXb+yQtc1Mlbn/d0f4+d3bKRXS4LssLBlMLNh8/7EXODo6yxYBQ08+dEdYoipnKVrbcppDhzHbLuboiVOMj5xl5cq3MHVunrlag9H5Ojdcs5l3XPl2wtkJOZtvLhno5hy+3SCSzBOJqPi2xdLIIK5lcm66QSEOsURUklFbdZNGrUV98bwCc89Jm/f2xzlnePKFvuuiLIlskmS5QiGjMdbQ2X/oNJ+69d1SpXjLV/ZxaV+R++7+JK1A41s/3iep6cdG5njmyBD/+bkPc+X1N1A1HD7z+ft47egb7Pnidi5e1YYSS+PHctQnBnGXqtjNJrVYNwvZlWiZMmbTwLYsThw/QknzePh3L9AeafHNmwdIx0M5BdBzFdRyL0OvvEJ7QefVkRY92Qjf+8Ux1LhCLhVjeV+Znx6eZnVHig9edxnJpPDeaHDP937LmTmDjd05tr5jgIjiosz/+jOhN/IGYc9FzC15dA6sx4wUJe/9ud/8hC1XrEf3TLTAQvFMAtsisEy5MxWqP8EKCMTCWYuhRzVqlkJK6ngVVCXED8Xe3UYLhGDZYmG2xXw9ZKbmc3zGZV1ZRVVgohayYkWGFcsLUsjQs2KZ1Ii/OGbjez7v27KZsQWHj9zzY1Z1Fnjo63fSCOP8+4/2UkkEPHt8nBePn+bGzau4d9cXaBFn90/2sPXylfTHmsQSCfRkjlCL4zcWMGYnmJmdx1bjRCprMSNJqbJZnBxhaPAkDV9hYmqeL+94J8bwcVTFpqeSx3YDZg2fh545y+BUjXu3LqejmGDva1VeGl7EFoPMclqSFd7/nvXMLJnMLPnMLhqMjU/T25ZB0VSm5oW2IUCZ/c7VYajHaUzNcDK5nouvv4WG8D2Yfo2ENUKwOA2hT2C28Jp1KdkXhch3XayWJccSMVVwHj0sy0GNiq4QUukYQocZhqGkqfuekP+0mDhrMVULqBo+vUWVxVbAyXmfQjnB+rUlymL8q6pyRtMMYvzm+TNc9rYBNl36Vk7PNPjErh9IJLH3u3cTxFPsf/oQ5UKCp149w+5fPi6Z0P9x7x2sXd5D1prklNtNX18v1XNjkp1x7lyVwHMpqCaKHiFV6qDYO4AeT1KvzdOszTNfneXAU89JRLepPcnX973Exu40Vw7k+dmB05xphORLBeqOS69q0deWQijUDk8Ykt4uxuo9pSztbTleOTnJxHxddr9RNUIhrtFRTNNZzNHVU0GZ//nHQ99sYgwPcnxe4ah2EZdvfivukX1csiyCbyxKZQpOQ8pvxMMLWrXrifgUIjcV3/VlGy4cKKwghmOaxHUFNxAjBh9NV2jUTIIgwvSUScOKSBcVx4XnRhz8qMoFl3ShaEl6uvMkxV6gkGep6TF4eoYrrthEobOHP82Y/NN9P8BtGuz55mcp963CaNoYhsGjTx7iRw89iud5bL3sQh749DUMvTHImJviSz96ks/vuJbrLqlgGks0vDg1y+XpPx5jahFWbdiAFgQUihkyuSxdhQS6FtBTjpPwGkyfeoNH9h7mYx+7hkh1VN7q1KpLUHMVHvn29yVk/eVZldGJaWqmLfuGSiHHmp6iBBl9XSXaKhVymRSBa5FK5+hatpzq4hLKwt47w7lXD0q+jJ/MM5JazyuDVW7MjVDSTZRQRK/Qjgk3FUXy/XXFxxdOKpqK5/o4oS5JuyLH244io91xfbRQyHJCAqG7CgPpkzM750vDDaFHe23cRUnrjIc669ZUyLV1SE+dC/pLmIFGIR2jXC6hpYs4aLx2cpyvPPAwtmXywN238ZbVGySGn11q8dPHnuD3B56Xaesfdmxj5/b3s+cXv+bVw0e44x8/Sk9bijbdRG9MEQYuSugTuhaRdAGl0IniWoRm8zy+12OE9XmCxoK8/Z7tMHP6DJFIBD+VJdQSJFIpmotLlJM+Og6tTC83/NvTDE4uSKZfIZukVMrTUSlTKubo62ynkk1gN+tyLBEoKosNB2Vm//2hOXoYv7VEtr2HM2aB7977AJ/bkkEjoNnwyZcSKLEovmPjhRE8z5fcF8GSUyIqaiIuD0Lgb8fxMFse9SVH8mcE+0BEhPDPcZwAxxZs5QhzjVAqLRfzKRpqlEvX9yMU0q+fGOVtG9eQimt09nTzlv4VjE1MYLVaHDk1wX89+gRNo85dH7uBzuVrOTMyypmJGWr1BocOv07NaLLjr69jYWaaJw4d5dorNvON++6hrRjHGz5Ea3GGuFDUNWcJrCZqvh1FiaCoGmEQyImlOJhQRBohVr1OPF/ArU7IcYXvOkQSWRYNi8mxKZavX0ch6RM26+wdVvnWYy9LSZJYV1YNS6p4xFcxk2J5ex6rvkQ6naV7WTctX0F59Yk9YUF3aE6+SS4a8Oz+Y+QnX6GvW5dRKqacwXnxIZFYjFAR7iVRXMeXEeF5gWRMm0JvFVdpNj1sO2C+6mI6gbyuTqAQEbXDD0knI2RSEY6MepQuu5D/PjBIT3uRrkobWq7IzNQUc3M13n35JtZefKmcO50ancSaGScRjTA8epaL+yrSxatr+cD5G9hYZPTMCAEBLdPlheMjHB9f5NxinZ3bruf6q97F5VddjX3qADWlQH7xGJpTwxNCLtuQEFEQb0PfRU0VBclOgg1x87zApzp2hnL/KtlU+laLaCItCVnG+CmODjWxIxprBvppW76CRw6eQCn10LI8HvrZXtZs2MjOHbewdmAFUS3gndfcxES1RndnJw/ffw/K7l23hwMbL8NoGLz8h99zwcJR2tIWOeHoEfhENB2j4ZEuprAsD9uPSDKsMHSyTY/FRVdWc0HLMKzzUS5mPTFNoe4ELJlCqioO6vwhtndmUDN5jHgKP6bKLlM4comoER1yf2eero4K8UQCLRZDUVXq9RaBK17SecmpsCZIpLOEgqIiKL2+L3euiURUDspef/1NpucXOfzmMA3L56orNnPDtm1Ux09RdzTWLS/hDr+IeW4Yz6gTy+VQ42kCNXbeDicI0JNJ9GhCWo0dOWvyvg9+hCf+sJ+hc/N85OabeObFQ3zzwd1yPHHX7Tu49cMfkDfpyd8/zvY7drH9hvfyoWs3c/OndqHHYty18yZ2bruKk4OnuOb2L9O0XUq5DMoPv3BbmGjvZ+TUKNlXf8WmHoVYIY4nHHEiEfEsEnoZDZeZeZsT4zZzhkdWV+TNEIoZMaiyRF5HkU5QqqbQFJ2iEkFNxFizqot0JiP8y1jT3ykF0LrYgOmaXJSLzyjk0tJdUZh/+aGQowo6uE4ipsu6IxSIQrOWEI57oSIE7rLuiJ9pUV0KQ9rKJeLJFMLQwKib+IHHzPQMjx88TKqjn462HMdPjvDB911JMPUm584MM1u3CTJdLHo6a1cuJ14os//gs6iKwm23fxzLqLF1+w7u/9q/EI34fOKzu9j74L/KW791510S5X30xqv53M5taNEYh19/g+3//A35/A9+4TZOD/6Jr+55hvV9nTz0xb9heGKWW+79XywBQUX4rO7sCFOtBltXamxcKTRPKqoeYfJcg8kph6OLHmOGRyyi0JtViasRjtZcJgyXK4txXOGjJg4hhLO2j5KIcvOVq+np7mJ2waCns4yiqLTL7wqBH0ghnVBPisKeymRkh63oUZpGi2p1iWJF9ALCmSRHJp2mOl8jFo8ijlhspHRdIRYTN9NkfmGJZFTM5jXKYuUnFImRqISDqVyW2kKNE+SFMwAABHpJREFUxZrBhQP91FsuTx54lpEpg98d/CPD0zPnYTXCGUdj88XrZFQeO3mGLe+6nLphcNPWa/nAzs9wx99+iJnZWXbve5I7b91K6Dq8/KcRnn99kIHuEp/e9k6JCP944iwP7z8s/9cbN6/Eajk8fmyM9b0lPvlXm/naIy8wOrck60JSaJ43RGPhlq4ob70kx5gb4+WhOlsuv5BA02na8KtDJ1AjKmv6Opk8N8MbZ2eludLkoilRqPBuS8c02vMJ+jvyVNraWNFTYll3hXw+T3tXp9yXCsZCJpuTq0cR4b5lS7uWrKB8hyGu6xJRREpSsG0HNB3Ldv9ch6Jowk0wVGSqEd2qa1nSIkbVomjRKIagR2YSckI5PbdEPpcjms3JFytgtNM00aMRDr10hPv+59dM1xryVv3/VzKqs2HVMlb1daPpOq1WSxpElfIZXnpziGIqxtD4LL2VPNcKduDKfhbm5kln0xIdKpEI89UqyZQYO3hC4i2NT8TGTOYG38NxbKKJjCzuAoKmElGU7e2psDuvYrWXSBfLRKMqxbY2me87OypU56pU2tsoFfNEoklsu8Ufnj/G2OgYvu1QzsXo6a5QyGVZ1tuFGomQy2YwbUdCNYEu8tkUzZYpybvJZArPsbBtV1IzRNcm6IgCv4v9pLQUi8YkehAdcRBGcBxH3iLRaYtakExn8V0b13ZkDpb2SYFPIGCiqCdRjWg0yuzsNJWOLnmQuWKJiZER+fN0NsP4dJXB4XFefvM01/3FejZesJJUMoUai0vli21aJFMpuQMQqE9XQ/lsoqmMZdIyrzcbTfk/iemq64dYrSaFfI4wIqRKtjxI0ZQZjaa0axPeRq4byINxHZd8IYty/epyuHFtL4Gi0dneTt1okkjH6eoo45ieXErk8lkuWN1P3TBlfrUaTbnKC3A5OThCVFcpl4vSyna+bmH7IaFRo9Deft51MS4KZIxCsSitbywR4HhSLNEyWmQLOWKxOGarJaNEiABFWhJpRijSE7k0drMl042YJgqtgd00pJWC6wUkhc5AmOeZpjx0yzkvDhQobmJmUUZpTFPxfZ/evm4swyRTEGYdFpHA5ezwKJlinngyI9Pi5MQYejyLHk9QzCWlz5u4oVoyjmM6KJpGOpXEdWxpP6PHhRtiktr8vKxNvuMSyyTJxpPS9qdeN8hkUtRrS+ISS1HK0NAovu+g7L77o6FRb1JpL8mXX+lsp9V0SKWS0sAvFtNk6y9Yc+dtiMFXk6RiqkwnM9PTRGMqDaOFFouSiEbl7MdsNqUJn2VanJtbor1SwGhYmJZJd2e7zLuqrpNKpmV/IeCtKMG6phPRVJm7U3/++1JbGT/w5SZJpDLH80jEoxJ9aZpKPBHDalqS/KRqGka9IRuohPhsgSLC8Lzng67geD7pdBrTsmT2ET1FMhaXLzFQ45hLNfkcgmUtJFjidwXqE2lMzKQM22NpboZsOkkyLZbyKpbtkc1n8GyTRt0gkcrQatSlA6+YsDYbdfl5aHEp6c2kYrSWavL2/B+19USlgWbKjgAAAABJRU5ErkJggg==')"
    },
    "title": {
        "value": "#ff595e"
    },
    "titleTextColor": {
        "value": "#121708"
    },
    "explanationTextColor": {
        "value": "#808080"
    },
    "contactTextColor": {
        "value": "#7f04ff"
    },
    "contactMail": {
        "value": "false"
    },
    "contactPhone": {
        "value": "false"
    },
    "contactTicket": {
        "value": "false"
    }
}

Update the custom error page

Updates the custom error page details.

PUT /etp-config/v1/configs/{configId}/custom-error-page

Sample: /etp-config/v1/configs/342/custom-error-page

Content-Type: application/json

Download schema: custom-error-page-update.json

Request body:

{
    "backgroundTop": {
        "value": "#D7D7D7"
    },
    "logo": {
        "value": "url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGAAAAA8CAYAAACZ1L+0AAAgAElEQVR4Xkycd5RkVfXvPzffyrlz7umenBNDziAgiooBAUVFQB8KqGD8gQHMgZ9ZogRBlCQ552GYnHumcw5VXTlX3fBWleut9e7qtfqvut3n7HP23t+wSzivQ7ObAzKiIrBxWzdTMxla29zIksLE8QVESaS9tZmmzi7SsSl01csTT+9gImFSqsJQooANCILA5rDCsaSBZYNh2xQtGxOQRIG1rTpBVaBaMtk9X6Vq2awMyJy/PsjLA0n8TRLLwxGW9rdi5bM0d3Tw75ffp+AoMTFlMrFgoAVFTBNi0yayBJYJtg3tbonek1SO7ysT9oh4e2X8HmgICLT5XexMl1nIVNmytIWDR+dw+CCkCTgkCRuZ0ekC03MmkiLQ0i5RrkKbW2E8apCdq7I8KBHqVBmdLJOXgBmbatkm4hFxWCJlw2K+YmIXwahCR0QkpGkMTJdwKQK9YQebN/QyOD3F/HyB2UyVhaqFXQBhY0ixz90YYmAmi9Oj8d6BNJ/6UBOKCIcPJuq/16xpoaE1gmoKKJLKgy8fY8d4io7mZsrZPDMLMURBwC+LJA2LSm1XAAOB2k/tWeWVKRs2qgRHs7WwwIaAzAUnhnj5eAZNa0S38mxa6Wb46DxnnbeRD2bG2b5njlzUJuOwqZoCxbj13xf+f8/S5QqpnEA6VkFzCfhaJRpaRLobRLodEgfKFpJbxKuKxNMmLh0imogbHUEWGBvJMjFvkXdDc0DEsCA+a1Is2ISDItF5k83LVRZEG68uoM1IzObKLHGoOESV7EKZwWSZjGUTz1ps6NNJxA2yWYuegMxpaxrJlaoMLGShZFEL+1zBYGbRQlgVkO0z1oZ4Ye8iRQNEC9b1Oomny4xGq3QHZTSHwsr+AC0BL7Pzee7/YJ6+tia+ff3V9K7dzLdu/DY79+6ntjW1rbUQ6reitvlLm/yURY1MdJGyaeKRROZrKwSanSKbVnlpbNnAkbEo89EFlkXyjC2UWbvGyzv7M2TyFq3NIqmSzfy0hSDY2P8vqoCmCazZqDE1XsUybTIZm9YVMsvWyCxmLTo0ESUoMB2zWJwxaWlXWBvxMZnLUiyYhIIKkbzGu5NZUpJFT6eMmLOZOlwhWYI1y1RGMgbtAZF0FQKGQCigkluo0CQruGSJiZkSpmmTsK16ZpBdAu0+BVdFZOPydgq5ApPRJMWKSdghIYs2sarBkXEDYUuDYi/v9PGvvXEqpo0sgE8VcckCc3kTvypSMaEzKHHGujCposYLQ1muuuRcPnTxx0hlC0yPDfPo3++hXC7i84VZtqSDLUu7SFfAodrsmC6yJqyQzecYn4wyMDnN8ckFvD6Rm67/Jpdd9SUWJ47ztRu/g2UuEMtFic8YzGdNOhokdLdAYsKiULUxRMiU7fopqoWxrUWlu0VB8usMjmUINgsEOySCAZlk3sSVsYl4JY7nTRILJh/Z3Eq2UGI0lSGLhVmxWSNqbJ8vYgnQ0C8hztlMTRgE3BLtEY2D8RL+oAi1vx+3CCCimwLtjbV8BOl07VSDu5bSFIFo3qBiQMSh09/VxHsHxsnlTCJ+maYGjUq1ymLRIJG3EJZ5Fdvnltg9V64vSBdtFFmgWLbrKaR2lhXAKQmcs8JDb2szOxeVerDWdTWyrdfPCe025VySt48m2HjCVkqCk2R8EaNi8a/3x7jm5BYaI17GYnmyZYvndwzyvQvbKQpOXhspM5CW0SSJ4alZurtb2fHSU8wlTdwNIp1NEkNHjPoJk2WRTMnEMGwUUURXoHOlilqycHa5GZ3KsPRsjSa/Rqji4fholKWWg9lCmSG3jdOwOakjzK5MhsRsGaqgKNCBwKGcRbBVrKcca9GqpwfVLyIIkIqatcyBXa69A4IukXZdpWAbNCgSJdHCKoJu1V+JWhTIe20cVZlo3MAMWAQMkZBbQ9ElYoUCsgj5go1w0+kN9h/ejtbThlkLow2iCFbtTf/fIwqwsUGhu7ebX193DkdHorT5NdwujX0f7GLfRI4lq1cSbgyjiTb5TI5dRyfYfXyOq09fguT1UbFsFrNVdh0cpE0scmaHQvualURNN0PzRQ6OLbJmSYQ7H3oeo3YauySESZtk0cIwQZWEeh3RRPC4BXSXgKaLtDa5yYQNMt4KTid0tgRozTcxuTBBYbxYL9z6aRGEeG3Tq6Q0jUqyTDpVZT5dokkXGM9adHWrONwKR4fzxKZMWpsk9ICAaQtYll2vCS1BkWZdRDMF9LyMYZqURQt3WqMiVRFtAbkAsYJBJKBhllXSch7TYRIUZJy6SrVqkrIqhE0nwtG/f9r+4u2vsGMojuwVMWuF0ilQjtv1YPy/R5RsNnXprFu/hZ9cthVJlOuRyowe4d3RPO1tzSQsjVffPcJMIkvGEBiLJijlC0QCXrYsacYolVnV38KZ6zvZc3CY+MAkpmZx5QXrKFsiTreTWAWu/snDNLcJKBXw5wVUh4jbIeFUJGzbAtXG61bqp7NsgOx3kvBkSclVnLqC1+NFKal4TIvJaILoosG287YSm56mUi4jRhTyc1UyRoXFTJpWn5vhVBZPSCVXNjl8qERteV4VXD6Rig1NIQnVBS5DQJdsREQ8RRXNFvAaGnYWpoppWpxeGtwuovN5dLeTbNGgkC9Sskq0d3sp5ksYFYGcWCCs+hAyR/9mxydmOeGKn1FwVKnkbTo2Kkzvr1JK29R6SsUlUFt3/3KZ6KjMB/f/gKA/TGJikFt/9xifO38lrxyOMXB8kh9+9UJC4UZ+/+DLlHI5RheyxAUXF65v41On9HDPc3u488Uj/OILZ+GTKoS7ezlxfX+tj8WIjzJnBvnTQ/dTiWdwSgqaYaB6ZDy6hq5qeHQoyCYWBtVChZxtUtAMcp0CtmDjcbpxigqFjEGHM0h8IcqCp0xTqInFbJbEdBZTraVaB4upAtNTVc5aH8aHwGvzSdwRgX07KjgDQj3VaJZNpFNGMCHsVRBtq56iC4aNLyZilA1aXA2EVBfzmVk000ObP4hgiMQLeQx0ivkcFkWKlkE1Wcbl17HdVTILJkJ26O82ls41P/omeX+CyXEDX4tEet5kep9Rz7frT9JwN8kEm0R2vFhieXc337/oQxiHD3DlHz/grpsvorGzGwJt/On+J1lcTLCxK8xcKs9CqkSjS6Ej4qSxMcRpJ64lGo0zfPQIPW6T+549ylc+tRGrYz2DRwewfAFe/89/yCYMUCQcokVri4I/qGDVWjhdpGRatLY2k4zNkzeqzEsF5GaRkt9GLSkoloNyyaLXtYTBiSHm7Qxlh0CDU0dcEJiq3cp+lcVohXjGwq8L5OZgWZcLU7f4YCRPoF0i5BYQina9O2z2C+QsqJRsnN5aZRTwFmysgo0aE3HqGo0eJ0E5iCYoVEolomYclxpCLFuUczmqFQuXriDUGhtHiWylgPDKM5fYy9rW8dr7j7K7OMvO3RUCNSDhE5FTUJFtIi0KzS0BdE3nnTencIYkvtHxEd55+gN2lbz84qZPI4U6+c29z1IuZSE+xWfPWs2e4zMMTKbZtCTIB4MzvD8Sw+1y8+vbrqfLK0Amys///DidDovTP34huw4eIpueJzk8RUlQESwRwSrT0uYCxcQnq4TCYRQBNHeAaHwKUZFIVgxi7iQxPU+lYOMUnZSKJuuDmxmYOUyMFCnZpkNy0JB3M1KKI/cplKsGqZxJKmmRjlmU8jbLu1UqDgstLFFIW8wPGwiqQNArYGoCfr9Qb3X9ARFnmXqjISzaiBK0iE663T4iio+5RJJhaZGI7qZJilBIG5jFIl6vRiKbId9UQpJA+NKdPluq2AQ0ATHsYGQkj88v0h7xIQsBspOTlCWLUFeIsOlnLLNIJlnk1NzJNHj9/ODJAf7+oy9TMTV2TRZwVFMceutF8uUKo1OL9DV5WL+ii+HJKJ/44lUs2XoRhfkBZLtManA3z7z8Aef0iLhau9i7MElmfhTFrOX62mnLYksWZdnAXanldJlIcwuWajM0M0zBZeFUHVQqVaJCgXlHnnzRpFVxISDhljwYSpWpTIz5rEWrotHqcFOWKhTlKjNmpQ6ckkkLM2vjcwv4nSLOIKQtgfFjBmbBxuUVKNSaEg2WrFYoTpo4HSJyBUzRIpWxGd5eweEX+dDyMGrJQHXZFJ0mDlEkXPHilrwIRhWXplF0VJhf7iBTTSFc/XufXanYyIrI0tY2LNOgmE9RqVbQnQrpfLle7Fy6QFhuJexqI5Lcisss4BZsfvDAG3z1Mx/i32/s5zOf/BiPP/AAl335yxx65JdYuTyqIvPGeIUvXXcV6aLJfAGee/VNPnH6OiqJWX779Afcfc2pvLRjgI9efAqGNc/Y2ABFqYRQKBN0+LF1FacSwF2pURsVJsxZ0kqeoiWSyxZxWTJZqVivBYHagvVWVN3JVHmWxXSOvGDV19KS1+v/z4KcRihp5BST2WyZYq5W1EVU4b80R16GimFTyUOjW6Bo2+Qt6hSFQ4HVAZFgk0ZVd5Kfz6C6ROJTFYQ0rF3Zj6WUELwxRIcHIW8hpw20pIxYNSkXyzj9PsYbDZKODMLlP/LYwUaVhkAQTXIxNDtO2C8hShrVjIBZLlOWqvjRWBVZx9bOT3PLd/7M1R/dxvuHRvB73Kxau4Y9g9OEGlrRq3nm5ufRx94hOZdG0DWcfgeODRfREAjh6V7Go3f/iR/eeCVf+MZP2dYbYk1PA21tYQ5MFvj4uZsZHtvOaGYMo5wmqHsRxQCi4oBSDkutMCnMs961hJ0Lg8TFDE6vTLFQQUXGazlpa+gjLAdZKEwxkBplJFUgEtTotGpAMk3Ra7OYLmEItZ5boJC3UHQboQSiLZISTOKLFo0hiZAskS0KDMXL9VtZWLBoaRdZ0+vDr+vMVxLIzlrwRJrlNsq6i/zwFEVHDrlRRC5BtWyhFcCXVclLBhWXygwFsoaF8PMHO+ykWMa0RSRqxaJMqMlFMl3GzHsRpBReUWCF0M8ZG65iPObhpSceZTZv4ysuMju7QGDpFkbmFjnnlPWsCwm8/NB9NIV0ArkCVUFmQRQZKzj51NduZHBoBMnpp8sn8uXv3ckvL9/Ar148zjM3n8n3HzvMd67/HC4zxfH8fhZyg/iVAFRlcnKJpBJFJ0DOk6NZCDOeO4Ipqig13FEq41B1upxL8NsNVAtFFq1hLM3LQjJB2UqTzdhEUxUqtkCwwUehWKQvGEaYczKenULpNihmbQTTQnAKNRYRv+Go0zKDiRK2JFCJmrgdIuFWla1NDSS0BHHTwGNJBEMdLKSnSc6VaAzqWD6rzqXpCQlDtjGqZQq6SBmRgmHUsYbws4d77dlSAqdHxLYF7KpJwOEkNpXDUgQEWyToCnCqdx3rN9zI40+8TEdHG3+9+yFuPL+HQzsP4Np0ES+9+G/8YonVJ5zB/OtvstSVp5yzcOswmLVJWAorLzibR556C0mBVWu2ok/v56ytXXzh7j28+8+fc9nN/8ttN3yB/o4QxfxRDi68jqq5sNQS8WqUlJZBMkVklxvLqmLZFVRJw4n8XwLQNOp0gaJ6sUsqyeQUaVlEFAUEy2JouEzZkHDbIvFsCS1qs6zXj7Pdi1WRWfTMUq7a2KZFqR4ICIZ1rJKG6NWIZpNU8hZWycARkIjoTgpGHqdfRFNrTKiEUTQRDIuI7kBUgxi6RK48jy3bWLaFaGv1Lk6STGTTRLj3mZPsmdIshUoGQxaRBZNSyUaXJSRJwUMIHY1Pr7geTe9l974BVp90Js/e/RuCLoWXnniCQLAZx/ItTAzuYnI6x41bIijxIXIpE0WGiZRJ2xnn89sXdnHuGhnLtwpd9vDmi89yxUUncHwuwUVfvJmf/Pr3XHXRqWw9cTN2+hB75p9Gs1QK7jwLhUkQbGRJRHD6yZQzFK1cfc8DmhelWqRaqTBTsFE0UAQJp60QXSzWT3WDw890Ks1c0sCf/y+SrpQsSglo36Sx6DDRFIH5mInuEWhUHAgYSKKCZPvIaHl0RaJqGjhdAqlMHsm063ggEpFJJWv0vI1bEXDULo9h09zQjZXLkgnl65SOYVUJepooGllkE6LZHMKvnl5l59JRTF1A10MUqkmKteLn9uBQeshXFmkR/Hx85TcQXb08/uQLnHjq6aQmjmJWi1z5le/wrfVukobKlbf+jBuv/x4XBLJsWhfGLhvk82VS6TL37MyRbm7n3nv/xLe/fgv9xjTvp0WuuPTDhFpb6dtyFo888i/OP20zrZ0dKIUhto89xGJ1hKxdwIGGO1NAMQMUfA5yzhRzpTTlAqxQ4OiiBTJkkla9i3PW1uMWaZS8VGct8lhk5RxCQsfMO7DsDAv5Gn2t0NTlZyGXYDJR21wRy7bZ3NpLRHZTIUvSKZNllga5i+m5IVzNSj0wai7PgmyhOQRSs1b9c10NCoZoUS6DLUlotoiiyKSzeZweAY8jQkXIo5lOkrkkwu+fXGKTNcg7pBpWI10qUSpb9V467G0ik1/khOYzOGv5tZQNnT/9/i8cHZ9iYnKKDcv7SS1G6a1McEKHG0nzEp1dZEmDRseaZdiVCoZRYeroIHsH86R8TZx71kaO7dxF1azwz1Gbr1z3ecbmkrT0r+K+e+7lc5+4iM0b1hLx5Hlr6j4OLL5bJ+r8qodwxSCeKZNx2VQdBkYtZdrQKzSSThdgsYQbgahdJiGYdNbAlBaCfI3Pkah6SlQyNtWShLPkwNZ0PJ4m0voiI7FhkmkDq6ZrOCVaw2EarSUg5ag4ZGLyOLoYpCrZZHJTzI8UCQdEbJeMUxCwDYtsxcYry1Q8EtVyCdWEgNdDvlREEDRksYAoCURzFmZZwLAshF8/3GK7hAaychXJsolWo8SzBh2uIJYtoKFywdpr6O34KIYlMzcxxI9/9FNamyOce/o2cvkS87tepEstEJaqWPk0vpZmfA0tSKpeV8eS00MsjE5RUT24gyEGxhfYnxI588MX89ahCd587wOy+QLJXIHPXnQ23/3+t7GzYxzNfsDzg/fi0QRCTgmfqSDbXtJqgZiZI5qo4QCBpc4GnNEQpcUYbodOVigQFeJ1FUu3PaiCgGaFERUVVW1kJDeNs4aOxSIerYOiVWHRmMLraMZVS5u6Qk4ogOSiJGRRVSex1DwOJQhugVwxQbVs0OxspEKcYixDOB+i3GRg5/LMO0zyeRtZhYhXpZytYsoyLsGoq3iFGu1s2AiKhPCLe1faDnegHlVLVKjIGRAdBIouvJqfqlrlws134PesoLg4yfR0lP2HD+Lzh9i2aTVP//sx+iMaMwd2cXq3g4nBMTpWrcAdaawrMrYgkRgbZfbYESIdjYznVPbN5lE7V9HQ3MGZZ59Jpljlf376OwJymdt//jOc/giF6ABH5t7j3ZEHMNUiVUwCThG3rZIwKsgeF4VsjlqzEpT9eMwIyaF5dMFJ3lMiP5dEE2V03USKOPB4PQTzjdihFmbtBVwOAcnOYltlxKqTklKudzkeuYdKJc1MfhRBd5JL1/BGjnxaoMPlY8pMkihXiTgEPJoLW6igeERUvOQrWfL5Em4ZcrZQ3+SagtftF5kp2oSaRRyaE1HUEHMGhUwV4bo7Gm2Px41uGDQGu5iShzEqJt3lCAk5QWPLei5Zdzuy5KFayGNaNgsLUZ555gX8TpXB48fIZTJ8bbWBR1NJ50q09PWjeQPYlolplFkYOk5ibp6GsItkqshBfQnTRpDTN/axfzSKoqo89/yrfP+Wr7F66ykouptiZpa9A8/x1PZf0NOg4nS6cZkW2bzBrJUn0tdHdHqKklFAl8GPk2YjTIvdRkaJEpF0FDVCsRrDVgXMSgUkJ5YiMpwbQtJkXLq/Tp55NYGstMhsNo1d8dEoe0BOUHBJFKJ5qloVS42gGTppw2B4YYQOrwKSVde4PbWWsyRSqpSpaStyFbJ2tV6IXSUZpWBTYxFTullvRb3+YL2rqmTzCBd9y233Nek06kEaHG28W9hLedFiW0MvO0ujrGo+mU9u/CaKpdT1xqpRu14l/v3UCyzEk/QEFbo8sFSO4XE5yKXSNPT01pls06giYpFbXGRwcJL2iINkIs0TUxKjGYGvX3sFz7+1mx37Bjhr8wo+/qlLaWzvRVI1ZFnm6LEnGZj/B2KpgqsgEhWzeDSF44kopiHQ1hpgJpOiUKjSEWnDWxN154qEGjXCto8os0i6jaZ4KclFFHcY3TRYYI6sVaKCiYcgQYeb+cIMedsgWPLhtHyUnAnEuBNDUnG5K8RyVXSPh8MzE8zMFehp0slmazVHRvBY9dRkTUGLQ0P1eTBFA6lqE9BdpItl4maFAhUiegDFa5I30+haGOGrvwna/f4mJBR8Qphd1SN0F4JozkZei+9ha89JbGv/MP1NWymkMlSrFeYW4vVoP/jw4zQ2txMSMnyoT8UjG+yLGqxYtx5XJcrCzAxVFFp0i3i2jK6qDExEMRv6qUoqj799iB07dvE/N3yR7p5umtu78QdDZNIJ3B43peIsg0P3cdAYoFPtRBTzOMRmEtkJ9EUFvUXFROTQ+Aw+ICxFcFYrrGruI1kUeHd8hkafh1NWNFKQFbYfm62njUhklJhSqKtcJUXD4aiQMstUKlm6XGvRbRdzxkEqaQPJ5UAXK3Xp0uWo4QU3hbEspbzATGKaBp8bV4OHqqOEjlTnryJikJFcjLjloK29hebxEm4xwgH3KKbTS6vWQjhfxnYZCF/9VcCu9cjuQDMeU2XfwiBnezdxTI4xlJ6knFG5ZP0nWBLYQtjfRCqVRXW5SSTSDA8NMzI0yLr+NoTkJJVElEVvH9WDuzi7u4FyTX1Kp3h8JsflV13G+DtPs1CzYkR6mY4XODw0Rtjn5tJLLmTllm11pSgZmyMU8BGdGkMwDaafe4jGlgAVWWM+Y3PGlh6efOcY6VyFr1yyoQ6+3n7vKC1NAR59d5RrL1jFB4MLVDU3l5zaz/j0IocHJjlr20pe3TnI2wMxAn4n1354LX6XSDGTxhSrFDSFV3YeYfdskZAucv4WBdFnslhOkzcyKIqEoqiUHR6kvE78cIxsKkNwlYTocFEolZieTVEWYW1/C2VZpFw1ySXLVI5lmcsbBNcJpMZMeh0+ej0Rkk4D4Zd3L7MVb5B0Yp4GPcKe2AAXtVzC9tK7HBlewIOPK0/9Kt5KBH+4hWSmQCZbINLQUNdoo4spRg/swimb9AQFWrZezD8ee5Il7z2Fs1zmj2aIO37+Y0qTRyhnoyiNvew8OEZLZzd+rxd/OFT3FOXy/wUrUyMjLG0LUKzaDOzbizw/zsL4KOdtaqGk+dE8PiJBJ1+9632+ct5yTtu2jHKpws6D47g9LvYMzPCZc1bwvXu388kzV7JtXSfFTJaXXzvAhz+0iUdeOsBThxfpDupcffFGOtrD2Kk4mtdHdCHBUy/v40vXfBjNF6B47Ah4vbz89nH2TiU5cWMDa9aGyBWjTAzOc2zOYFmbiqNRZLY6TbRUwLRKBHweKlqOatKgUPTjtn3k5AWkiI3HlKiYVt0A4MCL8JuHemxJ8aFXBXyEOBY9QId/I0erx8jnSkSkFgJmGwFxHauX9VC1RAzVxQe7j3Jg/0EuPP809u8b4PRtK5kdOkzJklm57TSeefhB5sbHuO5732b4+CRvvfYShUyGL37+Ug5OZlm3aQPRhRjpZIplfZ1U8mkUh4v0+DHKU8M4G1s4NDBJcHpfjV0gli9w1roGZgpOzjihj73H5/jRs4M89p0P1Tuc+bkY9781zmdP7EDx+8nEU3z9od385gsns7K/hdT0NHpNqtRk7vjzizi8Hs7p9/Gd/4zw9++cS7gpwr1/eIxtZ5zAyg3L69qxlU7y1PO7eWTnNPfd8dl6WrSrZSb3HEZ26DS1RCgWq4zPJnlu5xQrlzhwrptmQZ3BUBUU24FUqvFpfmwljaz58RerxErTJCjT4O9DuOehdXaumiZdyOEuqei6j1QNuSlpFBz4y04KGR3zWANnX3AO/mAD8VyFocHjRONJpqM5gh6NwSOHWbl6OQ0BL5qqECsaxGJx+tsaKWYz6A6daCLDWDTPquV9NDY34/F6oVxiSX8Pk6OjdReZUCqQ2vc+wwfeR1B1tvS6eWH7NOlKlZsvauLwgkBHa4hwU5jfvTRBJODhcxesAUHk9d3DPLFzhls/s4lQ2Me9j7/P2+M5br3iRHrbA1AsYVkWlsPJnQ++zdJmN1ZikYsvOxMzm+WW25/gS1+6iJXrlmFMjzF4bIIfPn2UX15zDu09LXWfU+02PfzEdg5PZep0fG9nmOXLOlje00QsnuTlHYO09Cr4u/KMlBZxNGnoWhCpkMEuWXjlEAvKKGmxJubUUtBfOu1qLI9QAwllCYceZlqOo4R1Ot29WBUVK6+SOt5B0C2wckk7i+NDZLQQE9EcE2NDdLa1kTckXnnzPU5Z24OlOjk2NIqq68iiSH9bhLd3H0F2eDn3vHNwiDYOVWPF8qWoqoKmO0hHZxBzCYToGNLUQQaz4Cyn2NCts/94mh1DKW4618tgQmbVylZEzc1Ussw9O2L87OrTycYXyVYlfvDA+5y1eQmXf3Rr3VRwx12vcWg+z02XbmXT6jaEUhnR5WZsYIg/P7mH+alp/v6H68nOTHHBTY/y0l+vQ7HK2Lkktz3wAY0NQb72uXMxEvPMZSr8+IH3sAWRK07r56Qty5E9PkqZFOmFGOPzGTas6617lg4PTDGnpCj15evcz2w0hluysQWVI/E4Td0qhayF8I2f+G0lpiNX8tiyzGy5jOARWd7fQVukgcH0EH2uLex+qorb72Vl2EJSXew5PMbYbILmtgYmF4uItZZTkrji85dxcP9hvL4gnb2dvPLCK7REPBiCzKNPv057WysfOec0xEKyLtj4V2wgOzGOR9MJuQSk2UE8doK39h+v35SAEaNUzHNwJMeZK1SOzFRZu76TTN6mtTXAo7sSXH7eKkRZ5qW3j3D6iSv54v++wR9vOI9gU6xmPsAAACAASURBVBgjleTW+95hf8zgqxes5aLTV2AVCliSyOe/fS/VbJZH7/8uQ4cHufvBl/j57V+hNDVGPLrAHU8d4zdfOx9ZtMjOz3DtXXuIFkr842tnE4n466ai+eND9drj6egGRcUsFZkcHOPNg7N0uuBAVsPZapLrHsYVVBlZTJFM2kSCYn0Nwtd+GLCV6SphWadYgahdoqWnCVdEJy3WVP0il/k+zuvbFzkyneDcDd0cPXQMkSqT8QLelmaq+Tx+nxe37qB37RYaarKhUaFczNZBncsX5MiBA7z3zJN0hTyE/F7mcjZFU2Npox+nUaCxqxM5s4Dk8BEsDjFRVPCaUWSnF93MMTebpK3BSbZQweH1UVIchFwSB+YNVvU00trVwu7j81iIjMxlSBRNvn7VOdilEuP79vOrl8YYSJt8+9Mnce7mHjAtfvHHfzKeKPHH//kszzz3LutW9tDRv4RMbJHb/vwi1156En1djRjFAj+86yUWMwV+eNlmQgEP8fkoNbNSoLO7bmg7ODDFy3snUYslQh6VRp+GO+ChrauNBq/K6EyUhyePEDo9SSJdxYpZhMNehJt/FrTNxQptqp/FhRKViFTnqRedFaQGmdP1TZwcOJGFosh3f/sIZ564hqXNLsYmFsjlC3hbO5GsKp3dnQwcOICteQiEG8lXRYrFbN2HU04lceejeCq10gNvHs8RcjjYKOfx9SxFFQzk9By+phY0hw7BVsqLoxiihlqN0eAWmZ6I4tPF/7rGdCcNHWFmEyaWbXJkusBnPnICs/EC37x/B7+5+mTuf24fN37xApxOjfTYMEOjUR7eF2U8B/fedAEiNrH4IgOTcS46fS13P/gCV3/+4jpifv71/SzrbKBvRQ+JiXH++OwBHJrGDZefAbkUyYUFRM2BKxRiamKWPYfGKJYtNvQEaetoJFaRKRXLLMzMc+DYDDPpIql8ha5mP97lIqWehTqBt1jzLt/2swZ7MlFgk6+FWNWsI0SlUiQqW+Rkk1tXfxGt6sbX2MKX/+dvFFG45ZqPM3TgAOOzMYJOgc2nnkXFNNmzd4AlXWEeevY9Xtt9DK8q89GVAfpDLrxBX92SmE2VuWyNC8WoUg6spjBxkKbW9jpno+WiOPtPJLMwg+hzEovnkM0c/a1OyokYiXSFsE/BF3LjaWzk1f0xNrU7GZrIsfXUVeAJ8e0/vIQ74OX/fHQzv/vHu9z+9Y+QypW48S+vc+W6ILe9McsZy5o5eWmAai7BOeefRimf59d3vch3v34JA0fHCHrdtDb6yRfK/OD+d1jml7n6yx+lOHoczetBDjYyeXyYJ57fy+b+IMcnkxRrZGJJ5MB8FqdocdPFK1jR18TU2ByWJLEQTXDCyWtILCzy1vgco31TCG06wm2/aLArokWX3EPSKiEulEnGE2i9TrANruz5DPlcmaauPp55ax8/vf95LrnwbD56ykr+9fRrnHPGVjIVibnpKdavW8lf//kCjz//Nudt7OFjJy3FaeV448AcFHKsa5Rp1iw0wWQqblCoqrR6JHTRAH87gco4sqbzbKyBc/o19k7kWRKWaNQKlFIpUikDt0emo8mBq7WV2/41zA1nNuFvbkbUnKDqHNlziNtenuesjV187Mx1BBQDNdjIjb98ksvP6OPoZJKHds3y8Y0Rpsdj/PDbn+WJl/dg57OsXb8CD2Uagw5e++A4bw3EuWBrLyetbsc0DUSnu94JHfzgEPuPTNcDG8sUWcyUCLgVTl3fzZrlHbS0BLEKOUYPHeHYYJS+tf2kihUefW+U1HySk5cFOPn0XvY1xRDuvK3ZnqpmsV0hgqEQsfkoEWczQVunTZPpazgJKkXCDWFmMjbf+tUD6G4/N139KUaHhog0RuqDGm1d3Tzx/Bvc9/DjXLCln2s/cSoTo+OMTy3QqpZo94rYuRTVqlHP2zMLJU5slHC7VJySiag760MXbqXEU6M661oU9sc1LlwqEY9lcUsl4kkDzSmztMOFo6GB7z89waYWnY+duQJBVjELWcZn0xwYTnDH9gXu/z/nsG7zWqxKiUee3l4fCjl3QztX/vplLj1lCYvxHNdc9RF++8CLXHZSO816hYW5KH97Y4rBeIk/ffMS2hv9WIbJ5EKa48Oz7Nk7SixfRRJNVndGaI04WN/bgL8pVPcY5XMFwg6BufEJ0qkssq7zzP4oiqazYWkDXSGVQ8emOWNNI2LAifD9m/22prtJlAvEZBOHw1GnAFrUCJ/tPZNC0Yvf46xP0Ci+dh577i0eemEHn/3Y+Zywtp9gYzOVqs2f73mIwYEBTt64lI+eu5VdOw7ilwo0qXlkq0w1myaerfDb12Msd5uc2azUZxH8XoGaLcapiXhbm1DLCfZOW4wkbZZEVDb1+xgeTuLVq5QqNdVLZUmLgu4P8atX5hiOF7nnq9tAdVAoFBk6PEJni5+bnpjAFEX+ceeNCDUxPJvh+l/9h+svXMk3/vIqP7r+YkYnF+nrbOTo0DQnNxZwKfCRO3dyYn+E33zjEgTbZmYmyU8e2slcukC6XKFBhZ9cvpm+1UtrxiUsQWRyPMojLxyoj8d87NQu5iZjDEzn6G52MDid4/KPb6n7RHd9cJw3945z09Vn4nI5uPvx7QjfvMZrp0QLvabWKzJBh0ZRgHBZ54YLb+H9vcfYsHop77/3ARtO2EK0IHLptT/glK0buf7aK2hsaOTVV99gYmqKkEfntG0bKMTnID2DLlvYlSLFYpGHXjvG1OQiZzZCAAh4JIJ+mXKpRqeB063i8WgkchXMqsieqEG3B/oaJIbnqrgcIgGXTLwssaRRxhUJ88SeGL97Y45Xb1yHHgxiyG5u+OObfPPcNv6xZ5EnjiR46TdX09LahOgK8Ps/P4pVyPL4O8f4xIe2srq/m5GRMVrUIj6K3PzYYdZ3e7nj8ydhVwxu/8deXhpM0hLQ+NI5K+lrctPssJmMlxmcSjKeKiPki7R5ZVav7qx3NQc+OEI8XaKtI0JXswfZG2LngTEGj8+wojfIiSevqXNE377nHY6OJxBuv6bRLgYlFAOyHo2gC+bzJdrlMNed+z1+8odH+D+fv5ixo8fp6O1EdAZ49PHneOzV3fz6pz/A43IxPDiIbFc49eRtFBZGsAuLWJUi2VyRXQOT/OuNo2yM2JzdIZOanEdVZVxuFanm/cREqzmiJLluet03WsBV49llnYBaM1SJJJMGoiaxpElibFGir8OJpmu8dizNDY+N8OYN62loj2Crbm5/9AArW3SWt3r59H2HuOPzZ/DxT36kPrczPz7O/977DEGHwPapPOduWUlrow9naordRyb4565pHv/6RhKpEj/61wCHomXO7Aty9RndRDNVxtMm08kS8+kcfo8Lv22wrcdJoLGBVCpNOV9lebefpiY/gsPNe7tGGBqapy3iYuu2FYRbWqiWi/zivtd4ec80azo9CL/9RpOdztg4ZY2CW6LQWEWxLU73n8SJ267ga7f8kvPPO4UTV3aSSyfxNXdRFl1cc+P3+dbXr6Ozt5/Y1DD9S3uRjSJGMUuhXOadXUf56Z//SToe5+lbP4xbtogf2o9VzFMV1Lq24A15kMq1Ib+akdAkV7F443AWTRbZ2u9HE6qk8ia6Q2Imb7Opx8lk1KC/N4CkqRwYjHPZA8P888plrNmyou5Ee/i5XewbTfH9y9bx1T9sx+Fz8dCffwi6i2oxyyN/e5D+djefv/M1zti6mp72RlYF4JcPv8XFmzroUkrc8PQoiarBzeuCrOlv4Iyz1qL5G7AUnaopYhll7FIeiilefGuQpw9E2dwToD+ssKK/leaONg4fHuWJN49xYrtG5+qVLFvVX+MeeOXdg/ztsZ3sS5Z54eZTEP76g5W2QxLwO9wUa9eLSZSigw+v/jJN3SvZvecod//7dX7xP1/HLmWwanZxfxN/f+hfrFq7FofLy+plnXVrI4LEu+/u5K5/PM3BfQf4xKlL+ew56/FJBQrzU5Sj05TSBUqCA49DoFqu1ocnPHptVMjgqYMlNjbYFESVsC7idkmMRKv0tescnqpy2movIzMVVvb5kRxOjozGuPS+Qf73wnbOO38joupgLF7hil+/yF+uO5OR0Xl+9/oIL99/K9ViCUHWiE6PYxdiXHnH02xa2UNrRxuNmsFfHn+HKze38rs3RylWTe76VB8nr2lmMCHxz/enSS1mCGgypiDhVqEtqNPd4kGomZwkBaNaS50GbrHK5hNW8+wbRxmZjuOuteIXbKCpraWOMa76yeMUi2W+ftFKTljdivCTP/fanryEYFYJ2h7S4gLrW07GIW6gb+1qLNXLL3/xZzqXLuXskzeiGAUUj59YssD07CIbtm2tO9OqtsAzTz7H9nffqRtyLzxtDS5dxUjNIxeilGMzZOfmSMTLlCRnfV7KqdYUkQJm2WA4WiWfreBSJGRdxa3VHMgq7x4psmWVj9H5EietcDMxV2J5jQtSdI7PZLjsr/u5/fxOLjhvHZInjOAKcNWPH0UVLc5aFuFnzx7l5ftuRXIH+PVv7uI7N30ROznFF3/0AP5gEFlW8Xld7Nh1kBM7vTy8a5IfntfF0haNv29fZO9oso5keyJuNnQFOf+U5cjeIFotfWpS/UA+8tQORF3jxNUddRa1u7+b6clp7n1iF20+jSuvOAfTsvjpPa+wZzjOR7a08cWPbcNMRRH+8r9LbNWhkk0mkHQJnxLm/BWfIT2XJtK1DMnhZzGZ44bv/Jwrv3AFm1Z2o6oaZVMglsjSvWxFXax46dX3aFGzOF0OIn4numxTTs5j5JMsTk9hTR0jF12sixc167mnNisVL9HiMajkSuw4lKenQWYsY7Oqy1EfQ6qJvTPRCppHI5c32dDvJZ4q09PpQ3G767MHl/zhIDef3sqlH92GGGhB1L38/pHX+NOzezm9v4PXjgzz+t9uIdy9jAuuvIULN/dxw43X8fd/PMED/3qJT37iYt7duR+zWKgreCd0e2nzqdy9fZavbApyyaldBLr7mZua49f/Ocrbw2lkSaA96MIlw4e2dHHW2jYWxqfQGtsQKgV6lvbUDQm33/k0l5+3gq6VK9h/6Djfu+ddLt/azCc/ejJWOookKwh//fsS22P7wTJQLYXTln8GpVrBiM1x7MgUfZu3IvpbiaUK3HnPv1i3eRPnnbKBcrGIKTto7u4nU/OAxidJTQ3VC6lXLNSxg1DJItkG5WyGzOgA0yNJHJFAzXKJYhv1tk+wSiQXy2TSBoIksjMhcPGKmou5Ju8qeB1wJAo13TrkstgxWOC0jc0EIgEmoyk+/seD/PjD/axa1kr3qrUowVYOHjrGxTf/jUKliltXefXuW2nrW86VX/sRR48P88xdP2Y2VeJL37yDqy77GG9s38vqpR1MDw3R7zI5Np0gXqzUb3WmbNb17ZrrrWqa9IcdrO5ppC3kp2pUmInlOHlpGJcqU1V0Ni6JEE8W6F/azq/veZGPnbaUaCLPY9tH0EWZ2649t653G4sTSOE2hN/+pc12Z3Wcip/NzeuJhJrqdgq7UCI9cZS3xmDrtk2U0CjYKq+9tZNl6zbQHtKo2VnaV5+AXM2SGdrJB++8R1dbBK9cwqFKVEt5SqkkVj7F+JERDs1VUVSdjrBOk7vmwayp/FUyqQpG2WJH1KDJo7GhXUFQZBarMr2NCm8cL3HWukA9KLc/OcVXzuukp7+DWMHk0p+/wY8+uQ5bd7FuyxaaOnrI5XN86dt38uLeYXRF5tW7fsDyDZu5+8Gn+N6v7uazZ27gc1/6HF/+5u10dLaTzWRZuWIJk8MjhBSDtw9OMZcvsq7Fw6Y2NxeuaWF5VwjN6cTp0pFDbdhGhdrclqDoPPP6fjb1hXh7zzinrWlicirOxo393P7ge0Qkk90TaZZ3h/n6Z05FtM26P8k2qswmKwi//0O7LSQsgqrOecvOR/SEoGyTPr4bSw/w3ntHeGnK5PILtnDo+AxbTzuRqimzb2ia9UvbWHPqRWilKIW5IYb3vlcnp1SzzNK+lnqOrKQTHDs0xAPbk2zrcnP6Sk993kym5q6oEl8oYNTGPz0irw6VWRJSWN/nBo+HeCxD35IQ7xzKcNraEFVB4dYnx7jloh66ViylaBhc89tXuHhjN5MFm1LJ4sc/vplqucy///MS3/jtP+szXa/c82P61mzg3ff3cOl1360DrId+913ufezlOqWsSBJt7W1MjQ0RMDI8u3uMz29o5NqPrECzq9Qm9hSHE1vW6htnV8rI4WYo5euFPRFbrJ/6p/bMsbrdR9CpsHZ5M996cA9vHpjmhZ98jOYGL6KkYpv17w+oA8ob7nwe4dU/fduuieAt8hySUEAwoLQYZWIySt7WMEyL7z10AEuTOX1JiGVrVtO6ZCljk9OMz6e4+rqv4CgtUJncRSU+z65D4xyayvLOQJSQz0G3X2eZu8KWXg8KBkZt3LMMc7ESpWSp/tUFtSnEvx4tcUGrSn+bi/4OB6bDgVU18TWFeHHHAh85eym2JHPLXe/zg8u30r6khwIy1/3sCS46YSkv7Z9iYGyal+65DW9DG+/sPMAnrr8Djyrx4v130LN8HW9s381VN95KJl/knp/dwpMvv0skHGQ+mmDLllpaLZCeH+edD47wt2tPpRJf4OE3j7N3Lke6ZNPu0VgS0Zkr2ViGTcEWWR+UaQy52dCh8Ze35/j0tg40VSbU3MTn/vA6a1sC/O7mS+u4aGFsmKbWJmzVyZ1P7eVvz+xC2P/Iz+0GKY7mKGMXi1AokEkXGByZZWg2R0dnE2/tGuG10XSdwt3c28Tmk7aSL5ZxaSKnn30uQTlLcXwv2cV4vd92KgKlXJbJY6OEPf+d702kDRaT5frXEHhrc7WSgWjapIoWL/zfGs49uq6yTOO/ffbe534/OSf3mvSSttAboFQGcUSBAjoFpyIWHaozxUHHcSFrcFxLEcvSEWd0vCDjiDozDhWtYMV6QSyUcrVQLr1ATZumSZqkuZ0kJ2efc/Z971nfVyf/ZK2s5Kyd/b3f+z7v+z7Pc9bhLzujmChU8nE2rs4Ry6clujKTbTx6YIi//8ClWIrG333rAJ+6bh1b3nsVlq/y1Qcfo6+zyCMHjzE0PsOvvn0nay56O0dODHPrp7+E2Wqy7/u76O1fyf6nnuG3Tx1k0wUredumC9m97zluvnkbTz71LGs3XURci1CdmeLpg8/xyfcM8J1HXpA0moFilNuu6GHjuj5K5TxnT5/l1FiVlpbih8+Msr4U5ZoNBb739CRXb+yQtc1Mlbn/d0f4+d3bKRXS4LssLBlMLNh8/7EXODo6yxYBQ08+dEdYoipnKVrbcppDhzHbLuboiVOMj5xl5cq3MHVunrlag9H5Ojdcs5l3XPl2wtkJOZtvLhno5hy+3SCSzBOJqPi2xdLIIK5lcm66QSEOsURUklFbdZNGrUV98bwCc89Jm/f2xzlnePKFvuuiLIlskmS5QiGjMdbQ2X/oNJ+69d1SpXjLV/ZxaV+R++7+JK1A41s/3iep6cdG5njmyBD/+bkPc+X1N1A1HD7z+ft47egb7Pnidi5e1YYSS+PHctQnBnGXqtjNJrVYNwvZlWiZMmbTwLYsThw/QknzePh3L9AeafHNmwdIx0M5BdBzFdRyL0OvvEJ7QefVkRY92Qjf+8Ux1LhCLhVjeV+Znx6eZnVHig9edxnJpPDeaHDP937LmTmDjd05tr5jgIjiosz/+jOhN/IGYc9FzC15dA6sx4wUJe/9ud/8hC1XrEf3TLTAQvFMAtsisEy5MxWqP8EKCMTCWYuhRzVqlkJK6ngVVCXED8Xe3UYLhGDZYmG2xXw9ZKbmc3zGZV1ZRVVgohayYkWGFcsLUsjQs2KZ1Ii/OGbjez7v27KZsQWHj9zzY1Z1Fnjo63fSCOP8+4/2UkkEPHt8nBePn+bGzau4d9cXaBFn90/2sPXylfTHmsQSCfRkjlCL4zcWMGYnmJmdx1bjRCprMSNJqbJZnBxhaPAkDV9hYmqeL+94J8bwcVTFpqeSx3YDZg2fh545y+BUjXu3LqejmGDva1VeGl7EFoPMclqSFd7/nvXMLJnMLPnMLhqMjU/T25ZB0VSm5oW2IUCZ/c7VYajHaUzNcDK5nouvv4WG8D2Yfo2ENUKwOA2hT2C28Jp1KdkXhch3XayWJccSMVVwHj0sy0GNiq4QUukYQocZhqGkqfuekP+0mDhrMVULqBo+vUWVxVbAyXmfQjnB+rUlymL8q6pyRtMMYvzm+TNc9rYBNl36Vk7PNPjErh9IJLH3u3cTxFPsf/oQ5UKCp149w+5fPi6Z0P9x7x2sXd5D1prklNtNX18v1XNjkp1x7lyVwHMpqCaKHiFV6qDYO4AeT1KvzdOszTNfneXAU89JRLepPcnX973Exu40Vw7k+dmB05xphORLBeqOS69q0deWQijUDk8Ykt4uxuo9pSztbTleOTnJxHxddr9RNUIhrtFRTNNZzNHVU0GZ//nHQ99sYgwPcnxe4ah2EZdvfivukX1csiyCbyxKZQpOQ8pvxMMLWrXrifgUIjcV3/VlGy4cKKwghmOaxHUFNxAjBh9NV2jUTIIgwvSUScOKSBcVx4XnRhz8qMoFl3ShaEl6uvMkxV6gkGep6TF4eoYrrthEobOHP82Y/NN9P8BtGuz55mcp963CaNoYhsGjTx7iRw89iud5bL3sQh749DUMvTHImJviSz96ks/vuJbrLqlgGks0vDg1y+XpPx5jahFWbdiAFgQUihkyuSxdhQS6FtBTjpPwGkyfeoNH9h7mYx+7hkh1VN7q1KpLUHMVHvn29yVk/eVZldGJaWqmLfuGSiHHmp6iBBl9XSXaKhVymRSBa5FK5+hatpzq4hLKwt47w7lXD0q+jJ/MM5JazyuDVW7MjVDSTZRQRK/Qjgk3FUXy/XXFxxdOKpqK5/o4oS5JuyLH244io91xfbRQyHJCAqG7CgPpkzM750vDDaFHe23cRUnrjIc669ZUyLV1SE+dC/pLmIFGIR2jXC6hpYs4aLx2cpyvPPAwtmXywN238ZbVGySGn11q8dPHnuD3B56Xaesfdmxj5/b3s+cXv+bVw0e44x8/Sk9bijbdRG9MEQYuSugTuhaRdAGl0IniWoRm8zy+12OE9XmCxoK8/Z7tMHP6DJFIBD+VJdQSJFIpmotLlJM+Og6tTC83/NvTDE4uSKZfIZukVMrTUSlTKubo62ynkk1gN+tyLBEoKosNB2Vm//2hOXoYv7VEtr2HM2aB7977AJ/bkkEjoNnwyZcSKLEovmPjhRE8z5fcF8GSUyIqaiIuD0Lgb8fxMFse9SVH8mcE+0BEhPDPcZwAxxZs5QhzjVAqLRfzKRpqlEvX9yMU0q+fGOVtG9eQimt09nTzlv4VjE1MYLVaHDk1wX89+gRNo85dH7uBzuVrOTMyypmJGWr1BocOv07NaLLjr69jYWaaJw4d5dorNvON++6hrRjHGz5Ea3GGuFDUNWcJrCZqvh1FiaCoGmEQyImlOJhQRBohVr1OPF/ArU7IcYXvOkQSWRYNi8mxKZavX0ch6RM26+wdVvnWYy9LSZJYV1YNS6p4xFcxk2J5ex6rvkQ6naV7WTctX0F59Yk9YUF3aE6+SS4a8Oz+Y+QnX6GvW5dRKqacwXnxIZFYjFAR7iVRXMeXEeF5gWRMm0JvFVdpNj1sO2C+6mI6gbyuTqAQEbXDD0knI2RSEY6MepQuu5D/PjBIT3uRrkobWq7IzNQUc3M13n35JtZefKmcO50ancSaGScRjTA8epaL+yrSxatr+cD5G9hYZPTMCAEBLdPlheMjHB9f5NxinZ3bruf6q97F5VddjX3qADWlQH7xGJpTwxNCLtuQEFEQb0PfRU0VBclOgg1x87zApzp2hnL/KtlU+laLaCItCVnG+CmODjWxIxprBvppW76CRw6eQCn10LI8HvrZXtZs2MjOHbewdmAFUS3gndfcxES1RndnJw/ffw/K7l23hwMbL8NoGLz8h99zwcJR2tIWOeHoEfhENB2j4ZEuprAsD9uPSDKsMHSyTY/FRVdWc0HLMKzzUS5mPTFNoe4ELJlCqioO6vwhtndmUDN5jHgKP6bKLlM4comoER1yf2eero4K8UQCLRZDUVXq9RaBK17SecmpsCZIpLOEgqIiKL2+L3euiURUDspef/1NpucXOfzmMA3L56orNnPDtm1Ux09RdzTWLS/hDr+IeW4Yz6gTy+VQ42kCNXbeDicI0JNJ9GhCWo0dOWvyvg9+hCf+sJ+hc/N85OabeObFQ3zzwd1yPHHX7Tu49cMfkDfpyd8/zvY7drH9hvfyoWs3c/OndqHHYty18yZ2bruKk4OnuOb2L9O0XUq5DMoPv3BbmGjvZ+TUKNlXf8WmHoVYIY4nHHEiEfEsEnoZDZeZeZsT4zZzhkdWV+TNEIoZMaiyRF5HkU5QqqbQFJ2iEkFNxFizqot0JiP8y1jT3ykF0LrYgOmaXJSLzyjk0tJdUZh/+aGQowo6uE4ipsu6IxSIQrOWEI57oSIE7rLuiJ9pUV0KQ9rKJeLJFMLQwKib+IHHzPQMjx88TKqjn462HMdPjvDB911JMPUm584MM1u3CTJdLHo6a1cuJ14os//gs6iKwm23fxzLqLF1+w7u/9q/EI34fOKzu9j74L/KW791510S5X30xqv53M5taNEYh19/g+3//A35/A9+4TZOD/6Jr+55hvV9nTz0xb9heGKWW+79XywBQUX4rO7sCFOtBltXamxcKTRPKqoeYfJcg8kph6OLHmOGRyyi0JtViasRjtZcJgyXK4txXOGjJg4hhLO2j5KIcvOVq+np7mJ2waCns4yiqLTL7wqBH0ghnVBPisKeymRkh63oUZpGi2p1iWJF9ALCmSRHJp2mOl8jFo8ijlhspHRdIRYTN9NkfmGJZFTM5jXKYuUnFImRqISDqVyW2kKNE+SFMwAABHpJREFUxZrBhQP91FsuTx54lpEpg98d/CPD0zPnYTXCGUdj88XrZFQeO3mGLe+6nLphcNPWa/nAzs9wx99+iJnZWXbve5I7b91K6Dq8/KcRnn99kIHuEp/e9k6JCP944iwP7z8s/9cbN6/Eajk8fmyM9b0lPvlXm/naIy8wOrck60JSaJ43RGPhlq4ob70kx5gb4+WhOlsuv5BA02na8KtDJ1AjKmv6Opk8N8MbZ2eludLkoilRqPBuS8c02vMJ+jvyVNraWNFTYll3hXw+T3tXp9yXCsZCJpuTq0cR4b5lS7uWrKB8hyGu6xJRREpSsG0HNB3Ldv9ch6Jowk0wVGSqEd2qa1nSIkbVomjRKIagR2YSckI5PbdEPpcjms3JFytgtNM00aMRDr10hPv+59dM1xryVv3/VzKqs2HVMlb1daPpOq1WSxpElfIZXnpziGIqxtD4LL2VPNcKduDKfhbm5kln0xIdKpEI89UqyZQYO3hC4i2NT8TGTOYG38NxbKKJjCzuAoKmElGU7e2psDuvYrWXSBfLRKMqxbY2me87OypU56pU2tsoFfNEoklsu8Ufnj/G2OgYvu1QzsXo6a5QyGVZ1tuFGomQy2YwbUdCNYEu8tkUzZYpybvJZArPsbBtV1IzRNcm6IgCv4v9pLQUi8YkehAdcRBGcBxH3iLRaYtakExn8V0b13ZkDpb2SYFPIGCiqCdRjWg0yuzsNJWOLnmQuWKJiZER+fN0NsP4dJXB4XFefvM01/3FejZesJJUMoUai0vli21aJFMpuQMQqE9XQ/lsoqmMZdIyrzcbTfk/iemq64dYrSaFfI4wIqRKtjxI0ZQZjaa0axPeRq4byINxHZd8IYty/epyuHFtL4Gi0dneTt1okkjH6eoo45ieXErk8lkuWN1P3TBlfrUaTbnKC3A5OThCVFcpl4vSyna+bmH7IaFRo9Deft51MS4KZIxCsSitbywR4HhSLNEyWmQLOWKxOGarJaNEiABFWhJpRijSE7k0drMl042YJgqtgd00pJWC6wUkhc5AmOeZpjx0yzkvDhQobmJmUUZpTFPxfZ/evm4swyRTEGYdFpHA5ezwKJlinngyI9Pi5MQYejyLHk9QzCWlz5u4oVoyjmM6KJpGOpXEdWxpP6PHhRtiktr8vKxNvuMSyyTJxpPS9qdeN8hkUtRrS+ISS1HK0NAovu+g7L77o6FRb1JpL8mXX+lsp9V0SKWS0sAvFtNk6y9Yc+dtiMFXk6RiqkwnM9PTRGMqDaOFFouSiEbl7MdsNqUJn2VanJtbor1SwGhYmJZJd2e7zLuqrpNKpmV/IeCtKMG6phPRVJm7U3/++1JbGT/w5SZJpDLH80jEoxJ9aZpKPBHDalqS/KRqGka9IRuohPhsgSLC8Lzng67geD7pdBrTsmT2ET1FMhaXLzFQ45hLNfkcgmUtJFjidwXqE2lMzKQM22NpboZsOkkyLZbyKpbtkc1n8GyTRt0gkcrQatSlA6+YsDYbdfl5aHEp6c2kYrSWavL2/B+19USlgWbKjgAAAABJRU5ErkJggg==')"
    },
    "title": {
        "value": "#ff595e"
    },
    "titleTextColor": {
        "value": "#121708"
    },
    "explanationTextColor": {
        "value": "#808080"
    },
    "contactTextColor": {
        "value": "#7f04ff"
    },
    "contactMail": {
        "value": "false"
    },
    "contactPhone": {
        "value": "false"
    },
    "contactTicket": {
        "value": "false"
    }
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a delegated access user

Provides details for a delegated access user.

GET /etp-config/v1/configs/{configId}/delegated-access

Sample: /etp-config/v1/configs/342/delegated-access

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: delegated-access.json

Response body:

{
    "etpConfigId": 1100,
    "username": "john.doe@etp.com",
    "fullName": "john.doe@etp.com",
    "siteIds": [
        1009353,
        991731
    ],
    "policyIds": [
        32145,
        4120,
        55295
    ],
    "listIds": [
        3905,
        5762
    ]
}

Edit a delegated access user

Edits delegated access to sites, policies, etc.

PUT /etp-config/v1/configs/{configId}/delegated-access

Sample: /etp-config/v1/configs/342/delegated-access

Content-Type: application/json

Download schema: delegated-access.json

Request body:

[
    {
        "etpConfigId": "1100",
        "username": "ab.ab@akamai.com",
        "firstName": "Customer2",
        "lastName": "Admin",
        "displayName": "Customer2 Admin ( ab.ab@akamai.com )",
        "siteIds": [
            991731,
            1009353
        ],
        "policyIds": [
            32145,
            4120,
            55295
        ],
        "listIds": [
            3905,
            5762,
            32259,
            32263,
            3785,
            4362,
            32336,
            32081,
            32337,
            14421,
            13461,
            31509,
            6942,
            5601,
            40097,
            11303,
            40431,
            40432,
            4021,
            40822,
            5562,
            4541,
            5821,
            5823,
            34303
        ]
    }
]
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

List dedicated access users

Provides the list of delegated access users.

GET /etp-config/v1/configs/{configId}/delegated-access/all

Sample: /etp-config/v1/configs/342/delegated-access/all

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: delegated-access-all.json

Response body:

[
    {
        "etpConfigId": 1100,
        "username": "ab@gmail.com",
        "fullName": "ab@gmail.com",
        "siteIds": [
            1009353,
            991731
        ],
        "policyIds": [
            32145,
            4120,
            55295
        ],
        "listIds": [
            3905,
            5762,
            32259,
            32263,
            3785,
            4362,
            32336,
            32081,
            32337,
            14421,
            13461,
            31509,
            6942,
            5601,
            40097,
            11303,
            40431,
            40432,
            4021,
            40822,
            5562,
            4541,
            5821,
            5823,
            34303
        ]
    },
    {
        "etpConfigId": 1100,
        "username": "apeeman@gmail.com",
        "fullName": "apeeman@gmail.com",
        "siteIds": [
            1009353,
            991731
        ],
        "policyIds": [
            55295
        ],
        "listIds": [
            5823,
            34303
        ]
    }
]

Get DNS-VIPs

Provides DNS-VIPs details.

GET /etp-config/v1/configs/{configId}/dns-vips

Sample: /etp-config/v1/configs/342/dns-vips

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: dns-vips.json

Response body:

{
    "ipv4Addrs": {
        "primary": "23.216.52.49",
        "secondary": "23.216.53.49"
    },
    "ipv6Addrs": {
        "primary": "2600:14c0:0:0:0:0:0:49",
        "secondary": "2600:14c0:1:0:0:0:0:49"
    }
}

Get the first time wizard

Provides the first time wizard details status.

GET /etp-config/v1/configs/{configId}/firstTimeWizard

Sample: /etp-config/v1/configs/342/firstTimeWizard

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: first-time-wizard-get-state.json

Response body:

{
    "step": -1,
    "playIntroVideo": false,
    "videoLink": "https://link to video location"
}

Update first time wizard

Updates the status of the first time wizard.

PUT /etp-config/v1/configs/{configId}/firstTimeWizard

Sample: /etp-config/v1/configs/342/firstTimeWizard

Content-Type: application/json

Download schema: first-time-wizard-update-state.json

Request body:

{
    "step": 2
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: first-time-wizard-get-state.json

Response body:

{
    "step": 2,
    "playIntroVideo": false
}

Get global settings

Provides global settings details.

GET /etp-config/v1/configs/{configId}/global-settings

Sample: /etp-config/v1/configs/342/global-settings

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: global-setting-request.json

Response body:

{
    "blockRoamingTraffic": true,
    "quicklistMigrated": true,
    "modifiedDate": "2020-08-06T23:23:22.014+0000",
    "modifiedBy": "john.doe@etp.com",
    "createdDate": "2018-03-05T17:10:33.849+0000",
    "createdBy": "internal"
}

Update global setting

Updates the global settings.

PUT /etp-config/v1/configs/{configId}/global-settings

Sample: /etp-config/v1/configs/342/global-settings

Content-Type: application/json

Request body:

{
    "blockRoamingTraffic": false,
    "quicklistMigrated": true
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

List sites

Returns a list of all Sites for a configuration.

GET /etp-config/v1/configs/{configId}/sites

Sample: /etp-config/v1/configs/342/sites

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: site-retrieve-all.json

Response body:

[
    {
        "id": 2160,
        "name": "Unidentified IPs",
        "description": "IPs not assigned to a configured Location",
        "policyId": 2480,
        "isOffnetworkLocation": false,
        "modifiedDate": "2017-04-25T22:26:15.687+0000",
        "modifiedBy": "internal",
        "createdDate": "2017-04-25T22:26:15.687+0000",
        "createdBy": "internal",
        "bypassSubnets": [
            "125.36.25.15"
        ],
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedAdmin@org.com"
            ]
        },
        "policyInfo": {
            "id": 2480,
            "name": "Default"
        },
        "exitPoints": [
            {
                "ipAddr": "125.25.36.12",
                "addrType": "ADDR_TYPE_IPV4"
            }
        ]
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/sites.

Create a site

Creates a new site.

POST /etp-config/v1/configs/{configId}/sites

Sample: /etp-config/v1/configs/342/sites

Content-Type: application/json

Download schema: site-create.json

Request body:

{
    "name": "Akamai Site 1",
    "description": "This is Akamai's site",
    "policyId": 1030,
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a site

Returns the details of a specific Site.

GET /etp-config/v1/configs/{configId}/sites/{siteId}

Sample: /etp-config/v1/configs/342/sites/101

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
siteId Integer 101 A unique identifier for a site.

Status 200 application/json

Object type: Site

Download schema: site-retrieve-specific.json

Response body:

{
    "id": 2160,
    "name": "Unidentified IPs",
    "description": "IPs not assigned to a configured Location",
    "policyId": 2480,
    "isOffnetworkLocation": false,
    "modifiedDate": "2017-04-25T22:26:15.687+0000",
    "modifiedBy": "internal",
    "createdDate": "2017-04-25T22:26:15.687+0000",
    "createdBy": "internal",
    "bypassSubnets": [
        "125.36.25.15"
    ],
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "deleagtedUser@org.com"
        ]
    },
    "policyInfo": {
        "id": 2480,
        "name": "Default"
    },
    "exitPoints": [
        {
            "ipAddr": "125.25.36.12",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Sites to retrieve a specific siteId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/sites/{siteId}.

Update a site

Modifies site details.

PUT /etp-config/v1/configs/{configId}/sites/{siteId}

Sample: /etp-config/v1/configs/342/sites/101

Content-Type: application/json

Download schema: site-create.json

Request body:

{
    "name": "Akamai Site 1",
    "description": "This is Akamai's site",
    "policyId": 1030,
    "exitPoints": [
        {
            "ipAddr": "10.10.10.10",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
siteId Integer 101 A unique identifier for a site.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Sites to retrieve a specific siteId.

  3. Run Get a Site to retrieve a Site object.

  4. Modify the Site object.

  5. Make a PUT request to /etp-config/v1/configs/{configId}/sites/{siteId}.

Remove a site

Deletes a specific site.

DELETE /etp-config/v1/configs/{configId}/sites/{siteId}

Sample: /etp-config/v1/configs/342/sites/101

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
siteId Integer 101 A unique identifier for a site.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Sites to retrieve a specific siteId.

  3. Make a DELETE request to /etp-config/v1/configs/{configId}/sites/{siteId}.

List policies

Returns a list of all policies.

GET /etp-config/v1/configs/{configId}/policies

Sample: /etp-config/v1/configs/342/policies

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: policy-retrieve-all.json

Response body:

[
    {
        "id": 2480,
        "name": "Default",
        "description": "Default policy",
        "akamaiDefined": true,
        "authenticationMode": "NONE",
        "modifiedDate": "2020-06-25T20:20:33.114+0000",
        "modifiedBy": "panghan",
        "createdDate": "2017-04-25T22:26:15.597+0000",
        "createdBy": "internal",
        "sites": [
            2160,
            18217,
            991731,
            991733
        ],
        "policyGeneralSettings": {
            "aupMigrated": true
        },
        "ipaSettings": {
            "randomCheck": false,
            "zdp": false,
            "enabled": false
        },
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedAdmin@org.com"
            ]
        },
        "safeSearchSettings": {
            "youtube": "open"
        },
        "riskyFileHandlingSettings": {
            "largeRiskyFileResponse": {
                "id": 5,
                "name": "Allow"
            },
            "hugeRiskyFileResponse": {
                "id": 5,
                "name": "Allow"
            }
        },
        "basicSettings": {
            "dnssec": false,
            "trustXFF": false,
            "proxyEnabled": false,
            "forwardProxyEnabled": false,
            "safesearch": false,
            "edns0ecs": true
        },
        "securitySettings": [
            {
                "shouldNotifySuspected": true,
                "shouldNotifyConfirmed": true,
                "suspectedResponseId": 760,
                "confirmedResponseId": 760,
                "listId": 1,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "listInfo": {
                    "id": 1,
                    "name": "Malware",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": true,
                "shouldNotifyConfirmed": true,
                "suspectedResponseId": 760,
                "confirmedResponseId": 760,
                "listId": 2,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "listInfo": {
                    "id": 2,
                    "name": "Phishing",
                    "categoryId": 2
                }
            },
            {
                "shouldNotifySuspected": true,
                "shouldNotifyConfirmed": true,
                "suspectedResponseId": 760,
                "confirmedResponseId": 760,
                "listId": 3,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "listInfo": {
                    "id": 3,
                    "name": "C&C",
                    "categoryId": 3
                }
            },
            {
                "shouldNotifySuspected": true,
                "shouldNotifyConfirmed": true,
                "suspectedResponseId": 2,
                "confirmedResponseId": 2,
                "listId": 4,
                "suspectedResponseInfo": {
                    "id": 2,
                    "name": "Block - DNS"
                },
                "confirmedResponseInfo": {
                    "id": 2,
                    "name": "Block - DNS"
                },
                "listInfo": {
                    "id": 4,
                    "name": "DNS Exfiltration",
                    "categoryId": 5
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 3785,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 3785,
                    "name": "Costa Rica WB",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 4541,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 4541,
                    "name": "Mchantor_LNS_List",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 3905,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 3905,
                    "name": "Kartik",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 4362,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 4362,
                    "name": "Dario Block list",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 4021,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 4021,
                    "name": "CR Akatec List",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 5562,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 5562,
                    "name": "anon",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 5821,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 5821,
                    "name": "BGLRtest",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 5823,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 5823,
                    "name": "Mel_test",
                    "categoryId": 2
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 5762,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 5762,
                    "name": "ishamy_customlist",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 760,
                "confirmedResponseId": 1,
                "listId": 6942,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 6942,
                    "name": "priya_test",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 1,
                "confirmedResponseId": 1,
                "listId": 5601,
                "suspectedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 5601,
                    "name": "luis list",
                    "categoryId": 1
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 10,
                "confirmedResponseId": 10,
                "listId": 32336,
                "suspectedResponseInfo": {
                    "id": 10,
                    "name": "Bypass"
                },
                "confirmedResponseInfo": {
                    "id": 10,
                    "name": "Bypass"
                },
                "listInfo": {
                    "id": 32336,
                    "name": "Allow List - migrated Quick List",
                    "categoryId": 4
                }
            },
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 4,
                "confirmedResponseId": 4,
                "listId": 32337,
                "suspectedResponseInfo": {
                    "id": 4,
                    "name": "Block - Error Page"
                },
                "confirmedResponseInfo": {
                    "id": 4,
                    "name": "Block - Error Page"
                },
                "listInfo": {
                    "id": 32337,
                    "name": "Deny List - migrated Quick List",
                    "categoryId": 4
                }
            }
        ],
        "aupSettings": [
            {
                "responseId": 5,
                "categoryId": 1,
                "users": [
                    "user1@org.com"
                ],
                "groups": [
                    "groupName1"
                ],
                "categoryInfo": {
                    "id": 1,
                    "name": "Social",
                    "code": "AKA-SOCIAL",
                    "deprecated": false,
                    "defaultActionId": 5
                },
                "responseInfo": {
                    "id": 5,
                    "name": "Allow"
                },
                "responseOverrides": [
                    {
                        "id": 4,
                        "name": "Block"
                    }
                ]
            }
        ],
        "sitesInfo": [
            {
                "id": 2160,
                "name": "Unidentified IPs"
            },
            {
                "id": 18217,
                "name": "DDNS"
            },
            {
                "id": 991731,
                "name": "aasdfsadfdsa"
            },
            {
                "id": 991733,
                "name": "Test11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf"
            }
        ]
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/policies.

Create a policy

Creates a new policy.

POST /etp-config/v1/configs/{configId}/policies

Sample: /etp-config/v1/configs/342/policies

Content-Type: application/json

Download schema: policy-create.json

Request body:

{
    "name": "Akamai Policy",
    "description": "Akamai's Policy",
    "sites": [
        100
    ],
    "basicSettings": {
        "dnssec": false,
        "edns0ecs": false
    },
    "aupSettings": [
        {
            "categoryId": 2,
            "responseId": 2
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "confirmedResponseId": 1,
            "suspectedResponseId": 1,
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a policy

Returns the details of a specific Policy.

GET /etp-config/v1/configs/{configId}/policies/{policyId}

Sample: /etp-config/v1/configs/342/policies/1040

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
policyId Integer 1040 A unique identifier for the policy.

Status 200 application/json

Object type: Policy

Download schema: policy-retrieve-specific.json

Response body:

{
    "id": 2480,
    "name": "Default",
    "description": "Default policy",
    "authenticationMode": "NONE",
    "akamaiDefined": true,
    "modifiedDate": "2020-06-25T20:20:33.114+0000",
    "modifiedBy": "panghan",
    "createdDate": "2017-04-25T22:26:15.597+0000",
    "createdBy": "internal",
    "sites": [
        2160,
        18217,
        991731,
        991733
    ],
    "safeSearchSettings": {
        "youtube": "open"
    },
    "riskyFileHandlingSettings": {
        "largeRiskyFileResponse": {
            "id": 5,
            "name": "Allow"
        },
        "hugeRiskyFileResponse": {
            "id": 5,
            "name": "Allow"
        }
    },
    "policyGeneralSettings": {
        "aupMigrated": true
    },
    "ipaSettings": {
        "zdp": false,
        "enabled": false,
        "randomCheck": false
    },
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "delegatedAdmin@org.com"
        ]
    },
    "basicSettings": {
        "dnssec": false,
        "trustXFF": false,
        "proxyEnabled": false,
        "forwardProxyEnabled": false,
        "safesearch": false,
        "edns0ecs": true
    },
    "securitySettings": [
        {
            "shouldNotifySuspected": true,
            "shouldNotifyConfirmed": true,
            "suspectedResponseId": 760,
            "confirmedResponseId": 760,
            "listId": 1,
            "suspectedResponseInfo": {
                "id": 760,
                "name": "Sinkhole 1"
            },
            "confirmedResponseInfo": {
                "id": 760,
                "name": "Sinkhole 1"
            },
            "listInfo": {
                "id": 1,
                "name": "Malware",
                "categoryId": 1
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 5601,
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "listInfo": {
                "id": 5601,
                "name": "luis list",
                "categoryId": 1
            }
        }
    ],
    "aupSettings": [
        {
            "responseId": 5,
            "categoryId": 1,
            "users": [
                "usr1@org.com",
                "user2@org.com"
            ],
            "groups": [
                "GroupName1"
            ],
            "categoryInfo": {
                "id": 1,
                "name": "Social",
                "code": "AKA-SOCIAL",
                "deprecated": false,
                "defaultActionId": 5
            },
            "responseInfo": {
                "id": 5,
                "name": "Allow"
            },
            "responseOverrides": [
                {
                    "id": 4,
                    "name": "Block"
                }
            ]
        }
    ],
    "sitesInfo": [
        {
            "id": 2160,
            "name": "Unidentified IPs"
        },
        {
            "id": 18217,
            "name": "DDNS"
        },
        {
            "id": 991731,
            "name": "aasdfsadfdsa"
        },
        {
            "id": 991733,
            "name": "Test11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf"
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Policies to retrieve a specific policyId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/policies/{policyId}.

Update a policy

Modifies a policy’s details.

PUT /etp-config/v1/configs/{configId}/policies/{policyId}

Sample: /etp-config/v1/configs/342/policies/1040

Content-Type: application/json

Download schema: policy-update.json

Request body:

{
    "id": 120,
    "name": "Akamai Policy",
    "description": "Akamai's Policy",
    "sites": [
        100
    ],
    "basicSettings": {
        "dnssec": false,
        "edns0ecs": false
    },
    "aupSettings": [
        {
            "categoryId": 2,
            "responseId": 2
        }
    ],
    "securitySettings": [
        {
            "listId": 1,
            "confirmedResponseId": 1,
            "suspectedResponseId": 1,
            "shouldNotifyConfirmed": true,
            "shouldNotifySuspected": true
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
policyId Integer 1040 A unique identifier for the policy.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Policies to retrieve a specific policyId.

  3. Run Get a Policy to retrieve a Policy object.

  4. Modify the Policy object.

  5. Make a PUT request to /etp-config/v1/configs/{configId}/policies/{policyId}.

Remove a policy

Deletes a specific policy.

DELETE /etp-config/v1/configs/{configId}/policies/{policyId}

Sample: /etp-config/v1/configs/342/policies/1040

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
policyId Integer 1040 A unique identifier for the policy.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Policies to retrieve a specific policyId.

  3. Make a DELETE request to /etp-config/v1/configs/{configId}/policies/{policyId}.

Get all lists

Returns a list of all available custom security lists.

GET /etp-config/v1/configs/{configId}/lists

Sample: /etp-config/v1/configs/342/lists

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: list-retrieve-all.json

Response body:

[
    {
        "id": 3785,
        "name": "Costa Rica WB",
        "description": "Costa Rica WB",
        "itemCount": 6,
        "securityCategoryId": 1,
        "allowedForDnsPolicy": true,
        "modifiedDate": "2020-06-10T20:39:04.386+0000",
        "modifiedBy": "panghan",
        "createdDate": "2017-06-27T21:07:20.443+0000",
        "createdBy": "hparker",
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedUser@org.com"
            ]
        },
        "knownCounts": {
            "domains": 3,
            "fileHashes": 0,
            "ips": 2
        },
        "suspectedCounts": {
            "domains": 1,
            "ips": 0
        },
        "securityCategoryInfo": {
            "id": 1,
            "name": "Malware"
        },
        "policySecuritySettings": [
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 760,
                "confirmedResponseId": 1,
                "listId": 6942,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 6942,
                    "name": "priya_test",
                    "categoryId": 1
                }
            }
        ]
    },
    {
        "id": 4541,
        "name": "Mchantor_LNS_List",
        "description": "LNS",
        "itemCount": 3,
        "securityCategoryId": 4,
        "allowedForDnsPolicy": true,
        "modifiedDate": "2019-12-06T12:51:30.990+0000",
        "modifiedBy": "deramach",
        "createdDate": "2017-08-24T15:46:32.204+0000",
        "createdBy": "mchantor",
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedUser@org.com"
            ]
        },
        "knownCounts": {
            "domains": 3,
            "fileHashes": 0,
            "ips": 0
        },
        "suspectedCounts": {
            "domains": 0,
            "ips": 0
        },
        "securityCategoryInfo": {
            "id": 4,
            "name": "Other"
        },
        "policySecuritySettings": [
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 760,
                "confirmedResponseId": 1,
                "listId": 6942,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 6942,
                    "name": "priya_test",
                    "categoryId": 1
                }
            }
        ]
    },
    {
        "id": 3905,
        "name": "Kartik",
        "description": "For the test",
        "itemCount": 2,
        "securityCategoryId": 4,
        "allowedForDnsPolicy": true,
        "modifiedDate": "2019-10-22T15:52:25.866+0000",
        "modifiedBy": "panghan",
        "createdDate": "2017-07-12T02:12:40.529+0000",
        "createdBy": "kaganesh",
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedUser@org.com"
            ]
        },
        "knownCounts": {
            "domains": 1,
            "fileHashes": 0,
            "ips": 1
        },
        "suspectedCounts": {
            "domains": 0,
            "ips": 0
        },
        "securityCategoryInfo": {
            "id": 4,
            "name": "Other"
        },
        "policySecuritySettings": [
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 760,
                "confirmedResponseId": 1,
                "listId": 6942,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 6942,
                    "name": "priya_test",
                    "categoryId": 1
                }
            }
        ]
    },
    {
        "id": 4362,
        "name": "Dario Block list",
        "description": "Block list",
        "itemCount": 0,
        "securityCategoryId": 4,
        "allowedForDnsPolicy": true,
        "modifiedDate": "2017-08-14T16:42:58.418+0000",
        "createdDate": "2017-08-14T16:10:31.425+0000",
        "createdBy": "drivera",
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedUser@org.com"
            ]
        },
        "knownCounts": {
            "domains": 0,
            "fileHashes": 0,
            "ips": 0
        },
        "suspectedCounts": {
            "domains": 0,
            "ips": 0
        },
        "securityCategoryInfo": {
            "id": 4,
            "name": "Other"
        },
        "policySecuritySettings": [
            {
                "shouldNotifySuspected": false,
                "shouldNotifyConfirmed": false,
                "suspectedResponseId": 760,
                "confirmedResponseId": 1,
                "listId": 6942,
                "suspectedResponseInfo": {
                    "id": 760,
                    "name": "Sinkhole 1"
                },
                "confirmedResponseInfo": {
                    "id": 1,
                    "name": "Monitor"
                },
                "listInfo": {
                    "id": 6942,
                    "name": "priya_test",
                    "categoryId": 1
                }
            }
        ]
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/lists.

Create a list

Creates a new list.

POST /etp-config/v1/configs/{configId}/lists

Sample: /etp-config/v1/configs/342/lists

Content-Type: application/json

Download schema: list-update.json

Request body:

{
    "name": "Example List name",
    "description": "A short description of the example List",
    "securityCategoryId": 1
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get Global list quota

Returns the remaining list item quota for all lists globally.

GET /etp-config/v1/configs/{configId}/lists/quota

Sample: /etp-config/v1/configs/342/lists/quota

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Object type: ListQuota

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

Response body:

{
    "count": 1000,
    "remainingCount": 990
}
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/lists/{quota}.

  3. View the returned ListQuota object.

Get a list

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/lists/{listId}

Sample: /etp-config/v1/configs/342/lists/225

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200 application/json

Object type: CustomList

Download schema: list-retrieve-specific.json

Response body:

{
    "id": 3785,
    "name": "Costa Rica WB",
    "description": "Costa Rica WB",
    "itemCount": 6,
    "securityCategoryId": 1,
    "allowedForDnsPolicy": true,
    "modifiedDate": "2020-06-10T20:39:04.386+0000",
    "modifiedBy": "panghan",
    "createdDate": "2017-06-27T21:07:20.443+0000",
    "createdBy": "hparker",
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "delegatedUser@org.com"
        ]
    },
    "knownCounts": {
        "domains": 3,
        "ips": 2
    },
    "suspectedCounts": {
        "domains": 1,
        "ips": 0
    },
    "securityCategoryInfo": {
        "id": 1,
        "name": "Malware"
    },
    "policySecuritySettings": [
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 2480,
            "policyName": "Default",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 84715,
            "policyName": "NewPWithD",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 82602,
            "policyName": "Sample Policy 12",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": true,
            "shouldNotifyConfirmed": true,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 82601,
            "policyName": "Sample Policy 11",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run Get All Lists to retrieve a specific listId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/lists/{listId}.

Update a list

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

PUT /etp-config/v1/configs/{configId}/lists/{listId}

Sample: /etp-config/v1/configs/342/lists/225

Content-Type: application/json

Download schema: list-update.json

Request body:

{
    "name": "Akamai List",
    "description": "Akamai's List",
    "securityCategoryId": 1
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run Get All Lists to retrieve a specific listId.

  3. Run Get a List to retrieve a CustomList object.

  4. Modify the CustomList object.

  5. Make a PUT request to /etp-config/v1/configs/{configId}/lists/{listId}.

Remove a list

Deletes a specific list.

DELETE /etp-config/v1/configs/{configId}/lists/{listId}

Sample: /etp-config/v1/configs/342/lists/225

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run Get All Lists to retrieve a specific listId.

  3. Make a DELETE request to /etp-config/v1/configs/{configId}/lists/{listId}.

Search in a list

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

GET /etp-config/v1/configs/{configId}/lists/{listId}/items{?numItemsPerPage,page,type,confidence,search}

Sample: /etp-config/v1/configs/342/lists/225/items?numItemsPerPage=25&page=1&type=192.168.0.10&confidence=2&search=192.168.1.100

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.
Optional query parameters
confidence Integer 2 The confidence level of the results. A value of 1 signifies a suspected item, while a value of 2 signifies a known item. The default value of 0 signifies both confidence values.
numItemsPerPage Integer 25 The number of items per page.
page Integer 1 The page number to fetch.
search String 192.168.1.100 Search The string within the results.
type String 192.168.0.10 The target domain or IP address to search.

Status 200 application/json

Download schema: list-retrieve-by-search.json

Response body:

{
    "totalCount": 200,
    "items": [
        {
            "type": "LIST_TYPE_IP",
            "value": "192.168.0.10",
            "confidenceLevelId": 1
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Select appropriate values for the numItemsPerPage,page, type, confidence, and search query parameters. See this operation’s parameters for details.

  3. Make a GET request to /etp-config/v1/configs/{configId}/lists/items{?numItemsPerPage,page,type,confidence,search}.

Modify list items

Updates list items. This operation overwrites any existing list item contents.

PUT /etp-config/v1/configs/{configId}/lists/{listId}/items

Sample: /etp-config/v1/configs/342/lists/225/items

Content-Type: application/json

Object type: ListItem

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

Request body:

[
    {
        "type": "LIST_TYPE_IP",
        "value": "192.168.100.100",
        "confidenceLevelId": 1
    }
]
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Modify the ListItem object.

  3. Make a PUT request to /etp-config/v1/configs/{configId}/lists/items.

Patch a list

Modifies individual list items entries. Add or delete only.

PATCH /etp-config/v1/configs/{configId}/lists/{listId}/items

Sample: /etp-config/v1/configs/342/lists/225/items

Content-Type: application/json

Object type: ListPatch

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

Request body:

{
    "delete": [
        "192.160.100.100",
        "220.10.100.11"
    ],
    "add": [
        {
            "type": "LIST_TYPE_IP",
            "value": "115.65.10.134",
            "confidenceLevelId": 2
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

Bulk patch a list

Modifies individual list items entries. Add or delete only.

PATCH /etp-config/v1/configs/{configId}/lists/{listId}/items/bulk

Sample: /etp-config/v1/configs/342/lists/225/items/bulk

Content-Type: application/json

Download schema: list-bulk-items-patch.json

Request body:

{
    "delete": [
        "192.160.100.100",
        "220.10.100.11"
    ],
    "add": {
        "type": "LIST_TYPE_IP",
        "confidenceLevelId": 2,
        "items": [
            "115.65.10.133",
            "10.15.16.30"
        ]
    }
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

Add the list to the policy

Adds the list to the policy.

POST /etp-config/v1/configs/{configId}/lists/{listId}/op/add-to-policies

Sample: /etp-config/v1/configs/342/lists/225/op/add-to-policies

Content-Type: application/json

Download schema: list-associate-policy.json

Request body:

{
    "name": "Costa Rica WB",
    "policyId": 82601,
    "policyName": "Sample Policy 11",
    "securityCategoryId": 1
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

Remove the list from policy

Disassociates the list from a policy.

POST /etp-config/v1/configs/{configId}/lists/{listId}/op/remove-from-policies

Sample: /etp-config/v1/configs/342/lists/225/op/remove-from-policies

Content-Type: application/json

Download schema: list-associate-policy.json

Request body:

{
    "name": "Costa Rica WB",
    "policyId": 82601,
    "policyName": "Sample Policy 11",
    "securityCategoryId": 1
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listId Integer 225 A unique identifier for the list. Use this value for a listId parameter in subsequent operations.

Status 200

List recent changes

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/lists/recentChanges

Sample: /etp-config/v1/configs/342/lists/recentChanges

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/lists/recentChanges.

Get all list deployments

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/lists/deployments

Sample: /etp-config/v1/configs/342/lists/deployments

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Object type: ListDeployment

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

Response body:

[
    {
        "id": 101,
        "status": "COMPLETED",
        "message": "File successfully deployed to Akamai network (Succeeded)",
        "startTime": "2016-09-23",
        "endTime": "2016-09-23",
        "deployedBy": "internal-user"
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/lists/deployments.

Create a list deployment

Deprecated. This operation is deprecated and no longer supported.

POST /etp-config/v1/configs/{configId}/lists/deployments

Sample: /etp-config/v1/configs/342/lists/deployments

Content-Type: application/json

Object type: ListDeployment

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

Request body:

{
    "id": 102,
    "status": "PENDING"
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a list deployment

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/lists/deployments/{listDeploymentId}

Sample: /etp-config/v1/configs/342/lists/deployments/101

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listDeploymentId Integer 101 A unique ID for the list deployment. Use this value for a listDeploymentId parameter in subsequent operations.

Status 200 application/json

Object type: ListDeployment

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

Response body:

{
    "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"
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run Get All List Deployments to retrieve a specific deploymentId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/lists/deployments/{deploymentId}.

Get all emergency lists

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/emergency-lists

Sample: /etp-config/v1/configs/342/emergency-lists

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

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

Response body:

{
    "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"
        ]
    }
}
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/emergency-lists.

Get an emergency list

Deprecated. Emergency lists are deprecated and no longer supported. Please use Get a list to retrieve a CustomLists.

GET /etp-config/v1/configs/{configId}/emergency-lists/{listType}

Sample: /etp-config/v1/configs/342/emergency-lists/whitelist

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listType Enumeration whitelist The type of list. Valid values are whitelist or blacklist.

Status 200 application/json

Download schema: list-update.json

Response body:

{
    "itemCount": 4,
    "remainingCount": 996,
    "ipAddrs": [
        "192.169.19.29",
        "180.220.11.110"
    ],
    "domains": [
        "www.google.com",
        "www.facebook.com"
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. For the type URL parameter, choose the appropriate value, either whitelist or blacklist.

  3. Make a GET request to /etp-config/v1/configs/{configId}/emergency-lists/{type}.

Update an emergency list

Deprecated. Please use Update a list to modify a CustomLists.

PUT /etp-config/v1/configs/{configId}/emergency-lists/{listType}

Sample: /etp-config/v1/configs/342/emergency-lists/whitelist

Content-Type: application/json

Download schema: list-update.json

Request body:

{
    "ipAddrs": [
        "10.10.0.8"
    ],
    "domains": [
        "www.akamai.com"
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
listType Enumeration whitelist The type of list. Valid values are whitelist or blacklist.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. For the type URL parameter, choose the appropriate value, either whitelist or blacklist.

  3. Run Get an Emergency List to retrieve an EmergencyList object.

  4. Modify the EmergencyList object.

  5. Make a PUT request to /etp-config/v1/configs/{configId}/emergency-lists/{type}.

List honeypots

Returns a list of all honeypots.

GET /etp-config/v1/configs/{configId}/honeypots

Sample: /etp-config/v1/configs/342/honeypots

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: honeypot-retrieve-all.json

Response body:

[
    {
        "id": 760,
        "name": "Sinkhole 1",
        "description": "Custom Response",
        "modifiedDate": "2020-05-12T18:42:50.716+0000",
        "modifiedBy": "unknown",
        "createdDate": "2017-07-18T16:20:49.967+0000",
        "createdBy": "hparker",
        "ipv4Addrs": [
            "202.22.33.33"
        ],
        "ipv6Addrs": [
            "2019:D30::88/124",
            "2021:D32::88/124"
        ],
        "aliases": [
            "abcd.com"
        ],
        "policies": [
            {
                "id": 2480,
                "name": "Default"
            }
        ]
    },
    {
        "id": 30807,
        "name": "Test Dsoni",
        "description": "Test Dsoni",
        "modifiedDate": "2020-07-21T13:25:25.562+0000",
        "modifiedBy": "dsoni",
        "createdDate": "2020-07-21T13:25:25.555+0000",
        "createdBy": "dsoni",
        "ipv4Addrs": [
            "192.11.111.1"
        ],
        "ipv6Addrs": [
            "2019:D30::88/124",
            "2021:D32::88/124"
        ],
        "aliases": [
            "d-soni.com"
        ],
        "policies": [
            {
                "id": 2250,
                "name": "Sample Policy"
            }
        ]
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/honeypots.

Create a honeypot

Creates a new honeypot.

POST /etp-config/v1/configs/{configId}/honeypots

Sample: /etp-config/v1/configs/342/honeypots

Content-Type: application/json

Download schema: list-update.json

Request body:

{
    "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"
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a honeypot

Returns the details of a specific honeypot.

GET /etp-config/v1/configs/{configId}/honeypots/{honeypotId}

Sample: /etp-config/v1/configs/342/honeypots/1

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
honeypotId Integer 1 A unique identifier for a honeypot.

Status 200 application/json

Object type: Honeypot

Download schema: honeypot-retrieve-specific.json

Response body:

{
    "id": 760,
    "name": "Sinkhole 1",
    "description": "Custom Response",
    "modifiedDate": "2020-05-12T18:42:50.716+0000",
    "modifiedBy": "unknown",
    "createdDate": "2017-07-18T16:20:49.967+0000",
    "createdBy": "hparker",
    "ipv4Addrs": [
        "202.22.33.33"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ],
    "aliases": [
        "abcd.com"
    ],
    "policies": [
        {
            "id": 2480,
            "name": "Default"
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Honeypots to retrieve a specific honeypotId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/honeypots/{honeypotId}.

Update a honeypot

Modifies a honeypot’s features.

PUT /etp-config/v1/configs/{configId}/honeypots/{honeypotId}

Sample: /etp-config/v1/configs/342/honeypots/1

Content-Type: application/json

Download schema: honeypot-update.json

Request body:

{
    "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"
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
honeypotId Integer 1 A unique identifier for a honeypot.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Honeypots to retrieve a specific honeypotId.

  3. Run Get a Honeypot to retrieve a Honeypot.

  4. Modify the Honeypot object.

  5. Make a PUT request to /etp-config/v1/configs/{configId}/honeypots/{honeypotId}.

Remove a honeypot

Deletes a specific honeypot.

DELETE /etp-config/v1/configs/{configId}/honeypots/{honeypotId}

Sample: /etp-config/v1/configs/342/honeypots/1

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
honeypotId Integer 1 A unique identifier for a honeypot.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Honeypots to retrieve a specific honeypotId.

  3. Make a DELETE request to /etp-config/v1/configs/{configId}/honeypots/{honeypotId}.

List configuration deployments

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/deployments

Sample: /etp-config/v1/configs/342/deployments

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

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

Response body:

[
    {
        "id": 101,
        "status": "COMPLETED",
        "message": "null",
        "startTime": "2016-08-31",
        "endTime": "2016-08-31",
        "deployedBy": "internal_user",
        "progressPct": 100
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/deployments.

Create a configuration deployment

Deprecated. This operation is deprecated and no longer supported.

POST /etp-config/v1/configs/{configId}/deployments

Sample: /etp-config/v1/configs/342/deployments

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get a configuration deployment

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/deployments/{configDeploymentId}

Sample: /etp-config/v1/configs/342/deployments/101

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
configDeploymentId Integer 101 A unique ID for the configuration deployment. Use this value for a configDeploymentId parameter in subsequent operations.

Status 200 application/json

Object type: ConfigurationDeployment

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

Response body:

{
    "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
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Configuration Deployments to retrieve a specific configDeploymentId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/deployments/{configDeploymentId}.

Get recent changes

Deprecated. This operation is deprecated and no longer supported.

GET /etp-config/v1/configs/{configId}/recentChanges

Sample: /etp-config/v1/configs/342/recentChanges

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/recentChanges.

List sinkholes

Returns a list of sinkholes.

GET /etp-config/v1/configs/{configId}/akamai-sinkholes

Sample: /etp-config/v1/configs/342/akamai-sinkholes

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: sinkholes-list.json

Response body:

[
    {
        "id": 2147,
        "name": "SecurityConnforBLR",
        "description": "Akamai Sinkhole",
        "uuid": "2c582ae6-2552-423b-a84d-a36a9fd42ef6",
        "version": "1.0.1.0",
        "supportedUntil": 1572998400000,
        "lastCommunication": 1516787738000,
        "deleted": false,
        "modifiedDate": "2017-11-30T09:59:19.967+0000",
        "modifiedBy": "internal",
        "createdDate": "2017-11-30T09:59:19.967+0000",
        "createdBy": "internal",
        "ipv4Addrs": [
            "10.0.3.15"
        ],
        "ipv6Addrs": [
            "fe80::a00:27ff:fe9d:b3be"
        ],
        "aliases": [
            "abcd.com"
        ],
        "status": {
            "status": "ACTIVE",
            "connectionStatus": "DISCONNECTED",
            "availableSoftwareVersion": "2.5.0"
        },
        "policies": [
            {
                "id": 2250,
                "name": "Sample Policy"
            }
        ]
    },
    {
        "id": 1760,
        "name": "ESC",
        "description": "Akamai Sinkhole",
        "uuid": "2f90515f-44f2-432f-9b87-0cbfba6b60aa",
        "version": "1.0.0.0",
        "supportedUntil": 1572998400000,
        "lastCommunication": 1510603585000,
        "deleted": false,
        "modifiedDate": "2017-11-13T20:07:18.585+0000",
        "modifiedBy": "internal",
        "createdDate": "2017-11-13T20:07:18.585+0000",
        "createdBy": "internal",
        "ipv4Addrs": [
            "192.168.0.14"
        ],
        "ipv6Addrs": [
            "fe80::20c:29ff:fed4:45f6"
        ],
        "aliases": [
            "abcd.com"
        ],
        "status": {
            "status": "ACTIVE",
            "connectionStatus": "DISCONNECTED",
            "availableSoftwareVersion": "2.5.0"
        },
        "policies": [
            {
                "id": 2250,
                "name": "Sample Policy"
            }
        ]
    },
    {
        "id": 2140,
        "name": "amyconnector",
        "description": "Akamai Sinkhole",
        "uuid": "4e627653-086e-454f-9821-0dbdd8500035",
        "version": "1.0.1.0",
        "supportedUntil": 1572998400000,
        "lastCommunication": 1512109949000,
        "deleted": false,
        "modifiedDate": "2017-11-30T06:25:21.315+0000",
        "modifiedBy": "internal",
        "createdDate": "2017-11-30T06:25:21.315+0000",
        "createdBy": "internal",
        "ipv4Addrs": [
            "10.0.3.15"
        ],
        "ipv6Addrs": [
            "fe80::a00:27ff:fe28:da94"
        ],
        "aliases": [
            "abcd.com"
        ],
        "status": {
            "status": "ACTIVE",
            "connectionStatus": "DISCONNECTED",
            "availableSoftwareVersion": "2.5.0"
        },
        "policies": [
            {
                "id": 2250,
                "name": "Sample Policy"
            }
        ]
    },
    {
        "id": 29404,
        "name": "SC-1",
        "uuid": "deec885e-9240-4719-ab3d-d744ce6d9aad",
        "version": "SC-2.6.8",
        "supportedUntil": 1622972585000,
        "deleted": false,
        "modifiedDate": "2020-07-15T17:26:22.743+0000",
        "modifiedBy": "internal",
        "createdDate": "2020-07-15T17:26:22.742+0000",
        "createdBy": "internal",
        "ipv4Addrs": [
            "123.125.148.12"
        ],
        "ipv6Addrs": [
            "2019:D30::88/124",
            "2021:D32::88/124"
        ],
        "aliases": [
            "abcd.com"
        ],
        "status": {
            "status": "ACTIVATION_IN_PROGRESS",
            "connectionStatus": "DISCONNECTED"
        },
        "policies": [
            {
                "id": 2250,
                "name": "Sample Policy"
            }
        ]
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Make a GET request to /etp-config/v1/configs/{configId}/akamai-sinkholes.

  3. The operation responds with an array of Sinkhole objects.

Create a sinkhole

Creates a sinkhole.

POST /etp-config/v1/configs/{configId}/akamai-sinkholes

Sample: /etp-config/v1/configs/342/akamai-sinkholes

Content-Type: application/json

Download schema: sinkhole.json

Request body:

{
    "name": "praveenconnector",
    "description": "Akamai Sinkhole",
    "ipv4Addrs": [
        "12.12.12.12"
    ],
    "ipv6Addrs": [
        "fe80::a00:27ff:fe28:da94"
    ],
    "aliases": [
        "abcd.com"
    ],
    "policies": [
        {
            "id": 2250,
            "name": "Sample Policy"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get sinkhole SC latest version

Provides the sinkhole SC Latest version details.

GET /etp-config/v1/configs/{configId}/akamai-sinkholes/sc-latest-versions

Sample: /etp-config/v1/configs/342/akamai-sinkholes/sc-latest-versions

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Response body:

[
    {
        "version": "SC-2.6.8",
        "packageLocation": "https://dnsclient.etp.akamai.com/security-connector/vm/latest/akamai-security-connector.zip?token=st=1596837469~exp=1596841069~acl=%2F%2A~hmac=7f1b4ab6d659cdeef88a1245a5b532aa1278757c7f655bdd34238dc562e001d3",
        "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838",
        "type": "MICROSOFT"
    },
    {
        "version": "SC-2.6.8",
        "packageLocation": "https://dnsclient.etp.akamai.com/security-connector/vm/latest/akamai-security-connector.ova?token=st=1596837470~exp=1596841070~acl=%2F%2A~hmac=40d9a9076365e12072dab29aed5a90d648cdf9d1a1602f1557fea0a32936e23a",
        "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838",
        "type": "VMWARE"
    }
]

Get sinkhole latest version

Provides the latest version of the sinkhole.

GET /etp-config/v1/configs/{configId}/akamai-sinkholes/latest-version

Sample: /etp-config/v1/configs/342/akamai-sinkholes/latest-version

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: sinkhole-version.json

Response body:

{
    "version": "1.0.1.1",
    "packageLocation": "https://dnsclient.etp.akamai.com/vm/PLEASE READ - Beta Expiration.txt?token=st=1597088278~exp=1597091878~acl=%2F%2A~hmac=801c68d7a08c7ab36cf5d98cf62aad143de62323feb2568352e91d4028bb9891",
    "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838"
}

Get a sinkhole

Returns the details of a specific sinkhole.

GET /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200 application/json

Download schema: sinkhole.json

Response body:

{
    "id": 2140,
    "name": "amyconnector",
    "description": "Akamai Sinkhole",
    "uuid": "4e627653-086e-454f-9821-0dbdd8500035",
    "version": "1.0.1.0",
    "supportedUntil": 1572998400000,
    "lastCommunication": 1512109949000,
    "deleted": false,
    "modifiedDate": "2017-11-30T06:25:21.315+0000",
    "modifiedBy": "internal",
    "createdDate": "2017-11-30T06:25:21.315+0000",
    "createdBy": "internal",
    "ipv4Addrs": [
        "10.0.3.15"
    ],
    "ipv6Addrs": [
        "fe80::a00:27ff:fe28:da94"
    ],
    "aliases": [
        "abcd.com"
    ],
    "status": {
        "status": "ACTIVE",
        "connectionStatus": "DISCONNECTED",
        "availableSoftwareVersion": "2.5.0"
    },
    "policies": [
        {
            "id": 2250,
            "name": "Sample Policy"
        }
    ]
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Akamai sinkholes and store the relevant sinkholeId.

  3. Make a GET request to /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}.

  4. The operation responds with a Sinkhole object.

Delete sinkhole

Deletes the specified sinkhole.

DELETE /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200

Replacement of the sinkhole

Replaces the current sinkhole with new one.

PUT /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/policy-assignment

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140/policy-assignment

Content-Type: application/json

Download schema: sinkhole-policy-assignment-body.json

Request body:

{
    "newId": 29404,
    "deleteSinkhole": false,
    "aupResponseId": 1234
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200

Generate activation code for sinkhole

Generates the activation code for sinkhole.

POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/generate-activation-code

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140/op/generate-activation-code

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200 application/json

Download schema: sinkhole-generate-code-post-response.json

Response body:

{
    "akamaiSinkholeId": 29404,
    "configId": 1100,
    "activationCode": "4X8G4K2Z",
    "serialNumber": "deec885e-9240-4719-ab3d-d744ce6d9aad",
    "activationCodeExpiry": 1597671355820,
    "entitlementCode": "4f5715cd-4f96-4748-9d2f-fa9d9d6b9838"
}

Change local sinkhole password

Changes the local password for specified sinkhole.

POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/change-local-password

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140/op/change-local-password

Content-Type: application/json

Download schema: sinkhole-change-pwd.json

Request body:

{
    "newPassword": "abc123"
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200

Upgrade the sinkhole

Upgrades software of the specific sinkhole.

POST /etp-config/v1/configs/{configId}/akamai-sinkholes/{sinkholeId}/op/upgrade

Sample: /etp-config/v1/configs/342/akamai-sinkholes/2140/op/upgrade

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
sinkholeId Integer 2140 A unique identifier for the sinkhole.

Status 200

Get site meta info

Provides site meta info details.

GET /etp-config/v1/configs/{configId}/sites-meta-info

Sample: /etp-config/v1/configs/342/sites-meta-info

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: sites-meta-info-all.json

Response body:

[
    {
        "id": 2160,
        "name": "Unidentified IPs",
        "description": "IPs not assigned to a configured Location",
        "policyId": 2480,
        "isOffnetworkLocation": false,
        "modifiedDate": "2017-04-25T22:26:15.687+0000",
        "modifiedBy": "internal",
        "createdDate": "2017-04-25T22:26:15.687+0000",
        "createdBy": "internal",
        "bypassSubnets": [
            "125.36.12.15"
        ],
        "accessConfig": {
            "configurable": true,
            "readable": true,
            "delegatedAdmins": [
                "delegatedUser@org.com"
            ]
        },
        "policyInfo": {
            "id": 2480,
            "name": "Default"
        },
        "exitPoints": [
            {
                "ipAddr": "125.25.36.12",
                "addrType": "ADDR_TYPE_IPV4"
            }
        ]
    }
]

Get proxy credentials

Provides list of proxy credential users.

GET /etp-config/v1/configs/{configId}/proxy-credentials

Sample: /etp-config/v1/configs/342/proxy-credentials

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: proxy-credentials-all.json

Response body:

[
    {
        "username": "dgamra53@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "smandyam@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "lgumpina2@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "lgumpina3@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "lgumpina4@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "lgumpina6@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    },
    {
        "username": "lgumpina7@1041",
        "modifiedDate": "2020-07-22T18:49:06.031+0000",
        "modifiedBy": "panghan",
        "createdDate": "2020-05-18T15:40:07.146+0000",
        "createdBy": "dl-enterprise-demo"
    }
]

Create proxy credential

Creates a new proxy credential.

POST /etp-config/v1/configs/{configId}/proxy-credentials

Sample: /etp-config/v1/configs/342/proxy-credentials

Content-Type: application/json

Download schema: proxy-credential-specific-create.json

Request body:

{
    "username": "psathyes",
    "password": "QWthbWFpMTIzIQ=="
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get proxy credential user details

Provides the proxy credential info for the specified user.

GET /etp-config/v1/configs/{configId}/proxy-credentials/{userName}

Sample: /etp-config/v1/configs/342/proxy-credentials/rocky

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
userName String rocky UserName associated with the proxy-credential.

Status 200

Remove a proxy credential

Deletes a specific proxy credential.

DELETE /etp-config/v1/configs/{configId}/proxy-credentials/{userName}

Sample: /etp-config/v1/configs/342/proxy-credentials/rocky

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
userName String rocky UserName associated with the proxy-credential.

Status 200

Get the network configuration

Provides network configuration details.

GET /etp-config/v1/configs/{configId}/network-configuration

Sample: /etp-config/v1/configs/342/network-configuration

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: network-config-response.json

Response body:

{
    "networkConfigId": 624,
    "modifiedDate": "2020-08-06T23:30:59.861+0000",
    "modifiedBy": "john.doe@etp.com",
    "createdDate": "2018-08-20T18:11:36.911+0000",
    "createdBy": "internal",
    "corporateNetworkInternalIPsv4": [
        "172.16.0.0/12",
        "192.168.0.0/16"
    ],
    "corporateNetworkInternalIPsv6": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ],
    "corporateNetworkDNSSuffixes": [
        "asdf.324.3444-3-3-3.com"
    ],
    "bypassURLs": [
        " https://linktobypassLocation"
    ],
    "locations": [
        {
            "locationId": "2162",
            "IPsv4": [
                "23.33.22.33",
                "23.33.22.34"
            ],
            "IPsv6": [
                "2019:D40::88/124",
                "2021:D42::88/124"
            ]
        },
        {
            "locationId": "5004",
            "IPsv4": [
                "25.15.12.63"
            ],
            "IPsv6": [
                "2019:D50::88/124"
            ]
        }
    ]
}

Create a network configuration

Creates the network configuration.

POST /etp-config/v1/configs/{configId}/network-configuration

Sample: /etp-config/v1/configs/342/network-configuration

Content-Type: application/json

Download schema: network-config-post-request.json

Request body:

{
    "corporateNetworkInternalIPsv4": [
        "172.172.172.17",
        "192.168.0.0/16"
    ],
    "locations": [
        {
            "locationId": "11111",
            "IPsv4": [
                "182.1.1.1"
            ],
            "IPsv6": [
                "2019:D50::88/124"
            ]
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Update the network configuration

Updates the network configuration.

PUT /etp-config/v1/configs/{configId}/network-configuration

Sample: /etp-config/v1/configs/342/network-configuration

Content-Type: application/json

Download schema: network-config-put-request.json

Request body:

{
    "networkConfigId": 624,
    "corporateNetworkInternalIPsv4": [
        "172.172.172.17",
        "192.168.0.0/16"
    ],
    "locations": [
        {
            "locationId": "11111",
            "IPsv4": [
                "182.1.1.1"
            ],
            "IPsv6": [
                "2019:D50::88/124"
            ]
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Get notification configuration

Provides all notification configurations.

GET /etp-config/v1/configs/{configId}/notifications-config

Sample: /etp-config/v1/configs/342/notifications-config

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200 application/json

Download schema: notification-config-all.json

Response body:

[
    {
        "id": 681,
        "value": "adoad@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.769+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-10-30T08:41:49.977+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 1584,
        "value": "priyas@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.781+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2018-02-09T08:37:32.640+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 85,
        "value": "mchantor@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.792+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-08-22T19:39:17.408+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 120,
        "value": "jyeung@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.801+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-08-09T19:28:06.966+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 131,
        "value": "sshindad@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.808+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-09-11T19:11:07.500+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 146,
        "value": "waburtol@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.819+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-08-24T16:13:48.780+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 147,
        "value": "mchantor94_gmail.com@nomail-akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.827+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-08-24T15:55:34.360+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 661,
        "value": "anrodrig@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.835+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-10-29T05:08:15.769+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 941,
        "value": "rannadan@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.842+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-11-22T06:33:54.572+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 1045,
        "value": "lmittal@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2019-10-17T13:28:42.850+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2017-12-06T08:00:58.426+0000",
        "createdBy": "unknown",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": true
            }
        ]
    },
    {
        "id": 6702,
        "value": "panghan@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "PARTIAL",
        "modifiedDate": "2019-10-17T13:28:42.871+0000",
        "modifiedBy": "lgumpina",
        "createdDate": "2019-01-23T02:17:43.178+0000",
        "createdBy": "panghan",
        "siteMappings": [
            {
                "siteId": 2162,
                "siteName": "Wai home access"
            },
            {
                "siteId": 5004,
                "siteName": "Off Network ETP Clients"
            },
            {
                "siteId": 2160,
                "siteName": "Unidentified IPs"
            }
        ],
        "attributes": [
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": true
            },
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            }
        ]
    },
    {
        "id": 20913,
        "value": "dsoni@akamai.com",
        "type": "email",
        "siteSelectionStrategy": "ALL",
        "modifiedDate": "2020-07-21T13:27:20.992+0000",
        "modifiedBy": "dsoni",
        "createdDate": "2020-07-21T13:27:20.992+0000",
        "createdBy": "dsoni",
        "siteMappings": [
            {
                "siteId": 1234,
                "siteName": "SampleSite"
            }
        ],
        "attributes": [
            {
                "category": "alert",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "upgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "vmUpgrade",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "system",
                "contentType": "text/html",
                "enabled": false
            },
            {
                "category": "scheduledReport",
                "contentType": "text/html",
                "enabled": false
            }
        ]
    }
]

Create notifications configs

Create notification configs in bulk.

POST /etp-config/v1/configs/{configId}/notifications-config

Sample: /etp-config/v1/configs/342/notifications-config

Content-Type: application/json

Request body:

{
    "id": 681,
    "value": "adoad@akamai.com",
    "type": "email",
    "siteSelectionStrategy": "ALL",
    "siteMappings": [
        {
            "siteId": 1234,
            "siteName": "SampleSite"
        }
    ],
    "attributes": [
        {
            "category": "scheduledReport",
            "contentType": "text/html",
            "enabled": false
        },
        {
            "category": "system",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "upgrade",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "alert",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "vmUpgrade",
            "contentType": "text/html",
            "enabled": true
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Update the notifications configs

Updates the notification configs in bulk.

PUT /etp-config/v1/configs/{configId}/notifications-config

Sample: /etp-config/v1/configs/342/notifications-config

Content-Type: application/json

Request body:

{
    "id": 681,
    "value": "adoad@akamai.com",
    "type": "email",
    "siteSelectionStrategy": "ALL",
    "siteMappings": [
        {
            "siteId": 1234,
            "siteName": "SampleSite"
        }
    ],
    "attributes": [
        {
            "category": "scheduledReport",
            "contentType": "text/html",
            "enabled": false
        },
        {
            "category": "system",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "upgrade",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "alert",
            "contentType": "text/html",
            "enabled": true
        },
        {
            "category": "vmUpgrade",
            "contentType": "text/html",
            "enabled": true
        }
    ]
}
Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.

Status 200

Delete the notification configuration

Deletes the notification configuration with given id

DELETE /etp-config/v1/configs/{configId}/notifications-config/{notificationConfigId}

Sample: /etp-config/v1/configs/342/notifications-config/101

Parameter Type Sample Description
URL path parameters
configId Integer 342 A unique identifier for each configuration.
notificationConfigId Integer 101 A unique identifier for Notification Config.

Status 200

List proxy certificates

Returns a list of all available proxy certificates.

GET /etp-config/v1/tls/customers/{configId}/certificates{?debug,include-certificate}

Sample: /etp-config/v1/tls/customers/1040/certificates?debug=false&include-certificate=false

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
Optional query parameters
debug Boolean false When true, the response includes ISO 8601 timestamp fields for debugging.
include-certificate Boolean false When true, the response includes the certificate block.

Status 200 application/json

Download schema: certificates.json

Response body:

[
    {
        "status": "PENDING_ACTIVATION",
        "caMode": "AKAMAI",
        "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",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
    },
    {
        "status": "ACTIVATED",
        "caMode": "CUSTOMER",
        "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",
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
    }
]
  1. Run List Configurations to retrieve a specific configId.

  2. Optionally, set the debug query parameter to true to include ISO 8601 timestamp fields for debugging in the response.

  3. Optionally, set the include-certificate query parameter to true to include the certificate block in the response.

  4. Make a GET request to /etp-config/v1/tls/customers/{configId}/certificates{?debug,include-certificate}.

Create a new proxy certificate

Creates a new proxy certificate.

POST /etp-config/v1/tls/customers/{configId}/certificates

Sample: /etp-config/v1/tls/customers/1040/certificates

Content-Type: application/json

Object type: Certificate

Download schema: certificate.json

Request body:

{
    "caMode": "AKAMAI"
}
Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.

Status 201

  1. Run List Configurations to retrieve a specific configId.

  2. Create a Certificate object.

  3. Make a POST request to /etp-config/v1/tls/customers/{configId}/certificates.

Get a proxy certificate

Returns the details of the specified proxy certificate.

GET /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}{?debug,include-certificate}

Sample: /etp-config/v1/tls/customers/1040/certificates/5001?debug=false&include-certificate=false

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.
Optional query parameters
debug Boolean false When true, the response includes ISO 8601 timestamp fields for debugging.
include-certificate Boolean false When true, the response includes the certificate block.

Status 200 application/json

Object type: Certificate

Download schema: certificate.json

Response body:

{
    "status": "PENDING_ACTIVATION",
    "caMode": "AKAMAI",
    "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",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
}
  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Optionally, set the debug query parameter to true to include ISO 8601 timestamp fields for debugging in the response.

  4. Optionally, set the include-certificate query parameter to true to include the certificate block in the response.

  5. Make a GET request to /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}{?debug,include-certificate}.

Modify a proxy certificate

Updates the value of a proxy certificate.

PUT /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}

Sample: /etp-config/v1/tls/customers/1040/certificates/5001

Content-Type: application/json

Object type: Certificate

Download schema: certificate.json

Request body:

{
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
}
Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Create a Certificate object.

  4. Make a PUT request to /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}.

Activate a proxy certificate

Transitions the proxy certificate’s state from PENDING_ACTIVATION to ACTIVE.

POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/activate

Sample: /etp-config/v1/tls/customers/1040/certificates/5001/op/activate

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Make a POST request to /etp-config/v1/tls/customers/{customerId}/certificates/{certificateId}/op/activate.

Deactivate a proxy certificate

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

POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/deactivate

Sample: /etp-config/v1/tls/customers/1040/certificates/5001/op/deactivate

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Make a POST request to /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/deactivate.

Confirm proxy certificate download

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

POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-download

Sample: /etp-config/v1/tls/customers/1040/certificates/5001/op/confirm-download

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Make a POST request to /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-download.

Confirm proxy certificate distribution

Transitions the certificate’s state from PENDING_DISTRIBUTION to PENDING_ACTIVATION. Only perform this operation after distributing the proxy certificates to relevant enterprise devices.

POST /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-distribution

Sample: /etp-config/v1/tls/customers/1040/certificates/5001/op/confirm-distribution

Parameter Type Sample Description
URL path parameters
configId Integer 1040 A unique identifier for the configuration.
certificateId Integer 5001 A unique identifier for the certificate.

Status 200

  1. Run List Configurations to retrieve a specific configId.

  2. Run List Certificates to retrieve a specific certificateId.

  3. Make a POST request to /etp-config/v1/tls/customers/{configId}/certificates/{certificateId}/op/confirm-distribution.

Data

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

Download the JSON schemas for this API.

This section’s data schema tables list membership requirements as follows:

Member is required in requests, or always present in responses, even if its value is empty or null.
Member is optional, and may be omitted in some cases.

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": 2160,
    "name": "Unidentified IPs",
    "description": "IPs not assigned to a configured Location",
    "policyId": 2480,
    "isOffnetworkLocation": false,
    "modifiedDate": "2017-04-25T22:26:15.687+0000",
    "modifiedBy": "internal",
    "createdDate": "2017-04-25T22:26:15.687+0000",
    "createdBy": "internal",
    "bypassSubnets": [
        "125.36.25.15"
    ],
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "deleagtedUser@org.com"
        ]
    },
    "policyInfo": {
        "id": 2480,
        "name": "Default"
    },
    "exitPoints": [
        {
            "ipAddr": "125.25.36.12",
            "addrType": "ADDR_TYPE_IPV4"
        }
    ]
}

Site members

Member Type Required Description
Site: Specifies IP addresses and CIDR blocks of a region or geographic area in your network to compare incoming requests against an assigned policy.
accessConfig Site.accessConfig Provides access config details
bypassExitPoints Site.bypassExitPoints[] Encapsulates data for Site bypass exit points.
bypassSubnets Array The bypass subnet value
createdBy String Read-only. Name of the user who created this site.
createdDate String Read-only. ISO 8601 timestamp marking when this site was created.
description String A description of the site configuration that you provide.
dynamicExitPoints Site.dynamicExitPoints[] Encapsulates data for Site dynamic exit points.
exitPoints Site.exitPoints[] Encapsulates data for Site exit points.
id Integer A unique identifier for each site. Use this value for a siteId parameter in subsequent operations.
isOffnetworkLocation Boolean Indicates if the site is offNetwork location
modifiedBy String Read-only. Name of the user who most recently modified this site
modifiedDate String Read-only. ISO 8601 timestamp marking when this site was last modified.
name String The name of the site configuration.
policyId Integer The unique ID of the related policy.
policyInfo Site.policyInfo Specifies the related policy ETP applies to incoming DNS requests.
Site.accessConfig: Provides access config details
configurable Boolean indicates if site is configurable
delegatedAdmins Array User details of delegated admin
readable Boolean indicates if site is readable
Site.bypassExitPoints[]: Encapsulates data for Site bypass exit points.
addrType Enumeration The type of internet protocol address, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.
ipAddr String The IP address or CIDR block for your company branch or headquarters used to match a policy to a request.
Site.dynamicExitPoints[]: Encapsulates data for Site dynamic exit points.
addrType Enumeration The type of internet protocol address, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.
ipAddr String The IP address or CIDR block for your company branch or headquarters used to match a policy to a request.
Site.exitPoints[]: Encapsulates data for Site exit points.
addrType Enumeration The type of internet protocol address, either ADDR_TYPE_IPV4 or ADDR_TYPE_IPV6.
ipAddr String The IP address or CIDR block for your company branch or headquarters used to match a policy to a request.
Site.policyInfo: Specifies the related policy ETP applies to incoming DNS requests.
id Integer Read-only. The unique ID of the related policy.
name String The name of the related policy.

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": 2480,
    "name": "Default",
    "description": "Default policy",
    "authenticationMode": "NONE",
    "akamaiDefined": true,
    "modifiedDate": "2020-06-25T20:20:33.114+0000",
    "modifiedBy": "panghan",
    "createdDate": "2017-04-25T22:26:15.597+0000",
    "createdBy": "internal",
    "sites": [
        2160,
        18217,
        991731,
        991733
    ],
    "safeSearchSettings": {
        "youtube": "open"
    },
    "riskyFileHandlingSettings": {
        "largeRiskyFileResponse": {
            "id": 5,
            "name": "Allow"
        },
        "hugeRiskyFileResponse": {
            "id": 5,
            "name": "Allow"
        }
    },
    "policyGeneralSettings": {
        "aupMigrated": true
    },
    "ipaSettings": {
        "zdp": false,
        "enabled": false,
        "randomCheck": false
    },
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "delegatedAdmin@org.com"
        ]
    },
    "basicSettings": {
        "dnssec": false,
        "trustXFF": false,
        "proxyEnabled": false,
        "forwardProxyEnabled": false,
        "safesearch": false,
        "edns0ecs": true
    },
    "securitySettings": [
        {
            "shouldNotifySuspected": true,
            "shouldNotifyConfirmed": true,
            "suspectedResponseId": 760,
            "confirmedResponseId": 760,
            "listId": 1,
            "suspectedResponseInfo": {
                "id": 760,
                "name": "Sinkhole 1"
            },
            "confirmedResponseInfo": {
                "id": 760,
                "name": "Sinkhole 1"
            },
            "listInfo": {
                "id": 1,
                "name": "Malware",
                "categoryId": 1
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 5601,
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "listInfo": {
                "id": 5601,
                "name": "luis list",
                "categoryId": 1
            }
        }
    ],
    "aupSettings": [
        {
            "responseId": 5,
            "categoryId": 1,
            "users": [
                "usr1@org.com",
                "user2@org.com"
            ],
            "groups": [
                "GroupName1"
            ],
            "categoryInfo": {
                "id": 1,
                "name": "Social",
                "code": "AKA-SOCIAL",
                "deprecated": false,
                "defaultActionId": 5
            },
            "responseInfo": {
                "id": 5,
                "name": "Allow"
            },
            "responseOverrides": [
                {
                    "id": 4,
                    "name": "Block"
                }
            ]
        }
    ],
    "sitesInfo": [
        {
            "id": 2160,
            "name": "Unidentified IPs"
        },
        {
            "id": 18217,
            "name": "DDNS"
        },
        {
            "id": 991731,
            "name": "aasdfsadfdsa"
        },
        {
            "id": 991733,
            "name": "Test11adakjsdhfkjaslhdfkjlashldfkljashdfjashdfasdfasdfsakjhasjkdfhkaljshdfkljhasfadfasfdasdfasdfsadf"
        }
    ]
}

Policy members

Member Type Required Description
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.
accessConfig Policy.accessConfig Provides access configuration details.
akamaiDefined Boolean Whether a policy is defined by Akamai.
aupSettings Policy.aupSettings[] Contains the acceptable use policy settings.
aupSource String Name of acceptable use policy source associated with the policy.
authenticationMode Enumeration Specifies the authentication mode. Either NONE, OPTIONAL, or REQUIRED.
authPolicy Policy.authPolicy Details of the authorization policy adopted for the policy.
basicSettings Policy.basicSettings Contains the basic policy settings.
classifiers Policy.classifiers Provides classifier details associated with a policy.
createdBy String Read-only. Name of the user who created this policy.
createdDate String Read-only. ISO 8601 timestamp marking when this policy was created.
description String A description of the policy that you provide.
dlpSettings Policy.dlpSettings[] List of Data Leak Prevention (DLP) actions and details
farmId Integer A unique identifier for policy’s farm.
id Integer A unique identifier for each policy. Use this value for a policyId parameter in subsequent operations.
idpId String A unique identifier for the associated identity provider.
ipaSettings Policy.ipaSettings Contains IPA settings.
modifiedBy String Read-only. Name of the user who most recently modified this policy.
modifiedDate String Read-only. ISO 8601 timestamp marking when this policy was last modified.
name String The name of the policy.
originPorts Array A list of origin ports for a policy.
originValidationFailActionId Integer A unique identifier for a validation fail action.
policyGeneralSettings Policy.policyGeneralSettings Specifies the policy’s general settings.
proxyHostname String Name of proxy host machine.
riskyFileHandlingSettings Policy.riskyFileHandlingSettings Describes file handling settings.
safeSearchSettings Policy.safeSearchSettings Contains safe search settings.
securitySettings Policy.securitySettings[] Contains the policy security settings.
sites Array Encapsulates associated site IDs.
sitesInfo Policy.sitesInfo[] Encapsulates data of an associated site.
trafficLogging Policy.trafficLogging Provides details of traffic logging in different modes.
Policy.accessConfig: Provides access configuration details.
configurable Boolean Whether a policy is configurable.
delegatedAdmins Array A list of delegated administrators for the policy.
readable Boolean Whether policy is readable.
Policy.aupSettings[]: Contains the acceptable use policy settings.
categoryId Integer A unique identifier for the category.
categoryInfo Policy.aupSettings[].categoryInfo Encapsulates data for a category.
groups Array The name of the group.
responseId Integer A unique identifier for the response.
responseInfo Policy.aupSettings[].responseInfo Encapsulates data for the response.
responseOverrides Policy.aupSettings[].responseOverrides[] Contains a list of response overrides.
users Array Specifies user emails assigned to the policy.
Policy.aupSettings[].categoryInfo: Encapsulates data for a category.
code String The acceptable use policy categorization code.
defaultActionId Integer The selected default action for the category.
deprecated Boolean Whether the category information is deprecated.
id Integer Read-only. A unique identifier for the category.
name String The name of the category.
Policy.aupSettings[].responseInfo: Encapsulates data for the response.
id Integer Read-only. A unique identifier for the response.
name String The name of the response.
Policy.aupSettings[].responseOverrides[]: Contains a list of response overrides.
id Integer A unique identifier for the response.
name String The name of a response.
Policy.authPolicy: Details of the authorization policy adopted for the policy.
enabled Boolean Whether an authorization policy is enabled for the policy.
id Integer A unique identifier for the authorization policy.
idpPreAuthConsent Boolean Whether pre-authorization was processed for the associated IDP.
Oidc Policy.authPolicy.Oidc Provides OIDC provider and client details.
qllowUnauthenticated Boolean Whether unauthenticated users are allowed.
retryAuthForUnauthenticatedSessions Integer The number of retries for unauthenticated session.
sessionTtl Integer The duration of a session.
userInfoRefreshTime Integer Timestamp representing the user refresh time.
Policy.authPolicy.Oidc: Provides OIDC provider and client details.
client Policy.authPolicy.Oidc.client Provides information about a client.
provider Policy.authPolicy.Oidc.provider Mapping of authorization policy URLs with OIDC URLs.
Policy.authPolicy.Oidc.client: Provides information about a client.
authUri String URL for authorization.
checkSessionUri String URL to check if session is alive.
clientId Integer A unique identifier for the client.
clientName String Name of the client.
endSessionUri String URL for ending session.
frontChannelLogoutUrl Array List of URLs for logout from front channel.
grantTypes Array List of grant types associated with client.
idpId String A unique identifier for the IDP associated with the OIDC.
javascriptOrigins Array List of locations for JavaScript origins.
postLogoutUris Array List of uris for post logout from client.
redirectUris Array List of URIs for redirection.
tokenUri String URL for token.
userUri String URL for user information.
Policy.authPolicy.Oidc.provider: Mapping of authorization policy URLs with OIDC URLs.
authPolicyUrl String The URL from the authorization policy
oidcUrl String The URL associated with OIDC.
Policy.basicSettings: Contains the basic policy settings.
dnssec Boolean Indicates if dns security is enabled.
edns0ecs Boolean When enabled, optimizes CDN traffic using the EDNS-Client-Subnet extension.
forwardProxyEnabled Boolean Indicates if forward proxy is enabled.
proxyEnabled Boolean Indicates if proxy is enabled.
safesearch Boolean Indicates if safesearch feature is enabled.
trustXFF Boolean Indicates if trustXFF protocol is enabled.
Policy.classifiers: Provides classifier details associated with a policy.
dynamicAnalysisEnabled Boolean Whether dynamic analysis is enabled for a classifier.
enabled Boolean Whether the classifier is enabled.
name String Name of the classifier.
sizeExceedingAction Integer The size exceeded action.
zdpEnabled Boolean Whether Zero-Day Phishing (ZDP) is enabled for a classifier.
Policy.dlpSettings[]: List of Data Leak Prevention (DLP) actions and details
action Integer Action ID associated with Data Leak Prevention (DLP).
dictionaryId Integer A unique identifier for the dictionary.
dictionaryName String Name of dictionary.
dictionarySource String Name of dictionary source.
patterns Array Pattern identifier.
threshold Integer The maximum number of patterns that are considered.
Policy.ipaSettings: Contains IPA settings.
enabled Boolean Whether IPA is enabled.
randomCheck Boolean Whether random check for ipaSettings is enabled.
zdp Boolean Whether Zero-Day Phishing (ZDP) is enabled.
Policy.policyGeneralSettings: Specifies the policy’s general settings.
aupMigrated Boolean Whether acceptable use policy is migrated.
blockBrokenTLS Boolean Whether TLS is blocked.
bypassO365 Boolean Whether Microsoft office 365 traffic is bypassed.
dotConfig Policy.policyGeneralSettings.dotConfig Contains DNS over TLS (DoT) configuration.
httpProxyOverride Integer Represents HTTP proxy override priority.
proxyAuthEnabled Boolean Whether proxy authentication is enabled.
Policy.policyGeneralSettings.dotConfig: Contains DNS over TLS (DoT) configuration.
mode Enumeration The DNS over TLS (DoT) mode. Use ATTEMPT to always attempt to use DoT and fall back to standard DNS when unavailable. Use REQUIRED to indicate that DoT is required and inform the client the device is not protected. Use DISABLED to ensure DoT is not used to secure DNS traffic.
port Integer The assigned port for dotConfig.
Policy.riskyFileHandlingSettings: Describes file handling settings.
hugeRiskyFileResponse Policy.riskyFileHandlingSettings.hugeRiskyFileResponse Specifies the file response for huge risky files
largeRiskyFileResponse Policy.riskyFileHandlingSettings.largeRiskyFileResponse Specifies the file response for large risky files.
Policy.riskyFileHandlingSettings.hugeRiskyFileResponse: Specifies the file response for huge risky files
id Integer A unique identifier for the response.
name String The name of the response.
Policy.riskyFileHandlingSettings.largeRiskyFileResponse: Specifies the file response for large risky files.
id Integer A unique identifier for the response.
name String The name of the response.
Policy.safeSearchSettings: Contains safe search settings.
youtube Enumeration Specifies the YouTube access policy. Either open, moderate, or strict.
Policy.securitySettings[]: Contains the policy security settings.
confirmedResponseId Integer A unique identifier for the confirmed response.
confirmedResponseInfo Policy.securitySettings[].confirmedResponseInfo Encapsulates data about the confirmed response.
listId Integer A unique identifier for the list.
listInfo Policy.securitySettings[].listInfo Encapsulates data about the list.
shouldNotifyConfirmed Boolean Send alert on confirmed list hit.
shouldNotifySuspected Boolean Send alert on suspected list hit.
suspectedResponseId Integer A unique identifier for the suspected response.
suspectedResponseInfo Policy.securitySettings[].suspectedResponseInfo Encapsulates data about the suspected response.
Policy.securitySettings[].confirmedResponseInfo: Encapsulates data about the confirmed response.
id Integer Read-only. A unique identifier for the confirmed response.
name String The name of the confirmed response.
Policy.securitySettings[].listInfo: Encapsulates data about the list.
id Integer Read-only. A unique identifier for the list.
name String The name of the list.
Policy.securitySettings[].suspectedResponseInfo: Encapsulates data about the suspected response.
id Integer Read-only. A unique identifier for the suspected response.
name String The name of the suspected response.
Policy.sitesInfo[]: Encapsulates data of an associated site.
id Integer Read-only. A unique identifier for the site.
name String The name of the site.
Policy.trafficLogging: Provides details of traffic logging in different modes.
headers Policy.trafficLogging.headers Contains header information for traffic.
mode Enumeration The traffic logging mode. Either full, url, path, or host.
url Policy.trafficLogging.url URL details of the traffic.
Policy.trafficLogging.headers: Contains header information for traffic.
request Policy.trafficLogging.headers.request The request details in the header.
response Policy.trafficLogging.headers.response The response details in the header.
Policy.trafficLogging.headers.request: The request details in the header.
mode Enumeration Request mode in headers. Either FULL, FILTER, or CLEAR.
whiteList Array A list of header values that are allow listed.
Policy.trafficLogging.headers.response: The response details in the header.
mode Enumeration Response mode in headers. Either FULL, FILTER, or CLEAR.
whiteList Array A list of headers values that are allow listed.
Policy.trafficLogging.url: URL details of the traffic.
mode Enumeration The URL mode used for traffic logging. Either FULL, PATH, or HOST.

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": 3785,
    "name": "Costa Rica WB",
    "description": "Costa Rica WB",
    "itemCount": 6,
    "securityCategoryId": 1,
    "allowedForDnsPolicy": true,
    "modifiedDate": "2020-06-10T20:39:04.386+0000",
    "modifiedBy": "panghan",
    "createdDate": "2017-06-27T21:07:20.443+0000",
    "createdBy": "hparker",
    "accessConfig": {
        "configurable": true,
        "readable": true,
        "delegatedAdmins": [
            "delegatedUser@org.com"
        ]
    },
    "knownCounts": {
        "domains": 3,
        "ips": 2
    },
    "suspectedCounts": {
        "domains": 1,
        "ips": 0
    },
    "securityCategoryInfo": {
        "id": 1,
        "name": "Malware"
    },
    "policySecuritySettings": [
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 2480,
            "policyName": "Default",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 84715,
            "policyName": "NewPWithD",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": false,
            "shouldNotifyConfirmed": false,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 82602,
            "policyName": "Sample Policy 12",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        },
        {
            "shouldNotifySuspected": true,
            "shouldNotifyConfirmed": true,
            "suspectedResponseId": 1,
            "confirmedResponseId": 1,
            "listId": 3785,
            "policyId": 82601,
            "policyName": "Sample Policy 11",
            "suspectedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            },
            "confirmedResponseInfo": {
                "id": 1,
                "name": "Monitor"
            }
        }
    ]
}

CustomList members

Member Type Required Description
CustomList: This object is a custom a security list of domains and IP addresses, with a set confidence level for each.
accessConfig CustomList.accessConfig Provides access config details
allowedForDnsPolicy Boolean Indicates if list is allowed per dns-policy
createdBy String Read-only. Name of the user who created this list.
createdDate String Read-only. ISO 8601 timestamp marking when this list was created.
description String A description of the list that you provide.
id Integer A unique identifier for each list. Use this value for a listId parameter in subsequent operations.
itemCount Integer The number of entries in a list.
knownCounts CustomList.knownCounts Encapsulates data of known counts.
modifiedBy String Read-only. Name of the user who most recently modified the list.
modifiedDate String Read-only. ISO 8601 timestamp marking when this list was last modified.
name String The name of the list.
policySecuritySettings CustomList.policySecuritySettings[] policy security setting
remainingCount Integer The number of remaining entries for all lists globally.
securityCategoryId Integer A unique identifier for the security category.
securityCategoryInfo CustomList.securityCategoryInfo Encapsulates data about the security category.
suspectedCounts CustomList.suspectedCounts The count of suspected domain entries in the list.
CustomList.accessConfig: Provides access config details
configurable Boolean indicates if list is configurable
delegatedAdmins Array User details of delegated admin
readable Boolean indicates if list is readable
CustomList.knownCounts: Encapsulates data of known counts.
domains Integer The count of known domain entries in the list.
ips Integer The count of known IP addresses in the list.
CustomList.policySecuritySettings[]: policy security setting
confirmedResponseId Integer Unique identifier for confirmed response
confirmedResponseInfo CustomList.policySecuritySettings[].confirmedResponseInfo Encapsulates data about the confirmed response.
listId Integer Unique identifier for the list
policyId Integer unique identifier of the policy
policyName String Name of policy associated with list
shouldNotifyConfirmed Boolean Indicates if list is confirmed list
shouldNotifySuspected Boolean Indicates if suspectedList info is notified
suspectedResponseId Integer Unique identifier for suspected response
suspectedResponseInfo CustomList.policySecuritySettings[].suspectedResponseInfo Encapsulates data about the security response.
CustomList.policySecuritySettings[].confirmedResponseInfo: Encapsulates data about the confirmed response.
id Integer A unique identifier for the confirmedResponseInfo.
name String The name of the confirmedResponseInfo.
CustomList.policySecuritySettings[].suspectedResponseInfo: Encapsulates data about the security response.
id Integer A unique identifier for the suspectedResponseInfo.
name String The name of the suspectedResponseInfo.
CustomList.securityCategoryInfo: Encapsulates data about the security category.
id Integer A unique identifier for the security category.
name String The name of the security category.
CustomList.suspectedCounts: The count of suspected domain entries in the list.
domains Integer The count of suspected domains in the list.
ips Integer The count of suspected IP addresses in the list.

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:

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

EmergencyList members

Member Type Required Description
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.
domains Array Array of data entries. Each element corresponds to a domain.
ipAddrs Array Array of data entries. Each element corresponds to an IP address.
itemCount Integer The total count of entries in the list.
remainingCount Integer Remaining count of entries that you can add to the list.

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

Member Type Required Description
ListItem: This object provides details for a list entry.
confidenceLevelId Enumeration An identifier that corresponds to the confidence level of the list item. A value of 1 signifies a suspected item, while a value of 2 signifies a known item.
type Enumeration Specifies whether the list item is an IP address (LIST_TYPE_IP) or domain (LIST_TYPE_DOMAIN).
value String The IP address or domain of the list item.

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

Member Type Required Description
ListPatch: This object contains items to add or delete when performing a patch operation on a list.
add ListPatch.add[] Contains details of the list item to add in the patch operation.
delete Array An array of Ip Addresses and Domains to delete in the patch operation.
ListPatch.add[]: Contains details of the list item to add in the patch operation.
confidenceLevelId Enumeration An identifier that corresponds to the confidence level of the list item. A value of 1 signifies a suspected item, while a value of 2 signifies a known item.
type Enumeration Specifies whether the list item is an IP address (LIST_TYPE_IP) or domain (LIST_TYPE_DOMAIN).
value String The IP address or domain of the list item.

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

Member Type Required Description
ListQuota: This object returns the global count of entries in all lists and the remaining entries available to provision.
count Number The total number of list items currently in your configuration.
remainingCount Number The remaining number of list items that you can add to your configuration.

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": 760,
    "name": "Sinkhole 1",
    "description": "Custom Response",
    "modifiedDate": "2020-05-12T18:42:50.716+0000",
    "modifiedBy": "unknown",
    "createdDate": "2017-07-18T16:20:49.967+0000",
    "createdBy": "hparker",
    "ipv4Addrs": [
        "202.22.33.33"
    ],
    "ipv6Addrs": [
        "2019:D30::88/124",
        "2021:D32::88/124"
    ],
    "aliases": [
        "abcd.com"
    ],
    "policies": [
        {
            "id": 2480,
            "name": "Default"
        }
    ]
}

Honeypot members

Member Type Required Description
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.
aliases Array Alias Name of honeypot
createdBy String Read-only. Name of the user who created this honeypot.
createdDate String Read-only. ISO 8601 timestamp marking when this honeypot was created.
description String The description of the Honeypot.
id Integer A unique identifier for each honeypot. Use this value for a honeypotId parameter in subsequent operations.
ipv4Addrs Array An array of data entries. Each element corresponds to an IPv4 address of a target device.
ipv6Addrs Array An array of data entries. Each element corresponds to an IPv6 address of a target device.
modifiedBy String Read-only. Name of the user who most recently modified this honeypot
modifiedDate String Read-only. ISO 8601 timestamp marking when this honeypot was last modified.
name String The name of the Honeypot.
policies Honeypot.policies[] Policy details associated with honeypot
Honeypot.policies[]: Policy details associated with honeypot
id Integer A unique identifier for each policy.
name String The name of the policy.

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

Member Type Required Description
ListDeployment: Encapsulates data describing the status and details of a list configuration deployment.
deployedBy String The user who created the deployment.
endTime String Read-only. The end time of the deployment in ISO 8601 format.
id Integer A unique identifier for each list deployment. Use this value for a listDeploymentId parameter in subsequent operations.
message String The status message, in cases where failure of deployment occurs.
startTime String Read-only. The start time of the deployment in ISO 8601 format.
status Enumeration The status of list deployment, either PENDING, RUNNING, COMPLETED, or FAILED.

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

Member Type Required Description
ConfigurationDeployment: Encapsulates data describing the status and details of an ETP configuration deployment.
deployedBy String The user who created the deployment.
endTime String Read-only. The end time of the deployment in ISO 8601 format.
id Integer A unique identifier for each configuration deployment. Use this value for a configDeploymentId parameter in subsequent operations.
message String The status message, in cases where failure of deployment occurs.
progressPct Number The percentage of deployment progress.
startTime String Read-only. The start time of the deployment in ISO 8601 format.
status Enumeration The status of list deployment, either PENDING, RUNNING, COMPLETED, or FAILED.

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

Member Type Required Description
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.
ipv4Addrs DnsConfiguration.ipv4Addrs Encapsulates data about IPv4 DNS configuration.
ipv6Addrs DnsConfiguration.ipv6Addrs Encapsulates data about IPv6 DNS configuration.
DnsConfiguration.ipv4Addrs: Encapsulates data about IPv4 DNS configuration.
primary String Primary IPv4 Address.
secondary String Secondary IPv4 Address.
DnsConfiguration.ipv6Addrs: Encapsulates data about IPv6 DNS configuration.
primary String Primary IPv6 address.
secondary String Secondary IPv6 address.

Certificate

Encapsulates data about a TLS certificate.

Download schema: certificate.json

Sample GET response:

{
    "status": "PENDING_ACTIVATION",
    "caMode": "AKAMAI",
    "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",
    "certificate": "-----BEGIN CERTIFICATE-----\nMIIDpjCCAo6gAwIBAgIIf8Ji8Dm81ko ... TXV0qe8SEF+C5n4=\n-----END CERTIFICATE-----\n"
}

Certificate members

Member Type Required Description
Certificate: Encapsulates data about a TLS certificate.
caMode Enumeration Mode of the certificate, either CUSTOMER or AKAMAI.
certificate String Value of the certificate in PEM format: ASCII, base64-encoded text starting with -----BEGIN CERTIFICATE----- and ending with -----END CERTIFICATE-----.
certificateId Number Read-only. A unique identifier for each certificate.
certificateRequest String Value for the certificate signing request (CSR): ASCII, base64-encoded text starting with -----BEGIN CERTIFICATE REQUEST----- and ending with -----END CERTIFICATE REQUEST-----.
createdBy String Read-only. Name of the user who created this Certificate object.
createdDate String Read-only. ISO 8601 timestamp marking when this Certificate object was created.
expiredDate String Read-only. ISO 8601 timestamp marking when the certificate is set to expire.
fingerprint String Read-only. The certificate’s hexadecimal fingerprint.
issuedDate String Read-only. ISO 8601 timestamp marking when the certificate was issued.
modifiedBy String Read-only. Name of the user who most recently modified this Certificate object. If the object was not modified since first being created, the value matches createdBy.
modifiedDate String Read-only. ISO 8601 timestamp marking when this Certificate object was last modified. If the object was not modified since first being created, the value matches createdDate.
status Enumeration Read-only. Certificate deployment status, either CREATING, INCOMPLETE, UPDATING, PENDING_DOWNLOAD, PENDING_DISTRIBUTION, PENDING_ACTIVATION, ACTIVATING, ACTIVATED, DEACTIVATING, DEACTIVATED, or EXPIRED.

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:

Code Description
200 The operation was successful.
403 Access is forbidden.
404 Resource not found.
406 Not acceptable.
409 Conflict with current state of resource.
412 An Etag or If-Match header does not match, indicating the content has been modified. See Object Versioning for more information.