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
Create a network configurationPOST/configs/​{configId}/​network-configuration
Get the network configurationGET/configs/​{configId}/​network-configuration
Update the network configurationPUT/configs/​{configId}/​network-configuration
Configurations
List configurationsGET/configs/​all
Onboard a contractPOST/configs/​onboard
Create acknowledgment infoPOST/configs/​{configId}/​acknowledgment
Get acknowledgment infoGET/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
Create a proxy credentialPOST/configs/​{configId}/​proxy-credentials
List proxy credentialsGET/configs/​{configId}/​proxy-credentials
List proxy credential detailsGET/configs/​{configId}/​proxy-credentials/​{userName}
Remove a proxy credentialDELETE/configs/​{configId}/​proxy-credentials/​{userName}
Create a VPN credentialPOST/configs/​{configId}/​vpn-credentials
List VPN credentialsGET/configs/​{configId}/​vpn-credentials
Get a VPN credentialGET/configs/​{configId}/​vpn-credentials/​{ikeId}
Delete a VPN credentialDELETE/configs/​{configId}/​vpn-credentials/​{ikeId}
Custom responses
Create a custom responsePOST/configs/​{configId}/​honeypots
List custom responsesGET/configs/​{configId}/​honeypots
Get a custom responseGET/configs/​{configId}/​honeypots/​{honeypotId}
Update a custom responsePUT/configs/​{configId}/​honeypots/​{honeypotId}
Delete a custom responseDELETE/configs/​{configId}/​honeypots/​{honeypotId}
Deployments
Create a configuration deploymentPOST/configs/​{configId}/​deployments
List configuration deploymentsGET/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
Create a DLP dictionaryPOST/configs/​{configId}/​dictionaries
List DLP dictionariesGET/configs/​{configId}/​dictionaries
Get a DLP dictionaryGET/configs/​{configId}/​dictionaries/​{dictionaryId}
Update a DLP dictionaryPUT/configs/​{configId}/​dictionaries/​{dictionaryId}
Remove a DLP dictionaryDELETE/configs/​{configId}/​dictionaries/​{dictionaryId}
Create a DLP patternPOST/configs/​{configId}/​patterns
List DLP dictionary patternsGET/configs/​{configId}/​patterns
Create DLP regexesPOST/configs/​{configId}/​patterns/​regexes/​
List DLP regular expressionsGET/configs/​{configId}/​patterns/​regexes/​
Get a DLP regexGET/configs/​{configId}/​patterns/​regexes/​{regexId}
Get a DLP dictionary patternGET/configs/​{configId}/​patterns/​{patternId}
Delete a DLP dictionary patternDELETE/configs/​{configId}/​patterns/​{patternId}
Lists
List all Akamai built-in security listsGET/akamai-lists
Clear the DNS cachePOST/configs/​{configId}/​clear-dns-cache
Create a listPOST/configs/​{configId}/​lists
List all listsGET/configs/​{configId}/​lists
List global list quotasGET/configs/​{configId}/​lists/​quota
Get details of a listGET/configs/​{configId}/​lists/​{listId}
Update a listPUT/configs/​{configId}/​lists/​{listId}
Remove a listDELETE/configs/​{configId}/​lists/​{listId}
Search in a listGET/configs/​{configId}/​lists/​{listId}/​items
Modify list itemsPUT/configs/​{configId}/​lists/​{listId}/​items
Patch a listPATCH/configs/​{configId}/​lists/​{listId}/​items
Tenant and Delegated Access
Onboard a tenantPOST/configs/​{configId}/​onboard-tenant
List all tenantsGET/configs/​{configId}/​tenants
Get a tenantGET/configs/​{configId}/​tenants/​{tenantId}
Update a tenantPUT/configs/​{configId}/​tenants/​{tenantId}
Remove a tenantDELETE/configs/​{configId}/​tenants/​{tenantId}
List the tenant user detailsGET/configs/​{configId}/​tenants/​{tenantId}/​users
Notifications
Create notifications configsPOST/configs/​{configId}/​notifications-config
Get notification configurationGET/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
Create a policyPOST/configs/​{configId}/​policies
List policiesGET/configs/​{configId}/​policies
Get a policyGET/configs/​{configId}/​policies/​{policyId}
Update a policyPUT/configs/​{configId}/​policies/​{policyId}
Remove a policyDELETE/configs/​{configId}/​policies/​{policyId}
List policy metadataGET/configs/​{configId}/​policy-metadata
List built-in responsesGET/responses
List security category predefined configurationsGET/securityCategories
Security connectors
Create a security connectorPOST/configs/​{configId}/​akamai-sinkholes
List security connectorsGET/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
Get a security connectorGET/configs/​{configId}/​akamai-sinkholes/​{sinkholeId}
Delete a security connectorDELETE/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
Create a sitePOST/configs/​{configId}/​sites
List sitesGET/configs/​{configId}/​sites
Get site meta infoGET/configs/​{configId}/​sites-meta-info
Get a siteGET/configs/​{configId}/​sites/​{siteId}
Update a sitePUT/configs/​{configId}/​sites/​{siteId}
Remove a siteDELETE/configs/​{configId}/​sites/​{siteId}
Create a sublocationPOST/configs/​{configId}/​sites/​{siteId}/​sub-locations
List sublocationsGET/configs/​{configId}/​sites/​{siteId}/​sub-locations
Get a sublocationGET/configs/​{configId}/​sites/​{siteId}/​sub-locations/​{subLocationId}
Update a sublocationPUT/configs/​{configId}/​sites/​{siteId}/​sub-locations/​{subLocationId}
Remove a sublocationDELETE/configs/​{configId}/​sites/​{siteId}/​sub-locations/​{subLocationId}
Assign a policy to a sublocationPOST/configs/​{configId}/​sites/​{siteId}/​sub-locations/​{subLocationId}/​op/​assign-policy
Certificates
Create a new proxy certificatePOST/customers/​{configId}/​certificates
List proxy certificatesGET/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