API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
Client Configurations
Get client configurationGET/configs/‚Äč{configId}/‚Äčclient-configuration
Update client configurationPUT/configs/‚Äč{configId}/‚Äčclient-configuration
List client versionsGET/configs/‚Äč{configId}/‚Äčclient-versions
Rotate client version entitlement codePOST/configs/‚Äč{configId}/‚Äčclient-versions/‚Äčop/‚Äčrotate-entitlement-code
Updates the client version detailsPUT/configs/‚Äč{configId}/‚Äčclient-versions/‚Äč{clientVersionId}
Download client version detailsGET/configs/‚Äč{configId}/‚Äčclient-versions/‚Äč{clientVersionId}/‚Äčdownload
List client devicesGET/configs/‚Äč{configId}/‚Äčclient/‚Äčdevices
Deactivate a client devicePOST/configs/‚Äč{configId}/‚Äčclient/‚Äčdevices/‚Äč{deviceId}/‚Äčop/‚Äčde-activate
Re-activate a client devicePOST/configs/‚Äč{configId}/‚Äčclient/‚Äčdevices/‚Äč{deviceId}/‚Äčop/‚Äčre-activate
Get client statusGET/configs/‚Äč{configId}/‚Äčclient/‚Äčstatus
Get the network configurationGET/configs/‚Äč{configId}/‚Äčnetwork-configuration
Create a network configurationPOST/configs/‚Äč{configId}/‚Äčnetwork-configuration
Update the network configurationPUT/configs/‚Äč{configId}/‚Äčnetwork-configuration
Configurations
List configurationsGET/configs/‚Äčall
Onboard a contractPOST/configs/‚Äčonboard
Get acknowledgment infoGET/configs/‚Äč{configId}/‚Äčacknowledgment
Create acknowledgment infoPOST/configs/‚Äč{configId}/‚Äčacknowledgment
Get a custom error pageGET/configs/‚Äč{configId}/‚Äčcustom-error-page
Update the custom error pagePUT/configs/‚Äč{configId}/‚Äčcustom-error-page
Get the first time wizard stateGET/configs/‚Äč{configId}/‚ÄčfirstTimeWizard
Update first time wizardPUT/configs/‚Äč{configId}/‚ÄčfirstTimeWizard
Connection Credentials
List proxy credentialsGET/configs/‚Äč{configId}/‚Äčproxy-credentials
Create a proxy credentialPOST/configs/‚Äč{configId}/‚Äčproxy-credentials
Remove a proxy credentialDELETE/configs/‚Äč{configId}/‚Äčproxy-credentials/‚Äč{userName}
List proxy credential detailsGET/configs/‚Äč{configId}/‚Äčproxy-credentials/‚Äč{userName}
List VPN credentialsGET/configs/‚Äč{configId}/‚Äčvpn-credentials
Create a VPN credentialPOST/configs/‚Äč{configId}/‚Äčvpn-credentials
Delete a VPN credentialDELETE/configs/‚Äč{configId}/‚Äčvpn-credentials/‚Äč{ikeId}
Get a VPN credentialGET/configs/‚Äč{configId}/‚Äčvpn-credentials/‚Äč{ikeId}
Custom responses
List custom responsesGET/configs/‚Äč{configId}/‚Äčhoneypots
Create a custom responsePOST/configs/‚Äč{configId}/‚Äčhoneypots
Delete a custom responseDELETE/configs/‚Äč{configId}/‚Äčhoneypots/‚Äč{honeypotId}
Get a custom responseGET/configs/‚Äč{configId}/‚Äčhoneypots/‚Äč{honeypotId}
Update a custom responsePUT/configs/‚Äč{configId}/‚Äčhoneypots/‚Äč{honeypotId}
Deployments
List configuration deploymentsGET/configs/‚Äč{configId}/‚Äčdeployments
Create a configuration deploymentPOST/configs/‚Äč{configId}/‚Äčdeployments
Get a configuration deploymentGET/configs/‚Äč{configId}/‚Äčdeployments/‚Äč{configDeploymentId}
List deployment changesGET/configs/‚Äč{configId}/‚Äčdeployments/‚Äč{configDeploymentId}/‚Äčdiff
List recent changesGET/configs/‚Äč{configId}/‚ÄčrecentChanges
Data Loss Prevention Dictionary
List DLP dictionariesGET/configs/‚Äč{configId}/‚Äčdictionaries
Create a DLP dictionaryPOST/configs/‚Äč{configId}/‚Äčdictionaries
Remove a DLP dictionaryDELETE/configs/‚Äč{configId}/‚Äčdictionaries/‚Äč{dictionaryId}
Get a DLP dictionaryGET/configs/‚Äč{configId}/‚Äčdictionaries/‚Äč{dictionaryId}
Update a DLP dictionaryPUT/configs/‚Äč{configId}/‚Äčdictionaries/‚Äč{dictionaryId}
List DLP dictionary patternsGET/configs/‚Äč{configId}/‚Äčpatterns
Create a DLP patternPOST/configs/‚Äč{configId}/‚Äčpatterns
List DLP regular expressionsGET/configs/‚Äč{configId}/‚Äčpatterns/‚Äčregexes
Create DLP regexesPOST/configs/‚Äč{configId}/‚Äčpatterns/‚Äčregexes
Get a DLP regexGET/configs/‚Äč{configId}/‚Äčpatterns/‚Äčregexes/‚Äč{regexId}
Delete a DLP dictionary patternDELETE/configs/‚Äč{configId}/‚Äčpatterns/‚Äč{patternId}
Get a DLP dictionary patternGET/configs/‚Äč{configId}/‚Äčpatterns/‚Äč{patternId}
Lists
List all Akamai built-in security listsGET/akamai-lists
Clear the DNS cachePOST/configs/‚Äč{configId}/‚Äčclear-dns-cache
List all listsGET/configs/‚Äč{configId}/‚Äčlists
Create a listPOST/configs/‚Äč{configId}/‚Äčlists
List global list quotasGET/configs/‚Äč{configId}/‚Äčlists/‚Äčquota
Remove a listDELETE/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}
Get details of a listGET/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}
Update a listPUT/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}
Search in a listGET/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}/‚Äčitems
Patch a listPATCH/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}/‚Äčitems
Modify list itemsPUT/configs/‚Äč{configId}/‚Äčlists/‚Äč{listId}/‚Äčitems
Tenant and Delegated Access
Onboard a tenantPOST/configs/‚Äč{configId}/‚Äčonboard-tenant
List all tenantsGET/configs/‚Äč{configId}/‚Äčtenants
Remove a tenantDELETE/configs/‚Äč{configId}/‚Äčtenants/‚Äč{tenantId}
Get a tenantGET/configs/‚Äč{configId}/‚Äčtenants/‚Äč{tenantId}
Update a tenantPUT/configs/‚Äč{configId}/‚Äčtenants/‚Äč{tenantId}
List the tenant user detailsGET/configs/‚Äč{configId}/‚Äčtenants/‚Äč{tenantId}/‚Äčusers
Notifications
Get notification configurationGET/configs/‚Äč{configId}/‚Äčnotifications-config
Create notifications configsPOST/configs/‚Äč{configId}/‚Äčnotifications-config
Update the notifications configsPUT/configs/‚Äč{configId}/‚Äčnotifications-config
Get notification configuration for typeGET/configs/‚Äč{configId}/‚Äčnotifications-config/‚Äč{notificationType}
Update the subscribers to notification typePUT/configs/‚Äč{configId}/‚Äčnotifications-config/‚Äč{notificationType}
Policies
List policiesGET/configs/‚Äč{configId}/‚Äčpolicies
Create a policyPOST/configs/‚Äč{configId}/‚Äčpolicies
Remove a policyDELETE/configs/‚Äč{configId}/‚Äčpolicies/‚Äč{policyId}
Get a policyGET/configs/‚Äč{configId}/‚Äčpolicies/‚Äč{policyId}
Update a policyPUT/configs/‚Äč{configId}/‚Äčpolicies/‚Äč{policyId}
List policy metadataGET/configs/‚Äč{configId}/‚Äčpolicy-metadata
List built-in responsesGET/responses
List security category predefined configurationsGET/securityCategories
Security connectors
List security connectorsGET/configs/‚Äč{configId}/‚Äčakamai-sinkholes
Create a security connectorPOST/configs/‚Äč{configId}/‚Äčakamai-sinkholes
List the current security connector versionsGET/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äčlatest-version
Get the security connector's latest available versionGET/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äčsc-latest-versions
Delete a security connectorDELETE/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}
Get a security connectorGET/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}
Change local security connector passwordPOST/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}/‚Äčop/‚Äčchange-local-password
Generate activation code for a security connectorPOST/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}/‚Äčop/‚Äčgenerate-activation-code
Upgrade a security connectorPOST/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}/‚Äčop/‚Äčupgrade
Update a security connectorPUT/configs/‚Äč{configId}/‚Äčakamai-sinkholes/‚Äč{sinkholeId}/‚Äčpolicy-assignment
Sites
List DNS-VIPsGET/configs/‚Äč{configId}/‚Äčdns-vips
List global settingsGET/configs/‚Äč{configId}/‚Äčglobal-settings
Update global settingsPUT/configs/‚Äč{configId}/‚Äčglobal-settings
List sitesGET/configs/‚Äč{configId}/‚Äčsites
Create a sitePOST/configs/‚Äč{configId}/‚Äčsites
Get site meta infoGET/configs/‚Äč{configId}/‚Äčsites-meta-info
Remove a siteDELETE/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}
Get a siteGET/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}
Update a sitePUT/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}
List sublocationsGET/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations
Create a sublocationPOST/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations
Remove a sublocationDELETE/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations/‚Äč{subLocationId}
Get a sublocationGET/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations/‚Äč{subLocationId}
Update a sublocationPUT/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations/‚Äč{subLocationId}
Assign a policy to a sublocationPOST/configs/‚Äč{configId}/‚Äčsites/‚Äč{siteId}/‚Äčsub-locations/‚Äč{subLocationId}/‚Äčop/‚Äčassign-policy
Certificates
List proxy certificatesGET/customers/‚Äč{configId}/‚Äčcertificates
Create a new proxy certificatePOST/customers/‚Äč{configId}/‚Äčcertificates
Get a proxy certificateGET/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}
Modify a proxy certificatePUT/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}
Activate a proxy certificatePOST/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}/‚Äčop/‚Äčactivate
Confirm proxy certificate distributionPOST/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}/‚Äčop/‚Äčconfirm-distribution
Confirm proxy certificate downloadPOST/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}/‚Äčop/‚Äčconfirm-download
Deactivate a proxy certificatePOST/customers/‚Äč{configId}/‚Äčcertificates/‚Äč{certificateId}/‚Äčop/‚Äčdeactivate