For AI agents: visit https://techdocs.akamai.com/powershell/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guide
v2
v3.0
Guide
v3.0
Guide
Endpoint version summary
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
Load balancer version
Policy
Policy version
Policy version rule
Common
Function index
Clear
EdgeGrid credentials
Akamai data cache
Akamai options
Export
EdgeGrid credentials
Netstorage credentials
Get
Edgegrid credentials
Akamai options
Auth grants
Netstorage Credentials
Import
EdgeGrid credentials
Netstorage credentials
Invoke
Akamai NSAPI request
Akamai REST method
Netstorage request
Akamai request
New
Akamai data cache
Akamai options
EdgeGrid auth token
Set
Akamai data cache
Akamai options
Test
EdgeGrid credentials
OpenAPI
Contracts
View contracts and related products
Function index
Get
Contracts
Products per contract
Products per reporting group
Reporting group
Reporting group identifier
CP Codes
Manage site traffic
Function index
Get
CP code
Products
Reporting group
Watermark limit for CP codes
Watermark limit for reporting groups
New
Reporting group
Remove
Reporting group
Set
CP code
Reporting group
Datastream
Create data streams
Data sets
Destinations
Function index
Get
Activation history
Data set fields
Data stream
EDNS zones
Groups
GTM properties
History
Properties
Upload metrics
New
Activation
Data stream
Deactivation
Set
Data stream
Update
Data stream
Remove
Data stream
Domain Ownership
Validate domains
Function index
Complete
Domain
Disable
Domain
Find
Domain
Get
Domain
New
Domain
Remove
Domain
Edge Diagnostics
Diagnose content delivery issues
Function index
Find
IP address
Get
Akamaized URL translation
Connectivity problems
Content problems
Diagnostic data for group
Edge server locations
Edge server locations for metadata tracing
Error statistics
Error translation
GREP request
GTM properties
GTM property IPs
IPA hostnames
Logs
Metadata tracer
URL health check
New
Connectivity problems
Content problems
cURL request
Diagnostic link
DIG request
Error translation
ESI debugger
GREP request
Metadata trace
MTR request
URL health check
Test
IP verification & location
Edge DNS
Function index
Add
Proxy zone manual filter name
Compare
Zone versions
Convert
Proxy zone
Zone to alias
Zone to primary
Zone to secondary
Find
Change list
Get
Authoritative name servers
Bulk zone create results
Bulk zone create request status
Bulk zone delete request results
Bulk zone delete request status
Change list
Change list diff
Change list settings
Contract
Contracts
Convert result
Convert status
DNSSEC algorithms
DNSSEC status
Edge hostnames
Groups
Master zone file
Proxy
Proxy health check
Proxy zone
Proxy zone create result
Proxy zone create status
Proxy zone delete result
Proxy zone delete status
Proxy zone manual filter report
Proxy zone TSIG key
Proxy zone TSIG key use
Record set names for change list
Record set types
Record set types for name and change list
Record sets
Record sets for change list
Secondary SOA
TSIG key algorithms
TSIG key contract
TSIG keys
Users of zone's TSIG key
Zone
Zone's aliases
Zone DNS key
Zone transfer status
Zone version
Zone version master file
Zone version record set
New
Bulk zone create request
Bulk zone delete request
Change list
Proxy
Proxy zone
Record set
Zone
Remove
Change list
Proxy zone
Proxy zone apex alias
Proxy zone manual filter name
Proxy zone TSIG key
Record set
TSIG key
Zone
Restore
Zone version
Set
Change list settings
Master zone file
Master zone file upload to change list
Proxy
Proxy zone apex alias
Proxy zone manual filter names
Proxy zone TSIG key
Record set
Record set for change list
TSIG key
Zone
Submit
Change list
Edge Hostnames
Function index
Get
Edge hostname
Certificate
Change request
Localization data
Products
Remove
Edge hostname
Set
Edge hostname
EdgeKV
Manage a distributed key-value store
Function index
Export
Data
Get
Access token
Initialization status
Item
Namespace
Namespace delete
Namespace group
Permission group
Upload
Import
Data
Initialize
EdgeKV
Move
Namespace
New
Access token
Item
Namespace
Remove
Access token
Item
Namespace
Restore
Namespace
Set
Default data access policy
Namespace
Namespace delete
Update
Access token
Namespace
EdgeWorkers
Enable EdgeWorkers
Function index
Compare
Revisions
Copy
EdgeWorker
Get
Activation
Code bundle
Contracts
Deactivation
EdgeWorker
EdgeWorker version
Limits
Logging override
Permission group
Properties
Report
Resource tiers
Revision
Revision activation
Revision BOM
Revision code bundle
New
Activation
Deactivation
EdgeWorker
EdgeWorker version
Revision activation
Secure token
Logging override
Remove
Activation
EdgeWorker
EdgeWorker version
Set
EdgeWorker
Revision
Test
Code bundle
Undo
Activation
Firewall Rules Notification
Manage email notifications
Function index
Get
CIDR blocks
Service
Subscriptions
New
Subscriptions
Remove
Subscriptions
Set
Subscriptions
Global Traffic Management
Function index
Get
AS map
CIDR map
Contract
Datacenter
Datacenter latency
Demand
Domain
Domain authorities
Domain history
Domain list
Domain status
Domain summary
Geo map
Group
Identity
IP availability per property
Liveness tests per property
Liveness test error
Load data
Load feedback report
Property
Resource
Traffic report per datacenter
Traffic report per property
New
AS map
CIDR map
Datacenter
Default datacenter
Default IP datacenter
Domain
Geo map
Property
Resource
Remove
AS map
CIDR map
Datacenter
Geo map
Property
Resource
Set
AS map
CIDR map
Datacenter
Domain
Geo map
Property
Resource
Submit
Load data
Identity & Access Management
Control access
User
Admin
Function index
Block
Property users
Disable
API credential
IP allowlist
Enable
IP allowlist
Get
Accessible groups
Account switch key
Admin contact types
Admin countries
Admin languages
Admin password policy
Admin products
Admin states
Admin timeout policy
Admin time zones
Allowed APIs
Allowed CP codes
API client
API credential
Authorized users
Blocked properties
CIDR block
Grantable roles
Group
IP allowlist status
Property
Property resources
Property users
Role
User
Users affected by moving group
User contact types
User countries
User languages
User password policy
User products
User profile
User states
User timeout policy
User time zones
Lock
API client
User
Move
Group
Property
New
API client
API credential
CIDR block
Group
Role
User
Remove
API client
API credential
CIDR block
Group
Role
User
Reset
Multi-factor authentication
User password
Set
API client
API credential
Blocked properties
CIDR block
Group
Group & role assignments
Multi-factor authentication
Role
User
User notifications
User password
User profile
Test
CIDR block
Unlock
API client
User
Image & Video Manager
Manage policy rules
Transform images
Function index
Get
Error details
Image
Log details
Policy
Policy history
Policy set
New
Policy
Policy set
Restore
Policy
Remove
Policy
Policy set
Set
Policy
Policy set
Media Services Live
Function index
Get
CDNs
Contracts
CP codes per origin
CP codes per type
Migration
Origin
Publishing locations
Stream
VOD origins
New
CP code
Key
Migration
Origin
Stream
Remove
Origin
Stream
Set
Origin
Stream
Undo
Migration
Mutual TLS Edge Truststore
Manage certificate authority sets
Function index
Copy
CA set
CA set version
Get
CA set
CA set activation
CA set activities
CA set association
CA set deletion requests
CA set version
CA set version certificate
New
CA set
CA set activation
CA set deactivation
CA set version
Remove
CA set
CA set version
Set
CA set version
Test
Test version
Mutual TLS Origin Keystore
Manage client certificates
Function index
Complete
Client cert version
Get
CA cert
Client cert
Client cert version
New
Client cert
Client cert version
Remove
Client cert version
Set
Client cert
NetStorage
Provision storage
Configuration
Function index
Add
FTP key
HTTP key
Rsync key
SSH key
Disable
FTP key
HTTP key
Rsync key
SSH key
Upload account
Enable
FTP key
HTTP key
Rsync key
SSH key
Upload account
Get
CP code
Directory
Directory usage
Group
Purge routine
Rule set
Snapshot
Upload account
Zones
Measure
Object
New
CP code
Credentials
Directory
Group
Rule set
Snapshot
Symlink
Upload account
Read
Directory
Object
Remove
CP code
Directory
FTP key
Group
HTTP key
Object
Purge routine
Rule set
Rsync key
Snapshot
SSHKey
Upload account
Rename
Object
Set
FTP key
Group
Object modification time
Purge routine
Rule set
Snapshot
Upload account
Start
Snapshot
Update
FTP key
Write
Object
Restore
CP code
Group
Network Lists
Configure network lists
Function index
Add
Item
New
Activation
Network list
Subscription
Get
Activation
Activation status
Network list
Snapshot
Set
Network list
Remove
Item
Network list
Subscription
Property
Provision properties
Properties
Rules
Includes
Function index
Add
Bucket hostname
Include rule
Property hostname
Property rule
Compare
Bucket hostname
Copy
Property
Include
Find
Property
Get
Account ID
Bucket activation
Bucket hostname
Bulk activated property
Bulk-patched property
Bulk search result
Bulk-versioned property
Custom behavior
Custom override
CP code
Domain ownership challenge
Edge hostname
Group
Hostname audit history
Include
Include activation
Include behaviors
Include criteria
Include parent
Include rules
Include rules digest
Include version
Product
Property
Property activation
Property behaviors
Property build
Property certificate challenge
Property client settings
Property contract
Property criteria
Property hostname
Product use cases
Property request schema
Property rules
Property rules digest
Property version
Property version's includes
Rule format
Rule format schema
Top-level groups
Merge
Property rules
New
Bulk activation
Bulk patch
Bulk search
Bulk version
CP code
Edge hostname
Include
Include activation
Include deactivation
Include version
Property
Property activation
Property deactivation
Property version
Remove
Bucket hostname
Include
Include rule
Property
Property hostname
Property rule
Resume
Domain validation
Set
Client settings
Include rules
Property hostname
Property rules
Test
Include
Include rule
Property rule
Undo
Bucket activation
Include activation
Property activation
Update
Domain validation
Include rule
Property rule
Purge
Purge cache
Function index
Clear
Akamai cache
Get
Get-PurgeLimit
Reporting
Monitor performance
Function index
Get
Legacy report
Legacy report type
Legacy report type versions
Product family
Report
Report type
Reporting area
New
Legacy report
Report
SIEM
Manage security events
Function index
Format
SIEM event
Get
SIEM data
Site Shield
Route traffic
Function index
Confirm
Site shield map
Get
Site shield map
SLA
Set up SLA test configurations
Function index
Get
Availability report
Performance report
Test agent group
Test configuration
Test configuration quota
New
Test configuration
Remove
Test configuration
Set
Test configuration
Test Center
Manage tests
Function index
Get
Test case
Test catalog template
Test condition
Test request
Test run
Test run results
Test suite
Test variable
Initalize
Test suite
New
Test case
Test suite
Test variable
Remove
Test case
Test suite
Test variable
Restore
Test case
Test suite
Set
Test case
Test case order
Test suite
Test variable
Start
Property version test
Test
Test suite
Test
Test
API Definitions
Get
Endpoint version summary
Get-APIEndpointVersionSummary
Copy Page
Akamai.com
Contact us
Akamai support
Compute support
Share feedback
Try Akamai
Log in
Log out
Try Akamai
Akamai.com
Contact us
Akamai support
Compute support
Share feedback
Log in
Log out
