{ "provider": "Akamai", "providerId": "akamai", "kind": "json-structure", "description": "Structural overview of the Akamai API surface; extracted from openapi/.", "schemaCount": 83, "operationCount": 236, "schemas": [ { "name": "attack-payload-logging", "type": "object", "propertyCount": 1, "required": [ "type" ] }, { "name": "attack-payload-logging-get-200", "type": "object", "propertyCount": 3, "required": [ "enabled", "requestBody", "responseBody" ] }, { "name": "attack-payload-logging-put", "type": "object", "propertyCount": 3, "required": [ "enabled", "requestBody", "responseBody" ] }, { "name": "attack-payload-logging-put-200", "type": "object", "propertyCount": 3, "required": [ "enabled", "requestBody", "responseBody" ] }, { "name": "behavioral-ddos-bypass-client-list-condition", "type": "object", "propertyCount": 4, "required": [ "className", "value" ] }, { "name": "behavioral-ddos-bypass-request-header-condition", "type": "object", "propertyCount": 7, "required": [ "className", "name" ] }, { "name": "behavioral-ddos-host-path-exception", "type": "object", "propertyCount": 2, "required": [ "hosts", "paths" ] }, { "name": "behavioral-ddos-profile", "type": "object", "propertyCount": 16, "required": [ "name", "sensitivity", "hostnames" ] }, { "name": "behavioral-ddos-profiles", "type": "object", "propertyCount": 1, "required": [ "behavioralDdosProfiles" ] }, { "name": "behavioral-ddos-sensitivity-override", "type": "object", "propertyCount": 3, "required": [ "host", "path", "sensitivity" ] }, { "name": "behavioral-ddos-suspend", "type": "object", "propertyCount": 3, "required": [ "hostnames", "fromDate", "toDate" ] }, { "name": "bypass-network-lists-get", "type": "object", "propertyCount": 1, "required": [ "networkLists" ] }, { "name": "bypass-network-lists-put", "type": "object", "propertyCount": 1, "required": [ "networkLists" ] }, { "name": "client-reputation-condition", "type": "object", "propertyCount": 5, "required": [ "className", "name", "value", "sharedIpHandling" ] }, { "name": "config-clone-post", "type": "object", "propertyCount": 2, "required": [ "createFromVersion", "ruleUpdate" ] }, { "name": "config-custom-rules-usage-request", "type": "object", "propertyCount": 1, "required": [ "ruleIds" ] }, { "name": "config-custom-rules-usage-response", "type": "object", "propertyCount": 1, "required": [ "rules" ] }, { "name": "config-get", "type": "object", "propertyCount": 7, "required": [ "id", "latestVersion", "name" ] }, { "name": "config-post", "type": "object", "propertyCount": 8, "required": [ "name", "description", "hostnames" ] }, { "name": "config-rename", "type": "object", "propertyCount": 2, "required": [ "name" ] }, { "name": "configs-get", "type": "object", "propertyCount": 1, "required": [ "configurations" ] }, { "name": "cookie-settings", "type": "object", "propertyCount": 2, "required": [] }, { "name": "custom-denies", "type": "object", "propertyCount": 1, "required": [] }, { "name": "custom-deny", "type": "object", "propertyCount": 4, "required": [ "name", "parameters" ] }, { "name": "custom-rule", "type": "object", "propertyCount": 16, "required": [ "name", "operation", "structured" ] }, { "name": "custom-rules", "type": "object", "propertyCount": 1, "required": [ "customRules" ] }, { "name": "effectiveTimePeriod", "type": "object", "propertyCount": 3, "required": [ "endDate", "startDate" ] }, { "name": "evasive-path-match-get-200", "type": "object", "propertyCount": 1, "required": [ "enablePathMatch" ] }, { "name": "evasive-path-match-put", "type": "object", "propertyCount": 1, "required": [ "enablePathMatch" ] }, { "name": "evasive-path-match-put-200", "type": "object", "propertyCount": 1, "required": [ "enablePathMatch" ] }, { "name": "header-logging-get-200", "type": "object", "propertyCount": 4, "required": [ "allowSampling", "cookies", "customHeaders", "standardHeaders" ] }, { "name": "header-logging-put", "type": "object", "propertyCount": 4, "required": [ "allowSampling" ] }, { "name": "header-logging-put-200", "type": "object", "propertyCount": 4, "required": [ "allowSampling", "cookies", "customHeaders", "standardHeaders" ] }, { "name": "host-info-in-config", "type": "object", "propertyCount": 6, "required": [ "configId", "configVersion", "protectARLInclusionHost" ] }, { "name": "hostname-coverage-match-target", "type": "object", "propertyCount": 16, "required": [ "type", "securityPolicy" ] }, { "name": "hostname-coverage-match-target-get-200", "type": "object", "propertyCount": 1, "required": [ "matchTargets" ] }, { "name": "hostname-coverage-overlapping-get-200", "type": "object", "propertyCount": 1, "required": [ "overLappingList" ] }, { "name": "hostname-object", "type": "object", "propertyCount": 6, "required": [ "hostname" ] }, { "name": "hostnames", "type": "object", "propertyCount": 2, "required": [ "hostnameList" ] }, { "name": "ja4-client-tls-fingerprint-get-200", "type": "object", "propertyCount": 1, "required": [] }, { "name": "ja4-client-tls-fingerprint-put", "type": "object", "propertyCount": 1, "required": [] }, { "name": "ja4-client-tls-fingerprint-put-200", "type": "object", "propertyCount": 1, "required": [] }, { "name": "logging-header-setting", "type": "object", "propertyCount": 2, "required": [ "type" ] }, { "name": "logging-option", "type": "object", "propertyCount": 3, "required": [ "id" ] }, { "name": "malware-policies", "type": "object", "propertyCount": 1, "required": [ "malwarePolicies" ] }, { "name": "malware-policies-content-types", "type": "object", "propertyCount": 1, "required": [ "malwareContentTypes" ] }, { "name": "malware-policy", "type": "object", "propertyCount": 9, "required": [ "name", "hostnames", "paths" ] }, { "name": "match-target", "type": "object", "propertyCount": 16, "required": [ "type", "securityPolicy" ] }, { "name": "match-targets", "type": "object", "propertyCount": 1, "required": [ "matchTargets" ] }, { "name": "match-targets-sequence", "type": "object", "propertyCount": 2, "required": [ "type", "targetSequence" ] }, { "name": "overlap-config", "type": "object", "propertyCount": 6, "required": [ "configId", "configName", "configVersion" ] }, { "name": "pii-learning", "type": "object", "propertyCount": 1, "required": [ "enablePiiLearning" ] }, { "name": "pragma-header", "type": "object", "propertyCount": 4, "required": [ "action" ] }, { "name": "prefetch-request-get-200", "type": "object", "propertyCount": 4, "required": [ "allExtensions", "enableAppLayer", "enableRateControls" ] }, { "name": "prefetch-request-put", "type": "object", "propertyCount": 4, "required": [] }, { "name": "prefetch-request-put-200", "type": "object", "propertyCount": 4, "required": [ "allExtensions", "enableAppLayer", "enableRateControls" ] }, { "name": "problem-details", "type": "object", "propertyCount": 6, "required": [ "title", "type", "detail", "instance", "status" ] }, { "name": "rate-policies", "type": "object", "propertyCount": 1, "required": [ "ratePolicies" ] }, { "name": "rate-policy", "type": "object", "propertyCount": 30, "required": [ "matchType", "type", "name", "averageThreshold", "burstThreshold", "clientIdentifier", "requestType", "sameActionOnIpv6", "pathMatchType" ] }, { "name": "rate-policy-evaluation-put", "type": "object", "propertyCount": 1, "required": [ "action" ] }, { "name": "reputation-profile", "type": "object", "propertyCount": 9, "required": [ "name", "context", "threshold", "sharedIpHandling" ] }, { "name": "reputation-profiles", "type": "object", "propertyCount": 1, "required": [] }, { "name": "request-body", "type": "object", "propertyCount": 1, "required": [] }, { "name": "request-header-condition-2", "type": "object", "propertyCount": 7, "required": [ "className", "name" ] }, { "name": "security-controls", "type": "object", "propertyCount": 7, "required": [ "applyApplicationLayerControls", "applyNetworkLayerControls", "applyRateControls", "applyReputationControls", "applyBotmanControls", "applyApiConstraints", "applySlowPostControls" ] }, { "name": "siem-settings", "type": "object", "propertyCount": 7, "required": [ "enableSiem" ] }, { "name": "siem-version", "type": "object", "propertyCount": 2, "required": [ "id", "name" ] }, { "name": "siem-versions", "type": "object", "propertyCount": 1, "required": [] }, { "name": "tls-fingerprint-condition", "type": "object", "propertyCount": 3, "required": [ "className", "value" ] }, { "name": "url-protection-bypass-client-list-condition", "type": "object", "propertyCount": 4, "required": [ "className", "value" ] }, { "name": "url-protection-bypass-request-header-condition", "type": "object", "propertyCount": 7, "required": [ "className", "name" ] }, { "name": "url-protection-category", "type": "object", "propertyCount": 1, "required": [ "type" ] }, { "name": "url-protection-client-list-category", "type": "object", "propertyCount": 3, "required": [ "type" ] }, { "name": "url-protection-policies", "type": "object", "propertyCount": 1, "required": [ "urlProtectionPolicies" ] }, { "name": "url-protection-policy", "type": "object", "propertyCount": 18, "required": [ "intelligentLoadShedding", "rateThreshold", "name" ] }, { "name": "url-protection-policy-hostpath", "type": "object", "propertyCount": 2, "required": [ "hostname", "paths" ] }, { "name": "validation", "type": "object", "propertyCount": 5, "required": [ "title", "type" ] }, { "name": "validations", "type": "object", "propertyCount": 3, "required": [ "notices", "errors", "warnings" ] }, { "name": "version-notes-get-200", "type": "object", "propertyCount": 1, "required": [] }, { "name": "version-notes-put", "type": "object", "propertyCount": 1, "required": [] }, { "name": "version-notes-put-200", "type": "object", "propertyCount": 1, "required": [] }, { "name": "waf-config-version", "type": "object", "propertyCount": 9, "required": [ "configId", "configName", "version", "staging", "production" ] }, { "name": "waf-config-versions", "type": "object", "propertyCount": 11, "required": [ "configId", "configName", "lastCreatedVersion", "page", "pageSize", "totalSize" ] } ], "operations": [ { "method": "POST", "path": "/activations", "operationId": "post-activations", "summary": "Activate a configuration version", "tags": [ "Activations" ] }, { "method": "GET", "path": "/activations/status/{statusId}", "operationId": "get-activations-status", "summary": "Get an activation request status", "tags": [ "Activation status" ] }, { "method": "GET", "path": "/activations/{activationId}", "operationId": "get-activation", "summary": "Get activation status", "tags": [ "Activation status" ] }, { "method": "GET", "path": "/api-discovery", "operationId": "get-api-list", "summary": "List discovered APIs", "tags": [ "Discovered APIs" ] }, { "method": "GET", "path": "/api-discovery/host/{hostname}/basepath/{basePath}", "operationId": "get-api-details", "summary": "Get a discovered API", "tags": [ "Discovered APIs" ] }, { "method": "PUT", "path": "/api-discovery/host/{hostname}/basepath/{basePath}", "operationId": "put-api-visibility", "summary": "Modify an API's visibility", "tags": [ "Endpoints" ] }, { "method": "GET", "path": "/api-discovery/host/{hostname}/basepath/{basePath}/endpoints", "operationId": "get-discovered-api-endpoints", "summary": "List discovered API endpoints", "tags": [ "Endpoints" ] }, { "method": "POST", "path": "/api-discovery/host/{hostname}/basepath/{basePath}/endpoints", "operationId": "post-api-endpoint-resource", "summary": "Create an endpoint or resource", "tags": [ "Endpoints" ] }, { "method": "GET", "path": "/configs", "operationId": "get-configs", "summary": "List configurations", "tags": [ "General configuration settings" ] }, { "method": "POST", "path": "/configs", "operationId": "post-config", "summary": "Create a configuration", "tags": [ "General configuration settings" ] }, { "method": "GET", "path": "/configs/{configId}", "operationId": "get-config", "summary": "Get a security configuration", "tags": [ "General configuration settings" ] }, { "method": "PUT", "path": "/configs/{configId}", "operationId": "put-config", "summary": "Rename a security configuration", "tags": [ "General configuration settings" ] }, { "method": "DELETE", "path": "/configs/{configId}", "operationId": "delete-config", "summary": "Delete a configuration", "tags": [ "General configuration settings" ] }, { "method": "GET", "path": "/configs/{configId}/activations", "operationId": "get-activation-history", "summary": "List activation history", "tags": [ "Activation history" ] }, { "method": "GET", "path": "/configs/{configId}/custom-rules", "operationId": "get-configs-custom-rules", "summary": "List custom rules", "tags": [ "Shared resources: Custom rules" ] }, { "method": "POST", "path": "/configs/{configId}/custom-rules", "operationId": "post-config-custom-rules", "summary": "Create a custom rule", "tags": [ "Shared resources: Custom rules" ] }, { "method": "GET", "path": "/configs/{configId}/custom-rules/{ruleId}", "operationId": "get-config-custom-rule", "summary": "Get a custom rule", "tags": [ "Shared resources: Custom rules" ] }, { "method": "PUT", "path": "/configs/{configId}/custom-rules/{ruleId}", "operationId": "put-config-custom-rule", "summary": "Modify a custom rule", "tags": [ "Shared resources: Custom rules" ] }, { "method": "DELETE", "path": "/configs/{configId}/custom-rules/{ruleId}", "operationId": "delete-config-custom-rule", "summary": "Remove a custom rule", "tags": [ "Shared resources: Custom rules" ] }, { "method": "GET", "path": "/configs/{configId}/failover-hostnames", "operationId": "get-failover-hostnames", "summary": "List failover hostnames", "tags": [ "Failover hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/notification/subscription/{feature}", "operationId": "get-subscription-feature", "summary": "List subscribers", "tags": [ "Subscriptions" ] }, { "method": "POST", "path": "/configs/{configId}/notification/subscription/{feature}", "operationId": "post-subscription-feature", "summary": "Subscribe or unsubscribe to recommendation emails", "tags": [ "Subscriptions" ] }, { "method": "GET", "path": "/configs/{configId}/versions", "operationId": "get-config-versions", "summary": "List configuration versions", "tags": [ "General configuration settings" ] }, { "method": "POST", "path": "/configs/{configId}/versions", "operationId": "post-config-versions", "summary": "Clone a configuration version", "tags": [ "General configuration settings" ] }, { "method": "POST", "path": "/configs/{configId}/versions/diff", "operationId": "post-config-versions-diff", "summary": "Compare two versions", "tags": [ "Configuration version diff" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}", "operationId": "get-version-number", "summary": "Get configuration version details", "tags": [ "General configuration settings" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}", "operationId": "delete-version-number", "summary": "Delete a configuration version", "tags": [ "General configuration settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/cookie-settings", "operationId": "get-advanced-settings-cookie-settings", "summary": "Get cookie settings", "tags": [ "Cookie Settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/cookie-settings", "operationId": "put-advanced-settings-cookie-settings", "summary": "Modify cookie settings", "tags": [ "Cookie Settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/evasive-path-match", "operationId": "get-evasive-path-match-per-config", "summary": "Get evasive path match settings for a configuration", "tags": [ "Evasive path match" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/evasive-path-match", "operationId": "put-evasive-path-match-per-config", "summary": "Modify evasive path match settings for a configuration", "tags": [ "Evasive path match" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/ja4-fingerprint", "operationId": "get-ja4-fingerprint-settings", "summary": "Get JA4 client TLS fingerprint settings", "tags": [ "JA4 Client TLS Fingerprint" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/ja4-fingerprint", "operationId": "put-ja4-fingerprint-settings", "summary": "Modify JA4 client TLS fingerprint settings", "tags": [ "JA4 Client TLS Fingerprint" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/logging", "operationId": "get-advanced-settings-logging", "summary": "Get the HTTP header log settings for a configuration", "tags": [ "HTTP header logs" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/logging", "operationId": "put-advanced-settings-logging", "summary": "Modify HTTP header log settings for a configuration", "tags": [ "HTTP header logs" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/logging/attack-payload", "operationId": "get-advanced-settings-attack-payload-logging", "summary": "Get the attack payload log settings for a configuration", "tags": [ "Attack payload logs" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/logging/attack-payload", "operationId": "put-advanced-settings-attack-payload-logging", "summary": "Modify attack payload log settings for a configuration", "tags": [ "Attack payload logs" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning", "operationId": "get-advanced-settings-pii-learning", "summary": "Get PII learning settings for a configuration", "tags": [ "PII learning" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/pii-learning", "operationId": "put-advanced-settings-pii-learning", "summary": "Enable PII learning settings for a configuration", "tags": [ "PII learning" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/pragma-header", "operationId": "get-advanced-settings-pragma-header", "summary": "Get Pragma settings for a configuration", "tags": [ "Pragma settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/pragma-header", "operationId": "put-advanced-settings-pragma-header", "summary": "Modify Pragma settings for a configuration", "tags": [ "Pragma settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/prefetch", "operationId": "get-advanced-settings-prefetch", "summary": "Get prefetch requests", "tags": [ "Prefetch requests" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/prefetch", "operationId": "put-advanced-settings-prefetch", "summary": "Modify prefetch requests", "tags": [ "Prefetch requests" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/request-body", "operationId": "get-advanced-settings-request-body", "summary": "Get request body size settings for a configuration", "tags": [ "Request body size" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/advanced-settings/request-body", "operationId": "put-advanced-settings-request-body", "summary": "Modify request body inspection limit settings for a configuration", "tags": [ "Request body size" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/behavioral-ddos", "operationId": "get-behavioral-ddos-profiles", "summary": "List Behavioral DDoS profiles", "tags": [ "Behavioral DDoS profiles" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/behavioral-ddos", "operationId": "post-behavioral-ddos-profile", "summary": "Create a Behavioral DDoS profile", "tags": [ "Behavioral DDoS profiles" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/behavioral-ddos/{profileId}", "operationId": "get-behavioral-ddos-profile", "summary": "Get a Behavioral DDoS profile", "tags": [ "Behavioral DDoS protection profiles" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/behavioral-ddos/{profileId}", "operationId": "put-behavioral-ddos-profile", "summary": "Modify a Behavioral DDoS profile", "tags": [ "Behavioral DDoS protection profiles" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/behavioral-ddos/{profileId}", "operationId": "delete-behavioral-ddos-profile", "summary": "Remove a Behavioral DDoS profile", "tags": [ "Behavioral DDoS profiles" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/bypass-network-lists", "operationId": "get-bypass-network-lists", "summary": "Get bypass network lists settings", "tags": [ "Bypass network lists" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/bypass-network-lists", "operationId": "put-bypass-network-lists", "summary": "Modify the bypass network lists settings", "tags": [ "Bypass network lists" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/custom-deny", "operationId": "get-custom-deny-actions", "summary": "List custom deny actions", "tags": [ "Shared resources: Custom deny actions" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/custom-deny", "operationId": "post-custom-deny", "summary": "Create a custom deny action", "tags": [ "Shared resources: Custom deny actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId}", "operationId": "get-custom-deny-action", "summary": "Get a custom deny action", "tags": [ "Shared resources: Custom deny actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId}", "operationId": "put-custom-deny", "summary": "Modify a custom deny action", "tags": [ "Shared resources: Custom deny actions" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/custom-deny/{customDenyId}", "operationId": "delete-custom-deny", "summary": "Remove a custom deny action", "tags": [ "Shared resources: Custom deny actions" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/custom-rules/usage", "operationId": "post-config-custom-rules-usage", "summary": "List custom rules usage by security policies", "tags": [ "Shared resources: Custom rules" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/export", "operationId": "post-export-config-version-async-task", "summary": "Asynchronously export a configuration version", "tags": [ "Configuration version export" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/export/{exportId}/result", "operationId": "get-export-config-version-async-result", "summary": "Get asynchronous export results", "tags": [ "Configuration version export" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/export/{exportId}/status", "operationId": "get-export-config-version-async-task-status", "summary": "Get asynchronous export status", "tags": [ "Configuration version export" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/hostname-coverage/match-targets", "operationId": "get-coverage-match-targets", "summary": "Get the hostname coverage match targets", "tags": [ "Match targets" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/hostname-coverage/overlapping", "operationId": "get-hostname-coverage-overlapping", "summary": "List hostname overlaps", "tags": [ "Hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies", "operationId": "get-malware-policies", "summary": "List malware policies", "tags": [ "Shared resources: Malware policies" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies", "operationId": "post-malware-policies", "summary": "Create a malware policy", "tags": [ "Shared resources: Malware policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies/content-types", "operationId": "get-malware-policy-content-types", "summary": "List supported malware policy content types", "tags": [ "Shared resources: Malware policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId}", "operationId": "get-malware-policy", "summary": "Get a malware policy", "tags": [ "Shared resources: Malware policies" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId}", "operationId": "put-malware-policy", "summary": "Modify a malware policy", "tags": [ "Shared resources: Malware policies" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/malware-policies/{malwarePolicyId}", "operationId": "delete-malware-policy", "summary": "Remove a malware policy", "tags": [ "Shared resources: Malware policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/match-targets", "operationId": "get-match-targets", "summary": "List match targets", "tags": [ "Match targets" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/match-targets", "operationId": "post-match-targets", "summary": "Create a match target", "tags": [ "Match targets" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/match-targets/sequence", "operationId": "put-match-targets-sequence", "summary": "Modify match target order", "tags": [ "Match targets" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/match-targets/{targetId}", "operationId": "get-match-target", "summary": "Get a match target", "tags": [ "Match targets" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/match-targets/{targetId}", "operationId": "put-match-target", "summary": "Modify a match target", "tags": [ "Match targets" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/match-targets/{targetId}", "operationId": "delete-match-target", "summary": "Remove a match target", "tags": [ "Match targets" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/protect-eval-hostnames", "operationId": "put-protect-eval-hostnames", "summary": "Protect evaluation hostnames", "tags": [ "Configuration: Evaluation hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies", "operationId": "get-rate-policies", "summary": "List rate policies", "tags": [ "Shared resources: Rate policies" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies", "operationId": "post-rate-policies", "summary": "Create a rate policy", "tags": [ "Shared resources: Rate policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId}", "operationId": "get-rate-policy", "summary": "Get a rate policy", "tags": [ "Shared resources: Rate policies" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId}", "operationId": "put-rate-policy", "summary": "Modify a rate policy", "tags": [ "Shared resources: Rate policies" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId}", "operationId": "delete-rate-policy", "summary": "Remove a rate policy", "tags": [ "Shared resources: Rate policies" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/rate-policies/{ratePolicyId}/evaluation", "operationId": "put-rate-policy-evaluation", "summary": "Modify a rate policy evaluation", "tags": [ "Shared resources: Rate policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/reputation-profiles", "operationId": "get-reputation-profiles", "summary": "List reputation profiles", "tags": [ "Shared resources: Reputation profiles" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/reputation-profiles", "operationId": "post-reputation-profiles", "summary": "Create a reputation profile", "tags": [ "Shared resources: Reputation profiles" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId}", "operationId": "get-reputation-profile", "summary": "Get a reputation profile", "tags": [ "Shared resources: Reputation profiles" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId}", "operationId": "put-reputation-profile", "summary": "Modify a reputation profile", "tags": [ "Shared resources: Reputation profiles" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/reputation-profiles/{reputationProfileId}", "operationId": "delete-reputation-profile", "summary": "Remove a reputation profile", "tags": [ "Shared resources: Reputation profiles" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions", "operationId": "get-challenge-actions", "summary": "List challenge actions", "tags": [ "Challenge actions" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions", "operationId": "post-challenge-action", "summary": "Create a challenge action", "tags": [ "Challenge actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions/{actionId}", "operationId": "get-challenge-action", "summary": "Get a challenge action", "tags": [ "Challenge actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions/{actionId}", "operationId": "put-challenge-action", "summary": "Update a challenge action", "tags": [ "Challenge actions" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions/{actionId}", "operationId": "delete-challenge-action", "summary": "Delete a challenge action", "tags": [ "Challenge actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/response-actions/challenge-actions/{actionId}/google-recaptcha-secret-key", "operationId": "put-google-recaptcha-secret-key", "summary": "Update Google reCAPTCHA secret key", "tags": [ "Challenge actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies", "operationId": "get-policies", "summary": "List security policies", "tags": [ "General policy settings" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/security-policies", "operationId": "post-policy", "summary": "Clone or create a security policy", "tags": [ "General policy settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}", "operationId": "get-policy", "summary": "Get a security policy", "tags": [ "General policy settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}", "operationId": "put-policy", "summary": "Modify a security policy", "tags": [ "General policy settings" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}", "operationId": "delete-policy", "summary": "Remove a security policy", "tags": [ "General policy settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/evasive-path-match", "operationId": "get-evasive-path-match", "summary": "Get evasive path match settings", "tags": [ "Evasive path match" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/evasive-path-match", "operationId": "put-evasive-path-match", "summary": "Modify evasive path match settings", "tags": [ "Evasive path match" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging", "operationId": "get-policies-logging", "summary": "Get HTTP header log settings", "tags": [ "HTTP header logs" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging", "operationId": "put-policies-logging", "summary": "Modify HTTP header log settings", "tags": [ "HTTP header logs" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging/attack-payload", "operationId": "get-policies-attack-payload-logging", "summary": "Get attack payload logging settings for a policy", "tags": [ "Attack payload logs" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/logging/attack-payload", "operationId": "put-policies-attack-payload-logging", "summary": "Modify attack payload logging settings for a policy", "tags": [ "Attack payload logs" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/pragma-header", "operationId": "get-policies-pragma-header", "summary": "Get Pragma settings for a security policy", "tags": [ "Pragma settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/pragma-header", "operationId": "put-policies-pragma-header", "summary": "Modify Pragma settings for a security policy", "tags": [ "Pragma settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/request-body", "operationId": "get-policies-request-body", "summary": "Get request body inspection limit settings for a security policy", "tags": [ "Request body inspection limits" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/advanced-settings/request-body", "operationId": "put-policies-request-body", "summary": "Modify request body size settings for a security policy", "tags": [ "Request body inspection limits" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints", "operationId": "get-api-endpoints", "summary": "List API endpoints", "tags": [ "API endpoints" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints", "operationId": "get-api-request-constraints", "summary": "List API request constraints and actions", "tags": [ "API request constraints" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints", "operationId": "put-api-request-constraints", "summary": "Modify the request constraint action for all APIs", "tags": [ "API request constraints" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-request-constraints/{apiId}", "operationId": "put-api-request-constraints-api", "summary": "Modify an API request constraint's action", "tags": [ "API request constraints" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups", "operationId": "get-policy-attack-groups", "summary": "List attack groups", "tags": [ "WAF rules: Attack groups" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}", "operationId": "get-policy-attack-group", "summary": "Get the action for an attack group", "tags": [ "WAF rules: Attack groups" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}", "operationId": "put-attack-group", "summary": "Modify the action for an attack group", "tags": [ "WAF rules: Attack groups" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}/condition-exception", "operationId": "get-attack-group-condition-exception", "summary": "Get the exceptions of an attack group", "tags": [ "WAF rules: Attack groups" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/attack-groups/{attackGroupId}/condition-exception", "operationId": "put-attack-group-condition-exception", "summary": "Modify the exceptions of an attack group", "tags": [ "WAF rules: Attack groups" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/behavioral-ddos", "operationId": "get-behavioral-ddos-actions", "summary": "List Behavioral DDoS profile actions", "tags": [ "Behavioral DDoS profile actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/behavioral-ddos/{profileId}", "operationId": "put-behavioral-ddos-profile-action", "summary": "Modify a Behavioral DDoS profile action", "tags": [ "Behavioral DDoS profile actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/bypass-network-lists", "operationId": "get-bypass-network-lists-per-policy", "summary": "Get the bypass network lists settings for a security policy", "tags": [ "Bypass network lists" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/bypass-network-lists", "operationId": "put-bypass-network-lists-per-policy", "summary": "Modify the bypass network lists settings for a security policy", "tags": [ "Bypass network lists" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/cpc", "operationId": "get-policy-cpc", "summary": "Get Client-Side Protection & Compliance settings", "tags": [ "Client-Side Protections & Compliance" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/cpc", "operationId": "put-policy-cpc", "summary": "Modify Client-Side Protections & Compliance settings", "tags": [ "Client-Side Protections & Compliance" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules", "operationId": "get-custom-rules", "summary": "List custom rule actions", "tags": [ "Custom rule actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules/{ruleId}", "operationId": "put-custom-rule", "summary": "Modify a custom rule action", "tags": [ "Custom rule actions" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval", "operationId": "post-policy-eval", "summary": "Set evaluation mode", "tags": [ "Security policy: Evaluation mode" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups", "operationId": "get-policy-eval-groups", "summary": "List evaluation attack groups", "tags": [ "Security policy: Evaluation attack groups" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}", "operationId": "get-policy-eval-group", "summary": "Get the action for an evaluation attack group", "tags": [ "Security policy: Evaluation attack groups" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}", "operationId": "put-eval-group", "summary": "Modify the action for an evaluation attack group", "tags": [ "Security policy: Evaluation attack groups" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}/condition-exception", "operationId": "get-eval-group-condition-exception", "summary": "Get the exceptions of an evaluation attack group", "tags": [ "Security policy: Conditions and exceptions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-groups/{attackGroupId}/condition-exception", "operationId": "put-eval-group-condition-exception", "summary": "Modify the exceptions of an evaluation attack group", "tags": [ "Security policy: Conditions and exceptions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-hostnames", "operationId": "get-eval-hostnames", "summary": "List evaluation hostnames for a security policy", "tags": [ "Security policy: Evaluation hostnames" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-hostnames", "operationId": "put-eval-hostnames", "summary": "Modify evaluation hostnames for a security policy", "tags": [ "Security policy: Evaluation hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box", "operationId": "get-eval-policy-penalty-box", "summary": "Get the penalty box for a policy in evaluation mode", "tags": [ "Security policy: Evaluation penalty box" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box", "operationId": "put-eval-policy-penalty-box", "summary": "Modify the evaluation penalty box", "tags": [ "Security policy: Evaluation penalty box" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box/conditions", "operationId": "get-eval-policy-penalty-box-conditions", "summary": "Get penalty box conditions in evaluation mode", "tags": [ "WAF rules: Evaluation Penalty box conditions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-penalty-box/conditions", "operationId": "put-eval-policy-penalty-box-conditions", "summary": "Modify the penalty box conditions in evaluation mode", "tags": [ "WAF rules: Evaluation Penalty box conditions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules", "operationId": "get-policy-eval-rules", "summary": "List evaluation rules", "tags": [ "Security policy: Evaluation rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}", "operationId": "get-policy-eval-rule", "summary": "Get the action of an evaluation rule", "tags": [ "Security policy: Evaluation rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}", "operationId": "put-policy-eval-rule", "summary": "Modify the action of an evaluation rule", "tags": [ "Security policy: Evaluation rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}/condition-exception", "operationId": "get-condition-exception", "summary": "Get the conditions and exceptions for an evaluation rule", "tags": [ "Security policy: Conditions and exceptions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/eval-rules/{ruleId}/condition-exception", "operationId": "put-condition-exception", "summary": "Modify the conditions and exceptions for an evaluation rule", "tags": [ "Security policy: Conditions and exceptions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/ip-geo-firewall", "operationId": "get-policy-ip-geo-firewall", "summary": "Get IP/Geo Firewall settings", "tags": [ "IP/Geo Firewall settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/ip-geo-firewall", "operationId": "put-policy-ip-geo-firewall", "summary": "Modify IP/Geo Firewall settings", "tags": [ "IP/Geo Firewall settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/malware-policies", "operationId": "get-malware-policies-actions", "summary": "List malware policy actions", "tags": [ "Malware policy actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/malware-policies/{malwarePolicyId}", "operationId": "put-malware-policy-action", "summary": "Modify a malware policy action", "tags": [ "Malware policy actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/mode", "operationId": "get-policy-mode", "summary": "Get the current mode", "tags": [ "WAF rules: Update mode" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/mode", "operationId": "put-policy-mode", "summary": "Modify the mode", "tags": [ "WAF rules: Update mode" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box", "operationId": "get-policy-penalty-box", "summary": "Get the penalty box", "tags": [ "WAF rules: Penalty box" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box", "operationId": "put-policy-penalty-box", "summary": "Modify the penalty box", "tags": [ "WAF rules: Penalty box" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box/conditions", "operationId": "get-policy-penalty-box-conditions", "summary": "Get penalty box condition", "tags": [ "WAF rules: Penalty box conditions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/penalty-box/conditions", "operationId": "put-policy-penalty-box-conditions", "summary": "Modify the penalty box conditions", "tags": [ "WAF rules: Penalty box conditions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protect-eval-hostnames", "operationId": "put-protect-eval-hostnames-per-policy", "summary": "Protect evaluation hostnames for a security policy", "tags": [ "Security policy: Evaluation hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections", "operationId": "get-policy-protections", "summary": "Get protections", "tags": [ "Protections" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/protections", "operationId": "put-policy-protections", "summary": "Modify protections", "tags": [ "Protections" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules", "operationId": "get-policy-rapid-rules", "summary": "List rapid rules", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/action", "operationId": "get-policy-rapid-rules-action", "summary": "Get rapid rules' default action", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/action", "operationId": "put-policy-rapid-rules-action", "summary": "Update rapid rules' default action", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/status", "operationId": "get-policy-rapid-rules-status", "summary": "Get rapid rules' status", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/status", "operationId": "put-policy-rapid-rules-status", "summary": "Update rapid rules' status", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/condition-exception", "operationId": "get-policy-rapid-rule-condition-exception", "summary": "List a rapid rule's conditions and exceptions", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/condition-exception", "operationId": "put-policy-rapid-rule-condition-exception", "summary": "Update a rapid rule's conditions and exceptions", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/lock", "operationId": "get-policy-rapid-rule-lock", "summary": "Get a rapid rule's lock status", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/lock", "operationId": "put-policy-rapid-rule-lock", "summary": "Update a rapid rule's lock status", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/versions/{ruleVersion}/action", "operationId": "get-policy-rapid-rule-action", "summary": "Get a rapid rule's action", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rapid-rules/{ruleId}/versions/{ruleVersion}/action", "operationId": "put-policy-rapid-rule-action", "summary": "Update a rapid rule's action", "tags": [ "WAF rules: Rapid rules" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies", "operationId": "get-rate-policies-actions", "summary": "List rate policy actions", "tags": [ "Rate policy actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies/{ratePolicyId}", "operationId": "put-rate-policy-action", "summary": "Modify a rate policy action", "tags": [ "Rate policy actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations", "operationId": "get-recommendations", "summary": "Get tuning recommendations for a policy", "tags": [ "WAF rules: Tuning recommendations" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations", "operationId": "post-recommendations", "summary": "Respond to exception recommendations", "tags": [ "WAF rules: Tuning recommendations" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations/attack-groups/{attackGroupId}", "operationId": "get-attack-group", "summary": "List tuning recommendations for an attack group", "tags": [ "WAF rules: Tuning recommendations" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/recommendations/rules/{ruleId}", "operationId": "get-recommendations-rule", "summary": "List tuning recommendations for a rule", "tags": [ "WAF rules: Tuning recommendations" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-analysis", "operationId": "get-reputation-analysis", "summary": "Get reputation analysis settings", "tags": [ "Reputation analysis" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-analysis", "operationId": "put-reputation-analysis", "summary": "Modify reputation analysis settings", "tags": [ "Reputation analysis" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles", "operationId": "get-reputation-profiles-actions", "summary": "List reputation profile actions", "tags": [ "Client reputation" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles/{reputationProfileId}", "operationId": "get-reputation-profile-action", "summary": "Get the action for a reputation profile", "tags": [ "Client reputation" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/reputation-profiles/{reputationProfileId}", "operationId": "put-reputation-profile-action", "summary": "Modify the action for a reputation profile", "tags": [ "Client reputation" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules", "operationId": "get-policy-rules", "summary": "List rules", "tags": [ "WAF rules: General settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules", "operationId": "put-policy-rules", "summary": "Upgrade KRS ruleset", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/upgrade-details", "operationId": "get-rules-upgrade-details", "summary": "Get upgrade details", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}", "operationId": "get-rule", "summary": "Get the action for a rule", "tags": [ "WAF rules: General settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}", "operationId": "put-rule", "summary": "Modify the action for a rule", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}/condition-exception", "operationId": "get-rule-condition-exception", "summary": "Get the conditions and exceptions of a rule", "tags": [ "WAF rules: General settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rules/{ruleId}/condition-exception", "operationId": "put-rule-condition-exception", "summary": "Modify the conditions and exceptions of a rule", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/selected-hostnames", "operationId": "get-selected-hostnames-per-policy", "summary": "List selected hostnames for a security policy", "tags": [ "Hostnames" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/selected-hostnames", "operationId": "put-selected-hostnames-per-config", "summary": "Modify selected hostnames for a security policy", "tags": [ "Hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/slow-post", "operationId": "get-policy-slow-post", "summary": "Get slow POST protection settings", "tags": [ "Slow POST protections" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/slow-post", "operationId": "put-policy-slow-post", "summary": "Modify slow POST protection settings", "tags": [ "Slow POST protections" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/threat-intel", "operationId": "get-rules-threat-intel", "summary": "Get adaptive intelligence settings", "tags": [ "WAF rules: General settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/threat-intel", "operationId": "put-rules-threat-intel", "summary": "Modify adaptive intelligence settings", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/url-protections", "operationId": "get-url-protection-policies-actions", "summary": "List URL protection policy actions", "tags": [ "URL protection policy actions" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/url-protections/{urlProtectionPolicyId}", "operationId": "put-url-protection-policy-action", "summary": "Modify a URL protection policy action", "tags": [ "URL protection policy actions" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/web-application-firewall/ruleset", "operationId": "get-waf-policy-ruleset-composite", "summary": "Get a security policy's rule set", "tags": [ "WAF rules: General settings" ] }, { "method": "PATCH", "path": "/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/web-application-firewall/ruleset", "operationId": "patch-waf-policy-ruleset-composite", "summary": "Modify a security policy's rule set", "tags": [ "WAF rules: General settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/selectable-hostnames", "operationId": "get-selectable-hostnames", "summary": "List selectable hostnames", "tags": [ "Hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/selected-hostnames", "operationId": "get-selected-hostnames", "summary": "List selected hostnames", "tags": [ "Hostnames" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/selected-hostnames", "operationId": "put-selected-hostnames", "summary": "Modify selected hostnames", "tags": [ "Hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/selected-hostnames/eval-hostnames", "operationId": "get-selected-hostnames-eval-hostnames", "summary": "List evaluation hostnames", "tags": [ "Configuration: Evaluation hostnames" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/selected-hostnames/eval-hostnames", "operationId": "put-selected-eval-hostnames", "summary": "Modify evaluation hostnames", "tags": [ "Configuration: Evaluation hostnames" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/siem", "operationId": "get-siem", "summary": "Get SIEM settings", "tags": [ "SIEM settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/siem", "operationId": "put-siem", "summary": "Modify SIEM settings", "tags": [ "SIEM settings" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/url-protections", "operationId": "get-url-protection-policies", "summary": "List URL protection policies", "tags": [ "URL protection policies" ] }, { "method": "POST", "path": "/configs/{configId}/versions/{versionNumber}/url-protections", "operationId": "post-url-protection-policies", "summary": "Create a URL protection policy", "tags": [ "URL protection policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId}", "operationId": "get-url-protection-policy", "summary": "Get a URL protection policy", "tags": [ "URL protection policies" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId}", "operationId": "put-url-protection-policy", "summary": "Modify a URL protection policy", "tags": [ "URL protection policies" ] }, { "method": "DELETE", "path": "/configs/{configId}/versions/{versionNumber}/url-protections/{urlProtectionPolicyId}", "operationId": "delete-url-protection-policy", "summary": "Remove a URL protection policy", "tags": [ "URL protection policies" ] }, { "method": "GET", "path": "/configs/{configId}/versions/{versionNumber}/version-notes", "operationId": "get-version-notes", "summary": "Get the version notes", "tags": [ "General configuration settings" ] }, { "method": "PUT", "path": "/configs/{configId}/versions/{versionNumber}/version-notes", "operationId": "put-version-notes", "summary": "Modify version notes", "tags": [ "General configuration settings" ] }, { "method": "GET", "path": "/contracts-groups", "operationId": "get-contracts-groups", "summary": "List contracts and groups", "tags": [ "Contracts and groups" ] }, { "method": "GET", "path": "/contracts/{contractId}/groups/{groupId}/selectable-hostnames", "operationId": "get-selectable-hostnames-per-config", "summary": "List available hostnames for a new configuration", "tags": [ "Available hostnames" ] }, { "method": "GET", "path": "/cves", "operationId": "get-cves", "summary": "List CVEs", "tags": [ "CVE Protections lookup" ] }, { "method": "POST", "path": "/cves/subscribe", "operationId": "post-subscribe", "summary": "Subscribe to CVEs", "tags": [ "CVE Protections lookup" ] }, { "method": "GET", "path": "/cves/subscribed", "operationId": "get-subscribed", "summary": "List subscribed CVEs", "tags": [ "CVE Protections lookup" ] }, { "method": "POST", "path": "/cves/unsubscribe", "operationId": "post-unsubscribe", "summary": "Unsubscribe from CVEs", "tags": [ "CVE Protections lookup" ] }, { "method": "GET", "path": "/cves/{cveId}", "operationId": "get-cve", "summary": "Get a CVE", "tags": [ "CVE Protections lookup" ] }, { "method": "GET", "path": "/cves/{cveId}/security-coverage", "operationId": "get-security-coverage", "summary": "Get CVE coverage", "tags": [ "CVE Protections lookup" ] }, { "method": "GET", "path": "/export/configs/{configId}/versions/{versionNumber}", "operationId": "get-export-config-version", "summary": "Export a configuration version", "tags": [ "Configuration version export" ] }, { "method": "GET", "path": "/hostname-coverage", "operationId": "get-hostname-coverage", "summary": "Get hostname coverage", "tags": [ "Hostname coverage" ] }, { "method": "GET", "path": "/onboardings", "operationId": "get-onboardings", "summary": "List onboardings", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "POST", "path": "/onboardings", "operationId": "post-onboarding", "summary": "Create an onboarding", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}", "operationId": "get-onboarding", "summary": "Get an onboarding", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "DELETE", "path": "/onboardings/{onboardingId}", "operationId": "delete-onboarding", "summary": "Delete an onboarding", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/activations", "operationId": "post-onboarding-activation", "summary": "Activate an onboarding", "tags": [ "Onboarding: Activations and status" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/activations/{activationId}", "operationId": "get-onboarding-activation-status", "summary": "Get an onboarding activation", "tags": [ "Onboarding: Activations and status" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/certificate-validation", "operationId": "get-onboarding-certificate-validation", "summary": "List onboarding certificate challenges", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/certificate-validation/validate", "operationId": "post-onboarding-certificate-validation", "summary": "Validate onboarding certificate", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/cname-to-akamai", "operationId": "get-onboarding-cname-records", "summary": "List hostname CNAME DNS records", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/cname-to-akamai/validate", "operationId": "post-validate-onboarding-cname-records", "summary": "Validate hostname CNAME DNS records", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/domain-validation", "operationId": "get-onboarding-domain-validation", "summary": "List onboarding domain challenges", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/domain-validation/validate", "operationId": "post-onboarding-domain-validation", "summary": "Validate onboarding domains", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/origin-validation", "operationId": "get-onboarding-origin-validation", "summary": "List origin hostname DNS records", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/origin-validation/skip", "operationId": "post-skip-onboarding-origin-validation", "summary": "Skip origin hostnames DNS record validation", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "POST", "path": "/onboardings/{onboardingId}/origin-validation/validate", "operationId": "post-onboarding-origin-validation", "summary": "Validate origin hostnames DNS records", "tags": [ "Onboarding: Post-activation validation" ] }, { "method": "GET", "path": "/onboardings/{onboardingId}/settings", "operationId": "get-onboarding-settings", "summary": "Get onboarding settings", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "PUT", "path": "/onboardings/{onboardingId}/settings", "operationId": "put-onboarding-settings", "summary": "Modify onboarding settings", "tags": [ "Onboarding: Creation and settings" ] }, { "method": "GET", "path": "/siem-definitions", "operationId": "get-siem-definitions", "summary": "Get SIEM versions", "tags": [ "SIEM settings" ] } ] }