Jump to Content

API Release notes Terraform

Training Support Community

API

Training Support Community

API Release notes Terraform

API

Application Security API
API summary
OpenAPI schema
Get Started
- Set up your API token
API concepts
API workflows
Rate limiting
Enumeration values
Errors
- 400
- 401
- 403
- 404
- 409
- 429

Configuration settings

General configuration settings
Match targets
Prefetch requests
- Get prefetch requestsget
- Modify prefetch requestsput
Shared resources: Rate policies
SIEM settings
URL protection policies
Hostnames
Shared resources: Malware policies
Shared resources: Custom rules
PII learning
- Get PII learning settings for a configurationget
- Enable PII learning settings for a configurationput
Shared resources: Custom deny actions
Bypass network lists
- Get bypass network lists settingsget
- Modify the bypass network lists settingsput
Failover hostnames
- List failover hostnamesget
Shared resources: Reputation profiles
Request body size
- Get request body size settings for a configurationget
- Modify request body inspection limit settings for a configurationput
Cookie Settings
- Get cookie settingsget
- Modify cookie settingsput
Evasive path match
- Get evasive path match settings for a configurationget
- Modify evasive path match settings for a configurationput
HTTP header logs
- Get the HTTP header log settings for a configurationget
- Modify HTTP header log settings for a configurationput
Attack payload logs
- Get the attack payload log settings for a configurationget
- Modify attack payload log settings for a configurationput
Pragma settings
- Get Pragma settings for a configurationget
- Modify Pragma settings for a configurationput

Security policies

Rate policy actions
- List rate policy actionsget
- Modify a rate policy actionput
IP/Geo Firewall settings
- Get IP/Geo Firewall settingsget
- Modify IP/Geo Firewall settingsput
Attack payload logs
- Get attack payload logging settings for a policyget
- Modify attack payload logging settings for a policyput
HTTP header logs
- Get HTTP header log settingsget
- Modify HTTP header log settingsput
Client reputation
Custom rule actions
- List custom rule actionsget
- Modify a custom rule actionput
Reputation analysis
- Get reputation analysis settingsget
- Modify reputation analysis settingsput
URL protection policy actions
- List URL protection policy actionsget
- Modify a URL protection policy actionput
Pragma settings
- Get Pragma settings for a security policyget
- Modify Pragma settings for a security policyput
WAF rules: Penalty box conditions
- Get penalty box conditionget
- Modify the penalty box conditionsput
WAF rules: Penalty box
- Get the penalty boxget
- Modify the penalty boxput
Slow POST protections
- Get slow POST protection settingsget
- Modify slow POST protection settingsput
WAF rules: Tuning recommendations
WAF rules: Attack groups
WAF rules: Update mode
- Get the current modeget
- Modify the modeput
General policy settings
WAF rules: General settings
API request constraints
WAF rules: Protections
- Get protectionsget
- Modify protectionsput
Evasive path match
- Get evasive path match settingsget
- Modify evasive path match settingsput
Malware policy actions
- List malware policy actionsget
- Modify a malware policy actionput
Request body inspection limits
- Get request body inspection limit settings for a security policyget
- Modify request body size settings for a security policyput
API endpoints
- List API endpointsget
Bypass network lists
- Get the bypass network lists settings for a security policyget
- Modify the bypass network lists settings for a security policyput
Client-Side Protections & Compliance
- Get Client-Side Protection & Compliance settingsget
- Modify Client-Side Protections & Compliance settingsput
Hostnames
- List selected hostnames for a security policyget
- Modify selected hostnames for a security policyput

Evaluation mode

Security policy: Conditions and exceptions
Security policy: Evaluation hostnames
Security policy: Evaluation mode
- Set evaluation modepost
Security policy: Evaluation penalty box
- Get the penalty box for a policy in evaluation modeget
- Modify the evaluation penalty boxput
Security policy: Evaluation rules
Security policy: Evaluation attack groups
WAF rules: Evaluation Penalty box conditions
- Get penalty box conditions in evaluation modeget
- Modify the penalty box conditions in evaluation modeput
Configuration: Evaluation hostnames

Activation and export

Activations
- Activate a configuration versionpost
Configuration version export
- Export a configuration versionget
Activation history
- List activation historyget
Activation status
- Get an activation request statusget
- Get activation statusget
Configuration version diff
- Compare two versionspost

Utilities and account data

Discovered APIs
- List discovered APIsget
- Get a discovered APIget
Subscriptions
- Subscribe or unsubscribe to recommendation emailspost
- List subscribersget
Endpoints
Contracts and groups
- List contracts and groupsget
Available hostnames
- List available hostnames for a new configurationget
Hostname coverage
- Get hostname coverageget

Self-service onboardings

Onboarding: Creation and settings
Onboarding: Activations and status
- Activate an onboardingpost
- Onboarding activation statusget
Onboarding: Post-activation validation

API

Application Security API
API summary
OpenAPI schema
Get Started
- Set up your API token
API concepts
API workflows
Rate limiting
Enumeration values
Errors
- 400
- 401
- 403
- 404
- 409
- 429

