For AI agents: visit https://techdocs.akamai.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
PowerShell
GuideHelp Doc
PowerShell
Guide
GuideHelp Doc

Get started

  • Overview
  • Authentication
  • Base IDs
  • Version Mapping
  • Error handling and options
  • Support
    • Commands and help
    • Code and tests

API Definitions

  • Function index
  • Copy
    • Endpoint
  • Find
    • API operation
  • Get
    • Category
    • Contracts & groups
    • Endpoint
    • Endpoint multistep group
    • Endpoint version
    • Endpoint version cache
    • Endpoint version CORS
    • Endpoint version error responses
    • Endpoint version error response type
    • Endpoint version GraphQL
    • Endpoint version GZIP
    • Endpoint version JWT
    • Endpoint version PII
    • Endpoint version PII settings
    • Endpoint version privacy
    • Endpoint version resource
    • Endpoint version resource operation
    • Endpoint version resources & operations
    • Endpoint version routing
    • Endpoint version summary
    • Hostnames
    • Hostnames & groups
    • Operations
    • User entitlements
  • New
    • Category
    • Endpoint
    • Endpoint activation
    • Endpoint deactivation
    • Endpoint from file
    • Endpoint multistep group
    • Endpoint version
    • Endpoint version resource
    • Endpoint version resource operation
    • Endpoint version PII
  • Remove
    • Category
    • Endpoint
    • Endpoint version
    • Endpoint version PII
    • Endpoint version resource
    • Endpoint version resource operation
    • Endpoint multistep group
  • Rename
    • Endpoint multistep group
  • Set
    • Category
    • Endpoint version
    • Endpoint version cache
    • Endpoint version CORS
    • Endpoint version error responses
    • Endpoint version error response type
    • Endpoint version from file
    • Endpoint version GraphQL
    • Endpoint version GZIP
    • Endpoint version JWT
    • Endpoint version PII
    • Endpoint version privacy
    • Endpoint version PII status
    • Endpoint version PII settings
    • Endpoint version resource
    • Endpoint version resource operation
    • Endpoint version routing
  • Show/Hide
    • Endpoint (hide)
    • Endpoint version (hide)
    • Endpoint (show)
    • Endpoint version (show)
  • Test
    • Secure connection
    • Operations
  • Update
    • Endpoint version PII

API Key Manager

  • Function index
  • Add
    • Keys to collection
  • Export
    • Keys
  • Get
    • Key
    • Key collection
    • Key collection ACL
    • Key collection endpoints
    • Key collection quota
    • Tags
    • Throttling counter
    • Throttling counter endpoints
    • Throttling counter key collections
    • Throttling counter keys
  • Import
    • Keys
  • Move
    • Keys
  • New
    • Keys
    • Key collection
    • Throttling counter
  • Remove
    • Key collection
    • Keys from collection
    • Throttling counter
  • Reset
    • Collection key quota
    • Key quota
  • Restore
    • Keys
  • Revoke
    • Keys
  • Set
    • Key
    • Key collection
    • Key collection ACL
    • Key collection quota
    • Throttling counter

