{ "opencollection": "1.0.0", "info": { "name": "Akamai: Application Security Activation history WAF rules: Rapid rules API", "version": "v1" }, "items": [ { "info": { "name": "WAF rules: Rapid rules", "type": "folder" }, "items": [ { "info": { "name": "Akamai API Security List Rapid Rules", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns rapid rules. [Rapid rules are WAF rules we are actively testing and refining.](https://techdocs.akamai.com/application-security/docs/rapid-rules) You can start using them while we revise them. Once we complete fine-tuning a rule, it becomes a WAF rule you can access through [List rules](https://techdocs.akamai.com/application-security/docs/get-policy-rules). " }, { "info": { "name": "Akamai API Security Get Rapid Rules' Default Action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns the default action set for all rapid rules. To override this setting for an individual rule, run [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action)." }, { "info": { "name": "Akamai API Security Update Rapid Rules' Default Action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/action", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set rapid rules default action. This applies to _all_ rapid rules by default unless you specifically override this setting for an individual rule with [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action)." }, { "info": { "name": "Akamai API Security Get Rapid Rules' Status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns whether rapid rules are enabled or disabled. " }, { "info": { "name": "Akamai API Security Update Rapid Rules' Status", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/status", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable all rapid rules." }, { "info": { "name": "Akamai API Security List a Rapid Rule's Conditions and Exceptions", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns the conditions and exceptions set for the rapid rule." }, { "info": { "name": "Akamai API Security Update a Rapid Rule's Conditions and Exceptions", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/condition-exception", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the rapid rule's conditions and exceptions" }, { "info": { "name": "Akamai API Security Get a Rapid Rule's Lock Status", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns the rapid rule lock status. When locked, the action set for the rapid rule applies to all new versions of that rule. " }, { "info": { "name": "Akamai API Security Update a Rapid Rule's Lock Status", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/lock", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the rapid rule lock status. When enabled, the action set for the rapid rule applies to all new versions of that rule." }, { "info": { "name": "Akamai API Security Get a Rapid Rule's Action", "type": "http" }, "http": { "method": "GET", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "ruleVersion", "value": "{{ruleVersion}}", "type": "path", "description": "A unique identifier for each version of a rapid rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ] }, "docs": "Returns the action for a single rapid rule. Run [Update a rapid rule's action](https://techdocs.akamai.com/application-security/docs/put-policy-rapid-rule-action) if you want to set different actions for each rule, or override the default action for a single rule. " }, { "info": { "name": "Akamai API Security Update a Rapid Rule's Action", "type": "http" }, "http": { "method": "PUT", "url": "https://{hostname}/appsec/v1/configs/:configId/versions/:versionNumber/security-policies/:policyId/rapid-rules/:ruleId/versions/:ruleVersion/action", "params": [ { "name": "configId", "value": "{{configId}}", "type": "path", "description": "A unique identifier for each configuration." }, { "name": "versionNumber", "value": "{{versionNumber}}", "type": "path", "description": "A unique identifier for each version of a configuration." }, { "name": "policyId", "value": "{{policyId}}", "type": "path", "description": "A unique identifier for a security policy." }, { "name": "ruleId", "value": "{{ruleId}}", "type": "path", "description": "A unique identifier for rule." }, { "name": "ruleVersion", "value": "{{ruleVersion}}", "type": "path", "description": "A unique identifier for each version of a rapid rule." }, { "name": "accountSwitchKey", "value": "{{accountSwitchKey}}", "type": "query", "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the rapid rule's action. Run this operation if you want to set different actions for each rule, or override the default action for a single rule." } ] } ], "bundled": true }