Configuration settings

General configuration settings
Match targets
Prefetch requests
- Get prefetch requestsget
- Modify prefetch requestsput
Shared resources: Rate policies
SIEM settings
URL protection policies
Hostnames
Shared resources: Malware policies
Shared resources: Custom rules
PII learning
- Get PII learning settings for a configurationget
- Enable PII learning settings for a configurationput
Shared resources: Custom deny actions
Bypass network lists
- Get bypass network lists settingsget
- Modify the bypass network lists settingsput
Failover hostnames
- List failover hostnamesget
Shared resources: Reputation profiles
Request body size
- Get request body size settings for a configurationget
- Modify request body inspection limit settings for a configurationput
Cookie Settings
- Get cookie settingsget
- Modify cookie settingsput
Evasive path match
- Get evasive path match settings for a configurationget
- Modify evasive path match settings for a configurationput
HTTP header logs
- Get the HTTP header log settings for a configurationget
- Modify HTTP header log settings for a configurationput
Attack payload logs
- Get the attack payload log settings for a configurationget
- Modify attack payload log settings for a configurationput
Pragma settings
- Get Pragma settings for a configurationget
- Modify Pragma settings for a configurationput

Security policies

Rate policy actions
- List rate policy actionsget
- Modify a rate policy actionput
IP/Geo Firewall settings
- Get IP/Geo Firewall settingsget
- Modify IP/Geo Firewall settingsput
Attack payload logs
- Get attack payload logging settings for a policyget
- Modify attack payload logging settings for a policyput
HTTP header logs
- Get HTTP header log settingsget
- Modify HTTP header log settingsput
Client reputation
Custom rule actions
- List custom rule actionsget
- Modify a custom rule actionput
Reputation analysis
- Get reputation analysis settingsget
- Modify reputation analysis settingsput
URL protection policy actions
- List URL protection policy actionsget
- Modify a URL protection policy actionput
Pragma settings
- Get Pragma settings for a security policyget
- Modify Pragma settings for a security policyput
WAF rules: Penalty box conditions
- Get penalty box conditionget
- Modify the penalty box conditionsput
WAF rules: Penalty box
- Get the penalty boxget
- Modify the penalty boxput
Slow POST protections
- Get slow POST protection settingsget
- Modify slow POST protection settingsput
WAF rules: Tuning recommendations
WAF rules: Attack groups
WAF rules: Update mode
- Get the current modeget
- Modify the modeput
General policy settings
WAF rules: General settings
API request constraints
WAF rules: Protections
- Get protectionsget
- Modify protectionsput
Evasive path match
- Get evasive path match settingsget
- Modify evasive path match settingsput
Malware policy actions
- List malware policy actionsget
- Modify a malware policy actionput
Request body inspection limits
- Get request body inspection limit settings for a security policyget
- Modify request body size settings for a security policyput
API endpoints
- List API endpointsget
Bypass network lists
- Get the bypass network lists settings for a security policyget
- Modify the bypass network lists settings for a security policyput
Client-Side Protections & Compliance
- Get Client-Side Protection & Compliance settingsget
- Modify Client-Side Protections & Compliance settingsput
Hostnames
- List selected hostnames for a security policyget
- Modify selected hostnames for a security policyput

Evaluation mode

Security policy: Conditions and exceptions
Security policy: Evaluation hostnames
Security policy: Evaluation mode
- Set evaluation modepost
Security policy: Evaluation penalty box
- Get the penalty box for a policy in evaluation modeget
- Modify the evaluation penalty boxput
Security policy: Evaluation rules
Security policy: Evaluation attack groups
WAF rules: Evaluation Penalty box conditions
- Get penalty box conditions in evaluation modeget
- Modify the penalty box conditions in evaluation modeput
Configuration: Evaluation hostnames

Activation and export

Activations
- Activate a configuration versionpost
Configuration version export
- Export a configuration versionget
Activation history
- List activation historyget
Activation status
- Get an activation request statusget
- Get activation statusget
Configuration version diff
- Compare two versionspost

Utilities and account data

Discovered APIs
- List discovered APIsget
- Get a discovered APIget
Subscriptions
- Subscribe or unsubscribe to recommendation emailspost
- List subscribersget
Endpoints
Contracts and groups
- List contracts and groupsget
Available hostnames
- List available hostnames for a new configurationget
Hostname coverage
- Get hostname coverageget

Self-service onboardings

Onboarding: Creation and settings
Onboarding: Activations and status
- Activate an onboardingpost
- Onboarding activation statusget
Onboarding: Post-activation validation

Get a security configuration

get https://{hostname}/appsec/v1/configs/{configId}

Retrieves the configuration details.

Language

URL

Click Try It! to start a request and see the response here!

Akamai.com

Linode.com

Akamai support Linode support Share feedback

Log out

Try Akamai

Akamai.com

Linode.com

Contact us Akamai support Linode support Share feedback

Log out