AppSec

  • Function index
  • Add
    • Policy selected hostnames
    • Configuration selected hostnames
  • Compare
    • Configuration versions
  • Disable
    • Policy rapid rules
  • Enable
    • Policy rapid rules
  • Export
    • Configuration version
  • Get
    • Behavioral DDoS
    • Activation history
    • Activation request status
    • Activation status
    • Attack payload
    • Available hostnames
    • Behavioral DDoS
    • Configuration
    • Configuration attack payload logging
    • Configuration bypass network lists
    • Configuration evaluation hostnames
    • Configuration evasive path match
    • Configuration version
    • Configuration version notes
    • Configuration HTTP header logs
    • Configuration Pragma settings
    • Configuration request body settings
    • Configuration selected hostnames
    • Contracts & groups
    • Cookie settings
    • Custom deny action
    • Custom rule
    • Custom rule actions
    • Custom rule usage
    • CVE
    • CVE coverage
    • CVE subscription
    • Discovered API
    • Discovered API endpoints
    • Export
    • Export status
    • Failover hostnames
    • Hostname coverage
    • Hostname coverage match targets
    • Hostname overlaps
    • Malware policy
    • Malware policy actions
    • Malware policy content type
    • Match target
    • Onboarding
    • Onboarding activation
    • Onboarding certificate validation
    • Onboarding CNAME record
    • Onboarding origin validation
    • Onboarding settings
    • PII learning
    • Policy
    • Policy adaptive intelligence
    • Policy API request constraints
    • Policy API endpoints
    • Policy attack group action
    • Policy attack group exceptions
    • Policy attack group tuning recommendations
    • Policy attack payload logging
    • Policy bypass network lists
    • Policy CPC
    • Policy custom rule
    • Policy evaluation attack group action
    • Policy evaluation attack group exceptions
    • Policy evaluation hostnames
    • Policy evaluation penalty box
    • Policy evaluation penalty box condition
    • Policy evaluation rule action
    • Policy evaluation rule exceptions
    • Policy evasive path match
    • Policy IP/Geo Firewall settings
    • Policy HTTP header logs
    • Policy mode
    • Policy penalty box
    • Policy Pragma settings
    • Policy protections
    • Policy rapid rule
    • Policy rapid rule condition
    • Policy rapid rule default action
    • Policy rapid rule lock
    • Policy rapid rules status
    • Policy request body settings
    • Policy selected hostnames
    • Policy tuning recommendations
    • Prefetch requests
    • Rate policy
    • Rate policy actions
    • Reputation analysis
    • Reputation profile
    • Reputation profile action
    • URL protection policy
    • URL protection policy actions
    • Selectable hostnames
    • SIEM settings
    • SIEM versions
    • Slow POST protection
    • Subscribers
    • WAF rule action
    • WAF rule exceptions
    • WAF rule tuning recommendations
    • WAF rule upgrade details
  • Hide
    • Discovered API
  • Lock
    • Policy rapid rule
  • New
    • Behavioral DDoS
    • Activations
    • Configuration
    • Configuration version
    • Custom deny action
    • Custom rule
    • CVE subscription
    • Discovered API endpoint
    • Malware policy
    • Match target
    • Onboarding
    • Onboarding activation
    • Policy
    • Rate policy
    • Reputation profile
    • Subscriptions
    • URL protection policy
  • Protect
    • Configuration evaluation hostnames
    • Policy evaluation hostnames
  • Remove
    • Behavioral DDoS
    • Configuration
    • Configuration version
    • Configuration selected hostnames
    • Custom deny action
    • Custom rule
    • CVE subscription
    • Malware policy
    • Match target
    • Onboarding
    • Policy
    • Policy selected hostnames
    • Rate policy
    • Reputation profile
    • Subscriptions
    • URL protection policy
  • Rename
    • Configuration
  • Set
    • Attack payload
    • Behavioral DDoS
    • Configuration attack payload logging
    • Configuration bypass network lists
    • Configuration evaluation hostnames
    • Configuration evasive path match
    • Configuration HTTP header logs
    • Configuration Pragma settings
    • Configuration selected hostnames
    • Configuration request body settings
    • Configuration version notes
    • Cookie settings
    • Custom deny action
    • Custom rule
    • Evaluation rate policy
    • JA4 fingerprint
    • Malware policy
    • Match target
    • Match target order
    • PII learning
    • Onboarding origin validation
    • Onboarding settings
    • Policy
    • Policy adaptive intelligence
    • Policy API request constraints
    • Policy attack group action
    • Policy attack group exceptions
    • Policy attack payload logging
    • Policy behavioral DDoS
    • Policy bypass network lists
    • Policy CPC
    • Policy custom rule action
    • Policy evaluation attack group action
    • Policy evaluation attack group exceptions
    • Policy evaluation hostnames
    • Policy evaluation mode
    • Policy evaluation penalty box
    • Policy evaluation penalty box condition
    • Policy evaluation rule action
    • Policy evaluation rule exceptions
    • Policy evasive path match
    • Policy IP/Geo Firewall settings
    • Policy HTTP header logs
    • Policy malware policy action
    • Policy mode
    • Policy penalty box
    • Policy penalty box condition
    • Policy Pragma settings
    • Policy protections
    • Policy rapid rule
    • Policy rapid rule condition
    • Policy rapid rule default action
    • Policy rate policy actions
    • Policy reputation profile action
    • Policy request body settings
    • Policy selected hostnames
    • Policy tuning recommendations
    • Prefetch requests
    • Rate policy
    • Reputation analysis
    • Reputation profile
    • SIEM settings
    • Slow POST protection
    • WAF policy rule action
    • WAF rule exceptions
    • URL protection policy
    • URL protection policy actions
  • Show
    • Discovered API
  • Skip
    • Onboarding origin validation
  • Submit
    • Onboarding CNAME record
    • Onboarding certificate validation
  • Unlock
    • Policy rapid rule
  • Update
    • KRS rule set

