Qodex.ai
Qodex.ai
Introduction
Invoicing API v4
Invoices
List invoices and credit memos for a contractDownload an invoice or a credit memo fileList invoices and credit memos for an account
Notifications
Create a notificationList notifications for an accountGet a notificationModify a notificationRemove a notification
DataStream 2 API v2
Groups
List groups
Properties
List properties by group
Data sets
List data set fields
Streams
Create a streamList streamsView upload metricsGet a streamEdit a streamPatch a streamDelete a stream
Activations
Activate a streamView activation historyDeactivate a stream
History
View history
Edge Hostnames API
Localization data
Get localization data
Products
List products
Certificates
Get a certificate
Edge hostnames
Get an edge hostname by DNS zone and record namePatch an edge hostnameDelete an edge hostnameList edge hostnamesGet an edge hostname
Change requests
List change requestsGet a change requestList change requests per edge hostname
Cloud Access Manager API
Access key creation status
Get the status of an access key
Access key version status requests
Get the status of an access key version
Access keys
Create an access keyList access keysGet an access keyUpdate an access keyDelete an access key
Access key versions
Create an access key versionList access key versionsGet an access key versionDelete an access key version
Access key version properties
Look up propertiesGet an ID for an asynchronous property lookup request
Property lookups
Perform a property lookup request asynchronously
Event Viewer API
Event types
List event types
Events
List events
Secure Internet Access Enterprise Configuration API v3
Client configuration
Get client configurationUpdate client configuration
Client versions
List client versionsRotate client version entitlement codeUpdates the client version detailsDownload client version details
Client devices
List client devicesDeactivate a client deviceRe-activate a client deviceGet client status
Client network configurations
Create a network configurationGet the network configurationUpdate the network configuration
Configurations
List configurationsOnboard a contract
Acknowledgments
Create acknowledgment infoGet acknowledgment info
Custom error pages
Get a custom error pageUpdate the custom error page
Configuration wizard
Get the first time wizard stateUpdate first time wizard
VPN credentials
Create a VPN credentialList VPN credentialsGet a VPN credentialDelete a VPN credential
Proxy credentials
Create a proxy credentialList proxy credentialsList proxy credential detailsRemove a proxy credential
Custom responses
Create a custom responseList custom responsesGet a custom responseUpdate a custom responseDelete a custom response
Deployment configuration
Create a configuration deploymentList configuration deploymentsGet a configuration deployment
Deployment changes
List deployment changesList recent changes
DLP dictionaries
Create a DLP dictionaryList DLP dictionariesGet a DLP dictionaryUpdate a DLP dictionaryRemove a DLP dictionary
DLP dictionary patterns
Create a DLP patternList DLP dictionary patternsGet a DLP dictionary patternDelete a DLP dictionary pattern
DLP regexes
Create DLP regexesList DLP regular expressionsGet a DLP regex
Lists
Create a listList all listsList global list quotasGet details of a listUpdate a listRemove a listSearch in a listModify list itemsPatch a list
Akamai built-in security lists
List all Akamai built-in security lists
DNS cache
Clear the DNS cache
Notifications
Create notifications configsGet notification configurationUpdate the notifications configsGet notification configuration for typeUpdate the subscribers to notification type
Policies
Create a policyList policiesGet a policyUpdate a policyRemove a policyList policy metadata
Policy built-in responses
List built-in responses
Policy predefined security categories
List security category predefined configurations
Security connectors
Create a security connectorList security connectorsList the current security connector versionsGet the security connector's latest available versionGet a security connectorDelete a security connectorChange local security connector passwordGenerate activation code for a security connectorUpgrade a security connectorUpdate a security connector
DNS VIPs
List DNS VIPs
Global settings
List global settingsUpdate global settings
Sites
Create a siteList sitesGet site meta infoGet a siteUpdate a siteRemove a site
Proxy certificates
Create a new proxy certificateList proxy certificatesGet a proxy certificateModify a proxy certificateActivate a proxy certificateConfirm proxy certificate distributionConfirm proxy certificate downloadDeactivate a proxy certificate
Tenants
Onboard a tenantList all tenantsGet a tenantUpdate a tenantRemove a tenantList the tenant user details
Sublocations
Create a sublocationList sublocationsGet a sublocationUpdate a sublocationRemove a sublocationAssign a policy to a sublocation
Contract API
Contracts
List contracts
Products
List products per contractList products per reporting group
Reporting groups
List CP code reporting groupsList CP code reporting group IDs
Script Management API
Insights
Get insights
Policies
Create a policyGet a policy
Edge Compute APIs
EdgeWorkers API-Contracts
List contract IDs
EdgeWorkers API-Permission groups
List permission groupsGet a permission group
EdgeWorkers API-EdgeWorker IDs
Create a new EdgeWorker IDList EdgeWorker IDsGet an EdgeWorker IDUpdate an EdgeWorker IDDelete an EdgeWorker IDClone an EdgeWorker IDGet the resource tier
EdgeWorkers API-Versions
Create a new versionList versionsGet version detailsDelete versionDownload an EdgeWorkers code bundle
EdgeWorkers API-Activations
Activate an EdgeWorker versionList activationsRoll back to the previous active EdgeWorker versionGet an activationCancel an activation
EdgeWorkers API-Deactivations
Deactivate an EdgeWorker versionList deactivationsGet a deactivation
EdgeWorkers API-Properties
List properties
EdgeWorkers API-Revisions
List revisionsActivate a fallback revisionList revision activationsGet a revisionGet a revision BOMCompare revisionsDownload the combined code bundlePin an active revisionUnpin an active revision
EdgeWorkers API-Limits
List limits
EdgeWorkers API-Reports
List reportsGet an EdgeWorker report
EdgeWorkers API-Resource tiers
List resource tiers
EdgeWorkers API-Secure tokens
Create a secure tokenGet a secure token
EdgeWorkers API-Validations
Validate an EdgeWorkers code bundle
EdgeKV API-Permission groups
List permission groupsGet a permission group
EdgeKV API-Namespaces
Modify the default data access policyReauthorize a namespaceCreate a namespaceList namespacesGet namespace detailsUpdate namespace detailsList groups within a namespace
EdgeKV API-EdgeKV status
Get the EdgeKV initialization statusInitialize EdgeKV
EdgeKV API-Items
List items within a groupRead an itemWrite an itemDelete an item
EdgeKV API-Access tokens
Create an access tokenList access tokensDownload an access tokenRevoke an access token
Edge DNS API v2
Create requests
Submit a bulk proxy zone create requestGet a bulk proxy zone create results for a proxyCheck bulk proxy zone create statusGet a bulk proxy zone create resultSubmit a bulk zone create requestCheck bulk zone create statusGet bulk zone create results
Delete requests
Submit a bulk proxy zone delete requestGet all bulk proxy zone delete resultsCheck bulk proxy zone delete statusGet a bulk proxy zone delete resultSubmit a bulk zone delete requestCheck bulk zone delete statusGet bulk zone delete results
Change lists
Create a change listList user's change listsSearch for change listsGet a change listDelete a change listShow changesList record set names for a change listSubmit a change list
Types
List record set types for name and change listGet a record set for a change listList record set types for name and zone
Record sets
Upload a master zone file to a change listList record sets for a change listModify record set for a change listCreate a record setGet a record setReplace a record setDelete a record setCreate record setsGet a zone's record setsReplace record sets
Change list settings
Get change list settingsUpdate change list settings
Authorities
List authoritative name servers
Contracts
List contracts
DNSSEC algorithms
List DNSSEC algorithms
Edge hostnames
List edge hostnames
Groups
List groups
TSIG key algorithms
List TSIG key algorithms
DNS proxies
Create a proxyList proxiesList valid proxy health check record set typesGet a proxyUpdate a proxy
Proxy zones
List proxy zonesList proxy zone keysGet a proxy zone by nameGet a proxy zone TSIG key by nameUpdate a proxy zone TSIG key by nameDelete a proxy zone TSIG key by nameGet proxy zones for a TSIG keyGet a manual filter reportManage manual filter namesInitialize manual filter names with a zone file
Proxy zones filter mode conversion
Convert a proxy zone filter mode to allConvert a proxy zone filter mode to automaticConvert a proxy zone filter mode to manualConvert a proxy zone filter mode to none
Names
List record set names for a zone
Master zone file
Upload a master zone fileGet a master zone file
TSIG keys
List TSIG keysUpdate a TSIG key across zonesList zones using TSIG keyList of zones to contract using TSIG keyGet a zone's TSIG keyUpdate a zone's TSIG keyDelete a zone's TSIG keyList users of a zone's TSIG key
Versions
List a zone's versionsShow zone version differencesGet a zone versionGet a version's record setsReactivate a version
Zone file
Get a version's master zone file
Zones
Create a zoneList zonesGet a zone's settingsUpdate a zone's settingsGet a zone's aliases
DNSSEC status
Get a zone's DNSSEC status
Zone transfer status
Get secondary zones transfer status
Zone contracts
Get a zone's contract
Record types
List record types
Reporting API v2
Report list
List reportsList reports per product familyList reports per reporting area
Report metadata
Get report options
Report data
Generate a reportGet asynchronous report results
Single Sign-On Configuration API
Certificates
Add a certificateList certificatesRemove a certificate
Identity and Access Management API v3
Groups
List groupsCreate a new groupGet a groupModify a group's nameDelete a group
Move groups
Move a groupList users affected by moving a group
Assets
List properties or includesGet a property or includeMove a property or includeList users for property or includeBlock users from a property or include
Resources
Get asset's resources
Roles
Create a roleList rolesGet a roleEdit a roleDelete a role
Grantable roles
List grantable roles
Users
Create a userList usersGet a userRemove a userUpdate a user
Blocked assets
List blocked properties and includesUpdate blocked properties and includes
User authentication settings
Lock a user's accountReset a user's passwordSet a user's passwordUnlock a user's accountSet multi-factor authentication for your user profileReset multi-factor authentication for your user profileRotate your password
User access
Set a user's multi-factor authenticationReset a user's multi-factor authentication
User notifications
Update a user's notificationsUpdate your notifications
User authorization settings
Modify a user's group and role assignments
Profile
View your profileEdit your profile
Contact types
View contact typesView contact types for a user profile
Locale
View countriesView statesView languagesView time zonesView supported countries for a user profileView states for a user profileView languages for a user profileView time zones for a user profile
Products
View productsView products for a user profile
Policies
View password policyView timeout policiesView password policy for a user profileView timeout policies for a user profile
CIDR blocks
Create a CIDR blockList CIDR blocksValidate CIDR blocksGet a CIDR blockModify a CIDR blockDelete a CIDR block
IP allowlists
Disable IP allowlistEnable IP allowlistView IP allowlist status
Helper
List authorized usersList allowed APIsList allowed CP codesList accessible groups
API client: self
Get your API clientUpdate your API clientDelete your API clientList your account switch keysCreate your credentialList your credentialsDeactivate your credentialsGet your credentialUpdate your credentialRemove your credentialDeactivate your credentialLock your API client
API clients
Create an API clientList API clientsGet an API clientUpdate an API clientDelete an API clientList account switch keysCreate a credentialList credentialsDeactivate credentialsGet a credentialUpdate a credentialRemove a credentialDeactivate a credentialLock an API clientUnlock an API client
Service-Level Agreement API
Quotas
List test configuration quotas
Tests
List test configurationsGet a test configurationUpdate a test configurationDelete a test configuration
Agent Groups
List agent groups
Create Test
Create a new test configuration
Reports
List availability reportsList performance reports
Application Security API
Application Security API-Security Configurations
List contracts and groupsList available hostnames for a new configurationList configurationsCreate a configurationRename a security configurationList configuration versionsClone a configuration versionGet configuration version detailsRemove a configuration versionGet the version notesUpdate the version notesExport a configuration version
Application Security API-Advanced Configuration Settings
Get the HTTP header log settings for a configurationModify HTTP header log settings for a configurationGet prefetch requestsModify Pragma settings for a configurationGet Pragma settings for a configuration
Application Security API-Hostnames
Get the hostname coverage match targetsGet Hostname CoverageList hostname overlapsList selectable hostnamesList selected hostnamesModify selected hostnamesList evaluation hostnames | WAP ONLYModify evaluation hostnames | WAP ONLYProtect evaluation hostnames | WAP ONLY
Application Security API-Security Policies
List security policiesClone or create a security policyGet a security policyModify a security policyRemove a security policyGet protectionsModify protections
Application Security API-Security Policy Advanced Settings
Get HTTP header log settingsModify HTTP header log settingsGet Pragma settings for a security policyModify Pragma settings for a security policy
Application Security API-Match Targets
List match targetsCreate a match targetModify match target orderGet a match targetModify a match targetRemove a match target
Application Security API-Custom Deny
List custom deny actionsCreate a custom deny actionGet a custom deny actionModify a custom deny actionRemove a custom deny action
Application Security API-Failover Hostnames
List failover hostnames
Application Security API-IP/Geo Firewall
Get the IP/Geo Firewall settingsUpdate the IP Geo Firewall settingsGet the bypass network lists settings | WAP ONLYModify the bypass network lists settings | WAP ONLY
Application Security API-Rate Policies
List rate policiesCreate a rate policyGet a rate policyModify a rate policyRemove a rate policyList rate policy actionsModify a rate policy action
Application Security API-Slow POST Settings
Get Slow POST protection settingsModify slow POST protection settings
Application Security API-Web Application Firewall Settings
Get the current modeModify the rule-set modeList attack groupsGet an attack groupModify the action for an attack groupGet the exceptions of an attack groupModify the exceptions of an attack groupList rules | KRS ONLYUpgrade KRS ruleset | KRS ONLYGet the action for a ruleModify the action for a ruleGet the conditions and exceptions of a ruleModify the conditions and exceptions of a ruleGet upgrade details
Application Security API-WAF Evaluation Rules
Set evaluation modeList evaluation rulesGet the action of an evaluation ruleModify the action of an evaluation ruleGet the conditions and exceptions for an evaluation ruleModify the conditions and exceptions for an evaluation rule | NOT WORKING
Application Security API-Penalty Box
Get the penalty boxModify the penalty box
Application Security API-Custom Rules Builder
List custom rulesCreate a custom ruleGet a custom ruleModify a custom ruleRemove a custom ruleList custom rule actionsModify a custom rule action
Application Security API-API Request Constraints
List API request constraints and actionsModify the request constraint action for all APIModify an API request constraint’s actionList API Endpoints
Application Security API-Reputation Profiles
Get a reputation profileCreate a reputation profileModify a reputation profileRemove a reputation profileGet the reputation analysis settingsUpdate the reputation analysis settingsList reputation profile actionsGet the action for a reputation profileModify the action for a reputation profile
Application Security API-SIEM Settings
Get the SIEM settingsModify SIEM settingsGet the SIEM versions
Application Security API-Notifications
List subscribersSubscribe or unsubscribe to recommendation emailsList Akamai Events
Application Security API-Activations
Activate a configuration versionGet an activation request statusGet activation status
Network Lists API v2-Activations
Get activation detailsActivate a network listGet activation statusGet an activation's snapshot
Network Lists API v2-Network lists
Create a new network listList network listsGet a network listUpdate a network listDelete a network listAppend elements to a network listUpdate network list details
Network Lists API v2-Elements
Add an elementRemove an element
Network Lists API v2-Subscriptions
Subscribe to network listsUnsubscribe to network lists
Site Shield API-Maps
List mapsGet a mapAcknowledge the map
Property Manager API-Create a Delivery Configuration
List ProductsCreate CP CodeList CP CodesCreate Edge Hostname for AMDCreate Delivery ConfigUpdate the hostnamesUpdate the Config RulesActivate the Config
Billing API
Usage by contract and product
List usage products per contractList monthly usage summary per CP codeList cumulative daily usage per contract and productList monthly usage summary per contract and product
Usage by reporting group
List cumulative daily usage per reporting groupList monthly usage summary per reporting group
Subcustomer geobilling usage
Download subcustomer geobilling files
Compute usage by contract and compute customer
List compute customers per contractGet compute usage summary per contract and compute customer
SIEM Integration API
Events
Fetch security events
Edge Diagnostics API
Connectivity problems
Run the Connectivity problems scenarioGet the Connectivity problems scenario response
Content problems
Run the Content problems scenarioGet the Content problems scenario response
CURL
Request content with cURL
ESI debugger
Get an ESI debugging report
DIG
Get domain details with dig
Edge server locations
List available edge server locations
Error translator
Translate error stringGet a translate error string response
Error statistics
Get error statistics
GREP
Launch a GREP requestGet specific logsCheck a GREP request status
GTM properties
List GTM propertiesList test and target IPs for a GTM hostname
IPA hostnames
List IP acceleration hostnames
IP network location
Locate an IP network
Metadata Tracer
Launch a metadata tracing requestList available edge server locations for metadata tracingCheck a metadata tracing request status
MTR
Test network connectivity with MTR
ARL translator
Translate an Akamaized URL
URL Health Check
Run the URL health checkGet a URL health check response
User diagnostic data
Generate a diagnostic linkList end user groupsGet diagnostic data for an end user group
IP verification
Verify an IP
IP verification and location
Verify and locate an IP
Secure Internet Access Enterprise Reporting API v3
AUP events
Report AUP event totalsReport AUP event detailsReport AUP event time series
Deepscan reports
Get deepscan details report
DNS activity reports
Report DNS activity totalsReport DNS activity event detailsReport DNS activity time series
Feedback reports
Report a threatGet feedback event detail report
IDP access logs
Report IDP access log details
IOC reports
Get IOC time series reportGet IOC change reportGet IOC AVC details reportGet IOC CIDR details reportGet IOC domain tree report
IOC detail reports
Get IOC details reportGet IOC AUP detail report
Network traffic connections
Report network traffic connections totalsReport network traffic connections detailsReport network traffic connections time series
Proxy traffic transactions
Report proxy traffic transactions totalsReport proxy network traffic transaction detailsReport proxy traffic transactions time series
Report schedules
Create a report scheduleList report schedulesGet a report scheduleUpdate a report scheduleRemove a report scheduleDisable a report scheduleEnable a report schedule
Security Connector event reports
Report security connector event totalsReport security connector event detailsReport security connector event time series
Threat events
Report threat event totalsReport threat event detailsReport threat event time series
Threats
Get threat metadata report
Fast Purge API v3
Cache tag
Delete by cache tagInvalidate by cache tag
URL/ARL
Delete by URL or ARLInvalidate by URL or ARL
CP code
Delete by CP codeInvalidate by CP code
Rate limits
Check rate and object limit statuses
Reporting API
Report types
List report typesList versionsGet a report type
Reports
Generate a reportGet a cacheable report
Property Manager API
Properties
Create or clone a propertyList propertiesGet a propertyRemove a property
Property version hostnames
List hostnames for a property versionUpdate hostnames for a property versionAdd or remove hostnames for a property version
Custom overrides
List custom overridesGet a custom override
Groups
List groups
Edge hostnames
Create a new edge hostnameList edge hostnamesGet an edge hostname
Property activations
Activate or deactivate a propertyList property's activationsGet a property activationCancel a property's pending activation
Include activations
Activate or deactivate an includeList include's activationsGet an include activationCancel an include's pending activation
Custom behaviors
List custom behaviorsGet a custom behavior
Bulk activations
Bulk activate a set of propertiesList bulk-activated properties
Products
List productsList use cases
Contracts
List contracts
Build
Get build details
Active property hostnames
List hostnames for a propertyGet property hostnames diff
Bulk patch
Bulk patch a set of propertiesList bulk-patched properties
Rule formats
List rule formats
Client settings
Get client settingsUpdate client settings
Include version rules
Get an include's rule treeUpdate an include's rule treePatch an include's rule treeGet a digest for an include's rule tree
Property version includes
List property's includes
Include versions
Create a new include versionList include versionsGet the latest include versionGet an include versionList available behaviors for an includeList available criteria for an include
Property hostnames
List hostnames for an accountGenerate domain validation challengesGet audit history
Bulk search
Bulk search a set of properties or includesSynchronously bulk search a set of properties or includesList bulk search results
Hostname buckets
List property hostname activationsGet a property hostname activationCancel a pending property hostname activationAdd or remove hostnames for a property's hostname bucket
Property versions
Create a new property versionList property versionsGet the latest property versionGet a property versionList available behaviors for a propertyList available criteria for a property
Schemas
Get a schema for a rule formatGet a schema for a request
Includes
Create or clone an includeList includesValidate an includeGet an includeRemove an includeList parent properties
Bulk versioning
Bulk version a set of propertiesList bulk-versioned properties
CP codes
Create a new CP codeList CP codesGet a CP code
Search
Search properties or includes
Property version rules
Get a property's rule treeUpdate a property's rule treePatch a property's rule treeGet a digest for a property's rule tree
Test Center API v3
Test runs
Submit a test runList test runsGet a test runGet test run's detailed results
Test suites
Create a test suiteList test suitesGenerate a test suite with child objectsCreate a test suite with child objectsGet a test suiteUpdate a test suiteDelete a test suiteRestore a test suiteGet a test suite with child objectsUpdate a test suite with child objects
Variables
Add variables to a test suiteList variablesUpdate variablesDelete variablesGet a variable
Test cases
Add test cases to a test suiteList test casesUpdate test casesReorder test cases in a test suiteRemove test casesRestore test casesGet a test case
Test catalog template
Get the test catalog template
Test conditions
List test conditions
Test requests
List test requests
Functions
Check how functions work
Certificate Provisioning System API v2
Enrollments
Create an enrollmentList enrollmentsGet an enrollmentUpdate an enrollmentRemove an enrollmentGet DV historyGet certificate history
Deployments
Update a deployment scheduleList deploymentsGet production deploymentGet staging deployment
Changes
Get change statusCancel a changeGet a deployment scheduleGet a changeUpdate a changeGet change history
Certificates
List active certificates
Invoicing API v3
Invoices
List invoices and credit memos for a contractDownload an invoice or a credit memo fileList invoices and credit memos for an account
Notifications
Create a notificationList notifications for an accountGet a notificationModify a notificationRemove a notification
Image and Video Manager API v2
Images
List imagesGet an image
Image collections
List image collectionsCreate a new image collectionUpdate an image collectionGet an image collectionRemove an image collection
Image collection history
Get image collection history
Policies
List policiesRoll back a policyGet a policyCreate or modify a policyRemove a policy
Policy sets
Create a policy setList policy setsGet a policy setUpdate a policy setDelete a policy set
Errors
List error details
Logs
List log details
Policy history
Get policy history
Introduction
Invoicing API v4
Invoices
List invoices and credit memos for a contractDownload an invoice or a credit memo fileList invoices and credit memos for an account
Notifications
Create a notificationList notifications for an accountGet a notificationModify a notificationRemove a notification
DataStream 2 API v2
Groups
List groups
Properties
List properties by group
Data sets
List data set fields
Streams
Create a streamList streamsView upload metricsGet a streamEdit a streamPatch a streamDelete a stream
Activations
Activate a streamView activation historyDeactivate a stream
History
View history
Edge Hostnames API
Localization data
Get localization data
Products
List products
Certificates
Get a certificate
Edge hostnames
Get an edge hostname by DNS zone and record namePatch an edge hostnameDelete an edge hostnameList edge hostnamesGet an edge hostname
Change requests
List change requestsGet a change requestList change requests per edge hostname
Cloud Access Manager API
Access key creation status
Get the status of an access key
Access key version status requests
Get the status of an access key version
Access keys
Create an access keyList access keysGet an access keyUpdate an access keyDelete an access key
Access key versions
Create an access key versionList access key versionsGet an access key versionDelete an access key version
Access key version properties
Look up propertiesGet an ID for an asynchronous property lookup request
Property lookups
Perform a property lookup request asynchronously
Event Viewer API
Event types
List event types
Events
List events
Secure Internet Access Enterprise Configuration API v3
Client configuration
Get client configurationUpdate client configuration
Client versions
List client versionsRotate client version entitlement codeUpdates the client version detailsDownload client version details
Client devices
List client devicesDeactivate a client deviceRe-activate a client deviceGet client status
Client network configurations
Create a network configurationGet the network configurationUpdate the network configuration
Configurations
List configurationsOnboard a contract
Acknowledgments
Create acknowledgment infoGet acknowledgment info
Custom error pages
Get a custom error pageUpdate the custom error page
Configuration wizard
Get the first time wizard stateUpdate first time wizard
VPN credentials
Create a VPN credentialList VPN credentialsGet a VPN credentialDelete a VPN credential
Proxy credentials
Create a proxy credentialList proxy credentialsList proxy credential detailsRemove a proxy credential
Custom responses
Create a custom responseList custom responsesGet a custom responseUpdate a custom responseDelete a custom response
Deployment configuration
Create a configuration deploymentList configuration deploymentsGet a configuration deployment
Deployment changes
List deployment changesList recent changes
DLP dictionaries
Create a DLP dictionaryList DLP dictionariesGet a DLP dictionaryUpdate a DLP dictionaryRemove a DLP dictionary
DLP dictionary patterns
Create a DLP patternList DLP dictionary patternsGet a DLP dictionary patternDelete a DLP dictionary pattern
DLP regexes
Create DLP regexesList DLP regular expressionsGet a DLP regex
Lists
Create a listList all listsList global list quotasGet details of a listUpdate a listRemove a listSearch in a listModify list itemsPatch a list
Akamai built-in security lists
List all Akamai built-in security lists
DNS cache
Clear the DNS cache
Notifications
Create notifications configsGet notification configurationUpdate the notifications configsGet notification configuration for typeUpdate the subscribers to notification type
Policies
Create a policyList policiesGet a policyUpdate a policyRemove a policyList policy metadata
Policy built-in responses
List built-in responses
Policy predefined security categories
List security category predefined configurations
Security connectors
Create a security connectorList security connectorsList the current security connector versionsGet the security connector's latest available versionGet a security connectorDelete a security connectorChange local security connector passwordGenerate activation code for a security connectorUpgrade a security connectorUpdate a security connector
DNS VIPs
List DNS VIPs
Global settings
List global settingsUpdate global settings
Sites
Create a siteList sitesGet site meta infoGet a siteUpdate a siteRemove a site
Proxy certificates
Create a new proxy certificateList proxy certificatesGet a proxy certificateModify a proxy certificateActivate a proxy certificateConfirm proxy certificate distributionConfirm proxy certificate downloadDeactivate a proxy certificate
Tenants
Onboard a tenantList all tenantsGet a tenantUpdate a tenantRemove a tenantList the tenant user details
Sublocations
Create a sublocationList sublocationsGet a sublocationUpdate a sublocationRemove a sublocationAssign a policy to a sublocation
Contract API
Contracts
List contracts
Products
List products per contractList products per reporting group
Reporting groups
List CP code reporting groupsList CP code reporting group IDs
Script Management API
Insights
Get insights
Policies
Create a policyGet a policy
Edge Compute APIs
EdgeWorkers API-Contracts
List contract IDs
EdgeWorkers API-Permission groups
List permission groupsGet a permission group
EdgeWorkers API-EdgeWorker IDs
Create a new EdgeWorker IDList EdgeWorker IDsGet an EdgeWorker IDUpdate an EdgeWorker IDDelete an EdgeWorker IDClone an EdgeWorker IDGet the resource tier
EdgeWorkers API-Versions
Create a new versionList versionsGet version detailsDelete versionDownload an EdgeWorkers code bundle
EdgeWorkers API-Activations
Activate an EdgeWorker versionList activationsRoll back to the previous active EdgeWorker versionGet an activationCancel an activation
EdgeWorkers API-Deactivations
Deactivate an EdgeWorker versionList deactivationsGet a deactivation
EdgeWorkers API-Properties
List properties
EdgeWorkers API-Revisions
List revisionsActivate a fallback revisionList revision activationsGet a revisionGet a revision BOMCompare revisionsDownload the combined code bundlePin an active revisionUnpin an active revision
EdgeWorkers API-Limits
List limits
EdgeWorkers API-Reports
List reportsGet an EdgeWorker report
EdgeWorkers API-Resource tiers
List resource tiers
EdgeWorkers API-Secure tokens
Create a secure tokenGet a secure token
EdgeWorkers API-Validations
Validate an EdgeWorkers code bundle
EdgeKV API-Permission groups
List permission groupsGet a permission group
EdgeKV API-Namespaces
Modify the default data access policyReauthorize a namespaceCreate a namespaceList namespacesGet namespace detailsUpdate namespace detailsList groups within a namespace
EdgeKV API-EdgeKV status
Get the EdgeKV initialization statusInitialize EdgeKV
EdgeKV API-Items
List items within a groupRead an itemWrite an itemDelete an item
EdgeKV API-Access tokens
Create an access tokenList access tokensDownload an access tokenRevoke an access token
Edge DNS API v2
Create requests
Submit a bulk proxy zone create requestGet a bulk proxy zone create results for a proxyCheck bulk proxy zone create statusGet a bulk proxy zone create resultSubmit a bulk zone create requestCheck bulk zone create statusGet bulk zone create results
Delete requests
Submit a bulk proxy zone delete requestGet all bulk proxy zone delete resultsCheck bulk proxy zone delete statusGet a bulk proxy zone delete resultSubmit a bulk zone delete requestCheck bulk zone delete statusGet bulk zone delete results
Change lists
Create a change listList user's change listsSearch for change listsGet a change listDelete a change listShow changesList record set names for a change listSubmit a change list
Types
List record set types for name and change listGet a record set for a change listList record set types for name and zone
Record sets
Upload a master zone file to a change listList record sets for a change listModify record set for a change listCreate a record setGet a record setReplace a record setDelete a record setCreate record setsGet a zone's record setsReplace record sets
Change list settings
Get change list settingsUpdate change list settings
Authorities
List authoritative name servers
Contracts
List contracts
DNSSEC algorithms
List DNSSEC algorithms
Edge hostnames
List edge hostnames
Groups
List groups
TSIG key algorithms
List TSIG key algorithms
DNS proxies
Create a proxyList proxiesList valid proxy health check record set typesGet a proxyUpdate a proxy
Proxy zones
List proxy zonesList proxy zone keysGet a proxy zone by nameGet a proxy zone TSIG key by nameUpdate a proxy zone TSIG key by nameDelete a proxy zone TSIG key by nameGet proxy zones for a TSIG keyGet a manual filter reportManage manual filter namesInitialize manual filter names with a zone file
Proxy zones filter mode conversion
Convert a proxy zone filter mode to allConvert a proxy zone filter mode to automaticConvert a proxy zone filter mode to manualConvert a proxy zone filter mode to none
Names
List record set names for a zone
Master zone file
Upload a master zone fileGet a master zone file
TSIG keys
List TSIG keysUpdate a TSIG key across zonesList zones using TSIG keyList of zones to contract using TSIG keyGet a zone's TSIG keyUpdate a zone's TSIG keyDelete a zone's TSIG keyList users of a zone's TSIG key
Versions
List a zone's versionsShow zone version differencesGet a zone versionGet a version's record setsReactivate a version
Zone file
Get a version's master zone file
Zones
Create a zoneList zonesGet a zone's settingsUpdate a zone's settingsGet a zone's aliases
DNSSEC status
Get a zone's DNSSEC status
Zone transfer status
Get secondary zones transfer status
Zone contracts
Get a zone's contract
Record types
List record types
Reporting API v2
Report list
List reportsList reports per product familyList reports per reporting area
Report metadata
Get report options
Report data
Generate a reportGet asynchronous report results
Single Sign-On Configuration API
Certificates
Add a certificateList certificatesRemove a certificate
Identity and Access Management API v3
Groups
List groupsCreate a new groupGet a groupModify a group's nameDelete a group
Move groups
Move a groupList users affected by moving a group
Assets
List properties or includesGet a property or includeMove a property or includeList users for property or includeBlock users from a property or include
Resources
Get asset's resources
Roles
Create a roleList rolesGet a roleEdit a roleDelete a role
Grantable roles
List grantable roles
Users
Create a userList usersGet a userRemove a userUpdate a user
Blocked assets
List blocked properties and includesUpdate blocked properties and includes
User authentication settings
Lock a user's accountReset a user's passwordSet a user's passwordUnlock a user's accountSet multi-factor authentication for your user profileReset multi-factor authentication for your user profileRotate your password
User access
Set a user's multi-factor authenticationReset a user's multi-factor authentication
User notifications
Update a user's notificationsUpdate your notifications
User authorization settings
Modify a user's group and role assignments
Profile
View your profileEdit your profile
Contact types
View contact typesView contact types for a user profile
Locale
View countriesView statesView languagesView time zonesView supported countries for a user profileView states for a user profileView languages for a user profileView time zones for a user profile
Products
View productsView products for a user profile
Policies
View password policyView timeout policiesView password policy for a user profileView timeout policies for a user profile
CIDR blocks
Create a CIDR blockList CIDR blocksValidate CIDR blocksGet a CIDR blockModify a CIDR blockDelete a CIDR block
IP allowlists
Disable IP allowlistEnable IP allowlistView IP allowlist status
Helper
List authorized usersList allowed APIsList allowed CP codesList accessible groups
API client: self
Get your API clientUpdate your API clientDelete your API clientList your account switch keysCreate your credentialList your credentialsDeactivate your credentialsGet your credentialUpdate your credentialRemove your credentialDeactivate your credentialLock your API client
API clients
Create an API clientList API clientsGet an API clientUpdate an API clientDelete an API clientList account switch keysCreate a credentialList credentialsDeactivate credentialsGet a credentialUpdate a credentialRemove a credentialDeactivate a credentialLock an API clientUnlock an API client
Service-Level Agreement API
Quotas
List test configuration quotas
Tests
List test configurationsGet a test configurationUpdate a test configurationDelete a test configuration
Agent Groups
List agent groups
Create Test
Create a new test configuration
Reports
List availability reportsList performance reports
Application Security API
Application Security API-Security Configurations
List contracts and groupsList available hostnames for a new configurationList configurationsCreate a configurationRename a security configurationList configuration versionsClone a configuration versionGet configuration version detailsRemove a configuration versionGet the version notesUpdate the version notesExport a configuration version
Application Security API-Advanced Configuration Settings
Get the HTTP header log settings for a configurationModify HTTP header log settings for a configurationGet prefetch requestsModify Pragma settings for a configurationGet Pragma settings for a configuration
Application Security API-Hostnames
Get the hostname coverage match targetsGet Hostname CoverageList hostname overlapsList selectable hostnamesList selected hostnamesModify selected hostnamesList evaluation hostnames | WAP ONLYModify evaluation hostnames | WAP ONLYProtect evaluation hostnames | WAP ONLY
Application Security API-Security Policies
List security policiesClone or create a security policyGet a security policyModify a security policyRemove a security policyGet protectionsModify protections
Application Security API-Security Policy Advanced Settings
Get HTTP header log settingsModify HTTP header log settingsGet Pragma settings for a security policyModify Pragma settings for a security policy
Application Security API-Match Targets
List match targetsCreate a match targetModify match target orderGet a match targetModify a match targetRemove a match target
Application Security API-Custom Deny
List custom deny actionsCreate a custom deny actionGet a custom deny actionModify a custom deny actionRemove a custom deny action
Application Security API-Failover Hostnames
List failover hostnames
Application Security API-IP/Geo Firewall
Get the IP/Geo Firewall settingsUpdate the IP Geo Firewall settingsGet the bypass network lists settings | WAP ONLYModify the bypass network lists settings | WAP ONLY
Application Security API-Rate Policies
List rate policiesCreate a rate policyGet a rate policyModify a rate policyRemove a rate policyList rate policy actionsModify a rate policy action
Application Security API-Slow POST Settings
Get Slow POST protection settingsModify slow POST protection settings
Application Security API-Web Application Firewall Settings
Get the current modeModify the rule-set modeList attack groupsGet an attack groupModify the action for an attack groupGet the exceptions of an attack groupModify the exceptions of an attack groupList rules | KRS ONLYUpgrade KRS ruleset | KRS ONLYGet the action for a ruleModify the action for a ruleGet the conditions and exceptions of a ruleModify the conditions and exceptions of a ruleGet upgrade details
Application Security API-WAF Evaluation Rules
Set evaluation modeList evaluation rulesGet the action of an evaluation ruleModify the action of an evaluation ruleGet the conditions and exceptions for an evaluation ruleModify the conditions and exceptions for an evaluation rule | NOT WORKING
Application Security API-Penalty Box
Get the penalty boxModify the penalty box
Application Security API-Custom Rules Builder
List custom rulesCreate a custom ruleGet a custom ruleModify a custom ruleRemove a custom ruleList custom rule actionsModify a custom rule action
Application Security API-API Request Constraints
List API request constraints and actionsModify the request constraint action for all APIModify an API request constraint’s actionList API Endpoints
Application Security API-Reputation Profiles
Get a reputation profileCreate a reputation profileModify a reputation profileRemove a reputation profileGet the reputation analysis settingsUpdate the reputation analysis settingsList reputation profile actionsGet the action for a reputation profileModify the action for a reputation profile
Application Security API-SIEM Settings
Get the SIEM settingsModify SIEM settingsGet the SIEM versions
Application Security API-Notifications
List subscribersSubscribe or unsubscribe to recommendation emailsList Akamai Events
Application Security API-Activations
Activate a configuration versionGet an activation request statusGet activation status
Network Lists API v2-Activations
Get activation detailsActivate a network listGet activation statusGet an activation's snapshot
Network Lists API v2-Network lists
Create a new network listList network listsGet a network listUpdate a network listDelete a network listAppend elements to a network listUpdate network list details
Network Lists API v2-Elements
Add an elementRemove an element
Network Lists API v2-Subscriptions
Subscribe to network listsUnsubscribe to network lists
Site Shield API-Maps
List mapsGet a mapAcknowledge the map
Property Manager API-Create a Delivery Configuration
List ProductsCreate CP CodeList CP CodesCreate Edge Hostname for AMDCreate Delivery ConfigUpdate the hostnamesUpdate the Config RulesActivate the Config
Billing API
Usage by contract and product
List usage products per contractList monthly usage summary per CP codeList cumulative daily usage per contract and productList monthly usage summary per contract and product
Usage by reporting group
List cumulative daily usage per reporting groupList monthly usage summary per reporting group
Subcustomer geobilling usage
Download subcustomer geobilling files
Compute usage by contract and compute customer
List compute customers per contractGet compute usage summary per contract and compute customer
SIEM Integration API
Events
Fetch security events
Edge Diagnostics API
Connectivity problems
Run the Connectivity problems scenarioGet the Connectivity problems scenario response
Content problems
Run the Content problems scenarioGet the Content problems scenario response
CURL
Request content with cURL
ESI debugger
Get an ESI debugging report
DIG
Get domain details with dig
Edge server locations
List available edge server locations
Error translator
Translate error stringGet a translate error string response
Error statistics
Get error statistics
GREP
Launch a GREP requestGet specific logsCheck a GREP request status
GTM properties
List GTM propertiesList test and target IPs for a GTM hostname
IPA hostnames
List IP acceleration hostnames
IP network location
Locate an IP network
Metadata Tracer
Launch a metadata tracing requestList available edge server locations for metadata tracingCheck a metadata tracing request status
MTR
Test network connectivity with MTR
ARL translator
Translate an Akamaized URL
URL Health Check
Run the URL health checkGet a URL health check response
User diagnostic data
Generate a diagnostic linkList end user groupsGet diagnostic data for an end user group
IP verification
Verify an IP
IP verification and location
Verify and locate an IP
Secure Internet Access Enterprise Reporting API v3
AUP events
Report AUP event totalsReport AUP event detailsReport AUP event time series
Deepscan reports
Get deepscan details report
DNS activity reports
Report DNS activity totalsReport DNS activity event detailsReport DNS activity time series
Feedback reports
Report a threatGet feedback event detail report
IDP access logs
Report IDP access log details
IOC reports
Get IOC time series reportGet IOC change reportGet IOC AVC details reportGet IOC CIDR details reportGet IOC domain tree report
IOC detail reports
Get IOC details reportGet IOC AUP detail report
Network traffic connections
Report network traffic connections totalsReport network traffic connections detailsReport network traffic connections time series
Proxy traffic transactions
Report proxy traffic transactions totalsReport proxy network traffic transaction detailsReport proxy traffic transactions time series
Report schedules
Create a report scheduleList report schedulesGet a report scheduleUpdate a report scheduleRemove a report scheduleDisable a report scheduleEnable a report schedule
Security Connector event reports
Report security connector event totalsReport security connector event detailsReport security connector event time series
Threat events
Report threat event totalsReport threat event detailsReport threat event time series
Threats
Get threat metadata report
Fast Purge API v3
Cache tag
Delete by cache tagInvalidate by cache tag
URL/ARL
Delete by URL or ARLInvalidate by URL or ARL
CP code
Delete by CP codeInvalidate by CP code
Rate limits
Check rate and object limit statuses
Reporting API
Report types
List report typesList versionsGet a report type
Reports
Generate a reportGet a cacheable report
Property Manager API
Properties
Create or clone a propertyList propertiesGet a propertyRemove a property
Property version hostnames
List hostnames for a property versionUpdate hostnames for a property versionAdd or remove hostnames for a property version
Custom overrides
List custom overridesGet a custom override
Groups
List groups
Edge hostnames
Create a new edge hostnameList edge hostnamesGet an edge hostname
Property activations
Activate or deactivate a propertyList property's activationsGet a property activationCancel a property's pending activation
Include activations
Activate or deactivate an includeList include's activationsGet an include activationCancel an include's pending activation
Custom behaviors
List custom behaviorsGet a custom behavior
Bulk activations
Bulk activate a set of propertiesList bulk-activated properties
Products
List productsList use cases
Contracts
List contracts
Build
Get build details
Active property hostnames
List hostnames for a propertyGet property hostnames diff
Bulk patch
Bulk patch a set of propertiesList bulk-patched properties
Rule formats
List rule formats
Client settings
Get client settingsUpdate client settings
Include version rules
Get an include's rule treeUpdate an include's rule treePatch an include's rule treeGet a digest for an include's rule tree
Property version includes
List property's includes
Include versions
Create a new include versionList include versionsGet the latest include versionGet an include versionList available behaviors for an includeList available criteria for an include
Property hostnames
List hostnames for an accountGenerate domain validation challengesGet audit history
Bulk search
Bulk search a set of properties or includesSynchronously bulk search a set of properties or includesList bulk search results
Hostname buckets
List property hostname activationsGet a property hostname activationCancel a pending property hostname activationAdd or remove hostnames for a property's hostname bucket
Property versions
Create a new property versionList property versionsGet the latest property versionGet a property versionList available behaviors for a propertyList available criteria for a property
Schemas
Get a schema for a rule formatGet a schema for a request
Includes
Create or clone an includeList includesValidate an includeGet an includeRemove an includeList parent properties
Bulk versioning
Bulk version a set of propertiesList bulk-versioned properties
CP codes
Create a new CP codeList CP codesGet a CP code
Search
Search properties or includes
Property version rules
Get a property's rule treeUpdate a property's rule treePatch a property's rule treeGet a digest for a property's rule tree
Test Center API v3
Test runs
Submit a test runList test runsGet a test runGet test run's detailed results
Test suites
Create a test suiteList test suitesGenerate a test suite with child objectsCreate a test suite with child objectsGet a test suiteUpdate a test suiteDelete a test suiteRestore a test suiteGet a test suite with child objectsUpdate a test suite with child objects
Variables
Add variables to a test suiteList variablesUpdate variablesDelete variablesGet a variable
Test cases
Add test cases to a test suiteList test casesUpdate test casesReorder test cases in a test suiteRemove test casesRestore test casesGet a test case
Test catalog template
Get the test catalog template
Test conditions
List test conditions
Test requests
List test requests
Functions
Check how functions work
Certificate Provisioning System API v2
Enrollments
Create an enrollmentList enrollmentsGet an enrollmentUpdate an enrollmentRemove an enrollmentGet DV historyGet certificate history
Deployments
Update a deployment scheduleList deploymentsGet production deploymentGet staging deployment
Changes
Get change statusCancel a changeGet a deployment scheduleGet a changeUpdate a changeGet change history
Certificates
List active certificates
Invoicing API v3
Invoices
List invoices and credit memos for a contractDownload an invoice or a credit memo fileList invoices and credit memos for an account
Notifications
Create a notificationList notifications for an accountGet a notificationModify a notificationRemove a notification
Image and Video Manager API v2
Images
List imagesGet an image
Image collections
List image collectionsCreate a new image collectionUpdate an image collectionGet an image collectionRemove an image collection
Image collection history
Get image collection history
Policies
List policiesRoll back a policyGet a policyCreate or modify a policyRemove a policy
Policy sets
Create a policy setList policy setsGet a policy setUpdate a policy setDelete a policy set
Errors
List error details
Logs
List log details
Policy history
Get policy history
HomeProperty Manager APIInclude activations

Include activations

Number of APIs: 4

  1. Activate or deactivate an include POST https://{{host}}/papi/v1/includes/:includeId/activations

  2. List include's activations GET https://{{host}}/papi/v1/includes/:includeId/activations

  3. Get an include activation GET https://{{host}}/papi/v1/includes/:includeId/activations/:activationId

  4. Cancel an include's pending activation DELETE https://{{host}}/papi/v1/includes/:includeId/activations/:activationId

Previous
Cancel a property's pending activation
Next
Activate or deactivate an include