China CDN

  • Function index
  • Get
    • Deprovision policy
    • Edge hostnames
    • Groups
    • ICP holding entities
    • ICP numbers
    • Property hostname
    • Provision state change
    • Provision states
  • New
    • Property hostname
    • Provision state change
  • Set
    • Deprovision policy

Certificates

  • Provision certificates
  • Function index
  • Add
    • 3-party certificate
  • Confirm
    • Change
    • Let's Encrypt challenges
    • Post-verification warnings
    • Pre-verification warnings
  • Get
    • Active Certificate
    • Certificate history
    • Certificate signing request
    • Change history
    • Change status
    • Change status on staging
    • Deployments
    • Deployment schedule
    • DV history
    • Enrollment
    • Let's Encrypt challenges
    • Post-verification warnings
    • Pre-verification warnings
    • Production deployment
    • Staging deployment
  • New
    • Enrollment
  • Set
    • Deployment schedule
    • Enrollment
  • Remove
    • Change
    • Enrollment

Client Lists

  • Configure client lists
  • Function index
  • Add
    • List item
  • Get
    • Client list
    • Contracts & groups
    • Activation
    • Activation status
    • List item
    • Snapshot
    • Tags
    • Usage data
  • Import
    • List item
  • New
    • Activation
    • Client list
    • Deactivation
    • Subscription
  • Remove
    • Client list
    • Item
    • Subscription
  • Set
    • Client list
    • List item
  • Test
    • List items

Cloud Access Manager

  • Manage cloud origin access
  • Function index
  • Get
    • Access key
    • Access key creation status
    • Access key version
    • Access key version creation status
    • Access key version properties
    • Access key version status
    • Property lookup
  • New
    • Access key
    • Access key version
    • Property lookup
  • Remove
    • Access key
    • Access key version
  • Rename
    • Access key

Cloud Wrapper

  • Add a custom cache layer
  • Function index
  • Get
    • Auth keys
    • Capacities
    • CDN providers
    • Configuration
    • Locations
    • Origin hostnames
    • Origins
    • Properties
  • New
    • Configuration
    • Configuration activation
  • Remove
    • Configuration
  • Set
    • Configuration

Cloudlets

  • Set up cloudlet policies
    • Policies
    • Load balancer
    • Origin server
  • Function index
  • Copy
    • Policy
  • Get
    • Active properties
    • Associated properties
    • Cloudlet
    • Group
    • Load balancer
    • Load balancer activation
    • Load balancer version
    • Policy
    • Policy activation
    • Policy CSV
    • Policy version
    • Policy version rule
    • Schema
  • New
    • Load balancer
    • Load balancer activation
    • Load balancer version
    • Policy
    • Policy version
    • Policy activation
    • Policy version deactivation
    • Policy version rule
  • Remove
    • Load balancer
    • Policy
    • Policy version
  • Set
    • Load balancer