APIRef_tm_security_dos_profile_applicationΒΆ

mgmt/tm/security/dos/profile/application

/tm/security/dos

REST Endpoints

Collection URI
/mgmt/tm/security/dos/profile/application
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/security/dos/profile/application/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service that the object belongs to.
singlePageApplication string disabled optional read/write Specifies, when enabled, that the system supports a Single Page Applications. The default value is disabled.
triggerIrule string   optional read/write Specifies, when enabled, that the system activates an Application DoS iRule event. The default value is disabled.
urlPatterns string   optional read/write  

Structures

Name Type Default Value Required Access Description
/bot-defense array_structure   optional read/write  
/bot-defense/browser-legit-captcha string enabled optional read/write Enables or disables the browser legitimacy detection improvement using CAPTCHA.
/bot-defense/browser-legit-enabled string enabled optional read/write Enables or disables the proactive bot defense validation of browser legitimacy and blocking of requests from suspicious clients.
/bot-defense/cross-domain-requests string allow-all optional read/write Specifies a cross-domain requests handling mode.
/bot-defense/external-domains string   optional read/write Configures a list of external domains that are allowed to link to resources of this website.
/bot-defense/grace-period integer 300 optional read/write Specifies the length of grace period (in seconds) in which only the Simple Bot Prevention is enforced.
/bot-defense/mode string disabled optional read/write Specifies a mode of proactive bot defense.
/bot-defense/site-domains string   optional read/write Configures a list of domains that are part of the website.
/bot-defense/url-whitelist string   optional read/write Configures a list of URLs to exclude from the proactive bot defense.
/bot-defense/browser-legit-captcha string enabled optional read/write Enables or disables the browser legitimacy detection improvement using CAPTCHA.
/bot-defense/browser-legit-enabled string enabled optional read/write Enables or disables the proactive bot defense validation of browser legitimacy and blocking of requests from suspicious clients.
/bot-defense/cross-domain-requests string allow-all optional read/write Specifies a cross-domain requests handling mode.
/bot-defense/external-domains string   optional read/write Configures a list of external domains that are allowed to link to resources of this website.
/bot-defense/grace-period integer 300 optional read/write Specifies the length of grace period (in seconds) in which only the Simple Bot Prevention is enforced.
/bot-defense/mode string disabled optional read/write Specifies a mode of proactive bot defense.
/bot-defense/site-domains string   optional read/write Configures a list of domains that are part of the website.
/bot-defense/url-whitelist string   optional read/write Configures a list of URLs to exclude from the proactive bot defense.
/bot-signatures array_structure   optional read/write  
/bot-signatures/check string disabled optional read/write Enables or disables the Bot Signatures Check.
/bot-signatures/categories array_structure   optional read/write  
/bot-signatures/categories/action string none optional read/write  
/bot-signatures/categories/app-service string   optional read/write  
/bot-signatures/disabled-signatures array_structure   optional read/write  
/bot-signatures/disabled-signatures/app-service string   optional read/write  
/bot-signatures/check string disabled optional read/write Enables or disables the Bot Signatures Check.
/captcha-response array_structure   optional read/write  
/captcha-response/failure array_structure   optional read/write  
/captcha-response/failure/body string   optional read/write Configures a failed CAPTCHA response body.
/captcha-response/failure/type string default optional read/write Configures a type of a failed CAPTCHA response body
/captcha-response/failure/body string   optional read/write Configures a failed CAPTCHA response body.
/captcha-response/failure/type string default optional read/write Configures a type of a failed CAPTCHA response body
/captcha-response/first array_structure   optional read/write  
/captcha-response/first/body string   optional read/write Configures the first CAPTCHA response body.
/captcha-response/first/type string default optional read/write Configures a type of the first CAPTCHA response body
/captcha-response/first/body string   optional read/write Configures the first CAPTCHA response body.
/captcha-response/first/type string default optional read/write Configures a type of the first CAPTCHA response body
/heavy-urls array_structure   optional read/write  
/heavy-urls/automatic-detection string enabled optional read/write Enables or disables automatic heavy URL detection.
/heavy-urls/exclude string   optional read/write Configures a list of URLs (or wildcards) to exclude from the heavy URLs.
/heavy-urls/include string   optional read/write (Deprecated) Configures a list of URLs to include in the heavy URLs.
/heavy-urls/latency-threshold integer 1000 optional read/write Specifies the latency threshold for automatic heavy URL detection (in milliseconds).
/heavy-urls/protection string enabled optional read/write (Deprecated) Enables or disables heavy URL protection in Application Security.
/heavy-urls/include-list array_structure   optional read/write  
/heavy-urls/include-list/app-service string   optional read/write  
/heavy-urls/include-list/threshold string 0 optional read/write  
/heavy-urls/include-list/url string   optional read/write  
/heavy-urls/automatic-detection string enabled optional read/write Enables or disables automatic heavy URL detection.
/heavy-urls/exclude string   optional read/write Configures a list of URLs (or wildcards) to exclude from the heavy URLs.
/heavy-urls/include string   optional read/write (Deprecated) Configures a list of URLs to include in the heavy URLs.
/heavy-urls/latency-threshold integer 1000 optional read/write Specifies the latency threshold for automatic heavy URL detection (in milliseconds).
/heavy-urls/protection string enabled optional read/write (Deprecated) Enables or disables heavy URL protection in Application Security.
/stress-based array_structure   optional read/write  
/stress-based/de-escalation-period integer 7200 optional read/write Specifies the de-escalation period (in seconds) in Stress-based anomaly.
/stress-based/device-captcha-challenge string disabled optional read/write Enables or disables Device ID-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/device-client-side-defense string disabled optional read/write Enables or disables Device ID-based client side integrity defense in Stress-based anomaly.
/stress-based/device-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Device ID detection criteria of Stress-based anomaly.
/stress-based/device-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in Device ID detection criteria of Stress-based anomaly.
/stress-based/device-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Device ID detection criteria of Stress-based anomaly.
/stress-based/device-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in Device ID detection criteria of Stress-based anomaly.
/stress-based/device-rate-limiting string disabled optional read/write Enables or disables Device ID-based rate limiting in Stress-based anomaly.
/stress-based/device-request-blocking-mode string rate-limit optional read/write Specifies a Device ID-based request blocking mode of Stress-based anomaly.
/stress-based/device-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Device ID detection criteria of Stress-based anomaly.
/stress-based/escalation-period integer 120 optional read/write Specifies the escalation period (in seconds) in Stress-based anomaly.
/stress-based/geo-captcha-challenge string disabled optional read/write Enables or disables Geolocation-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/geo-client-side-defense string disabled optional read/write Enables or disables Geolocation-based client side integrity defense in Stress-based anomaly.
/stress-based/geo-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-minimum-share integer 10 optional read/write Specifies the minimum traffic share for detection in Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-rate-limiting string disabled optional read/write Enables or disables Geolocation-based rate limiting in Stress-based anomaly.
/stress-based/geo-request-blocking-mode string rate-limit optional read/write Specifies a Geolocation-based request blocking mode of Stress-based anomaly.
/stress-based/geo-share-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Geolocation detection criteria of Stress-based anomaly.
/stress-based/ip-captcha-challenge string disabled optional read/write Enables or disables Source IP-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/ip-client-side-defense string disabled optional read/write Enables or disables Source IP-based client side integrity defense in Stress-based anomaly.
/stress-based/ip-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Source IP detection criteria of Stress-based anomaly.
/stress-based/ip-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in IP detection criteria of Stress-based anomaly.
/stress-based/ip-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Source IP detection criteria of Stress-based anomaly.
/stress-based/ip-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in IP detection criteria of Stress-based anomaly.
/stress-based/ip-rate-limiting string enabled optional read/write Enables or disables Source IP-based rate limiting in Stress-based anomaly.
/stress-based/ip-request-blocking-mode string rate-limit optional read/write Specifies a Source IP-based request blocking mode of Stress-based anomaly.
/stress-based/ip-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in IP detection criteria of Stress-based anomaly.
/stress-based/mode string off optional read/write Specifies an operation mode of Stress-based anomaly.
/stress-based/site-captcha-challenge string disabled optional read/write Enables or disables Site-wide CAPTCHA challenge in Stress-based anomaly.
/stress-based/site-client-side-defense string disabled optional read/write Enables or disables Site-wide client side integrity defense in Stress-based anomaly.
/stress-based/site-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-maximum-tps integer 10000 optional read/write Specifies the amount which TPS reached in Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-minimum-tps integer 2000 optional read/write Specifies the minimum TPS threshold for detection in Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-rate-limiting string disabled optional read/write Enables or disables Site-wide rate limiting in Stress-based anomaly.
/stress-based/site-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Site-wide detection criteria of Stress-based anomaly.
/stress-based/thresholds-mode string manual optional read/write Specifies the thresholds mode of Stress-based anomaly.
/stress-based/url-captcha-challenge string disabled optional read/write Enables or disables URL-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/url-client-side-defense string disabled optional read/write Enables or disables URL-based client side integrity defense in Stress-based anomaly.
/stress-based/url-enable-heavy string enabled optional read/write Enables or disables heavy URL protection in Stress-based anomaly.
/stress-based/url-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for URL detection criteria of Stress-based anomaly.
/stress-based/url-maximum-tps integer 1000 optional read/write Specifies the amount which TPS reached in URL detection criteria of Stress-based anomaly.
/stress-based/url-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for URL detection criteria of Stress-based anomaly.
/stress-based/url-minimum-tps integer 200 optional read/write Specifies the minimum TPS threshold for detection in URL detection criteria of Stress-based anomaly.
/stress-based/url-rate-limiting string enabled optional read/write Enables or disables URL-based rate limiting in Stress-based anomaly.
/stress-based/url-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in URL detection criteria of Stress-based anomaly.
/stress-based/behavioral array_structure   optional read/write  
/stress-based/behavioral/anomaly-detection string disabled optional read/write  
/stress-based/behavioral/dos-detection string disabled optional read/write  
/stress-based/behavioral/mitigation-mode string standard optional read/write  
/stress-based/behavioral/rate-limit-incoming-requests string disabled optional read/write  
/stress-based/behavioral/signatures string disabled optional read/write  
/stress-based/behavioral/signatures-approved-only string disabled optional read/write  
/stress-based/behavioral/slowdown-incoming-requests string disabled optional read/write  
/stress-based/behavioral/traffic-burst-protection string disabled optional read/write  
/stress-based/behavioral/anomaly-detection string disabled optional read/write  
/stress-based/behavioral/dos-detection string disabled optional read/write  
/stress-based/behavioral/mitigation-mode string standard optional read/write  
/stress-based/behavioral/rate-limit-incoming-requests string disabled optional read/write  
/stress-based/behavioral/signatures string disabled optional read/write  
/stress-based/behavioral/signatures-approved-only string disabled optional read/write  
/stress-based/behavioral/slowdown-incoming-requests string disabled optional read/write  
/stress-based/behavioral/traffic-burst-protection string disabled optional read/write  
/stress-based/de-escalation-period integer 7200 optional read/write Specifies the de-escalation period (in seconds) in Stress-based anomaly.
/stress-based/device-captcha-challenge string disabled optional read/write Enables or disables Device ID-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/device-client-side-defense string disabled optional read/write Enables or disables Device ID-based client side integrity defense in Stress-based anomaly.
/stress-based/device-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Device ID detection criteria of Stress-based anomaly.
/stress-based/device-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in Device ID detection criteria of Stress-based anomaly.
/stress-based/device-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Device ID detection criteria of Stress-based anomaly.
/stress-based/device-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in Device ID detection criteria of Stress-based anomaly.
/stress-based/device-rate-limiting string disabled optional read/write Enables or disables Device ID-based rate limiting in Stress-based anomaly.
/stress-based/device-request-blocking-mode string rate-limit optional read/write Specifies a Device ID-based request blocking mode of Stress-based anomaly.
/stress-based/device-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Device ID detection criteria of Stress-based anomaly.
/stress-based/escalation-period integer 120 optional read/write Specifies the escalation period (in seconds) in Stress-based anomaly.
/stress-based/geo-captcha-challenge string disabled optional read/write Enables or disables Geolocation-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/geo-client-side-defense string disabled optional read/write Enables or disables Geolocation-based client side integrity defense in Stress-based anomaly.
/stress-based/geo-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-minimum-share integer 10 optional read/write Specifies the minimum traffic share for detection in Geolocation detection criteria of Stress-based anomaly.
/stress-based/geo-rate-limiting string disabled optional read/write Enables or disables Geolocation-based rate limiting in Stress-based anomaly.
/stress-based/geo-request-blocking-mode string rate-limit optional read/write Specifies a Geolocation-based request blocking mode of Stress-based anomaly.
/stress-based/geo-share-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Geolocation detection criteria of Stress-based anomaly.
/stress-based/ip-captcha-challenge string disabled optional read/write Enables or disables Source IP-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/ip-client-side-defense string disabled optional read/write Enables or disables Source IP-based client side integrity defense in Stress-based anomaly.
/stress-based/ip-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Source IP detection criteria of Stress-based anomaly.
/stress-based/ip-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in IP detection criteria of Stress-based anomaly.
/stress-based/ip-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Source IP detection criteria of Stress-based anomaly.
/stress-based/ip-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in IP detection criteria of Stress-based anomaly.
/stress-based/ip-rate-limiting string enabled optional read/write Enables or disables Source IP-based rate limiting in Stress-based anomaly.
/stress-based/ip-request-blocking-mode string rate-limit optional read/write Specifies a Source IP-based request blocking mode of Stress-based anomaly.
/stress-based/ip-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in IP detection criteria of Stress-based anomaly.
/stress-based/mode string off optional read/write Specifies an operation mode of Stress-based anomaly.
/stress-based/site-captcha-challenge string disabled optional read/write Enables or disables Site-wide CAPTCHA challenge in Stress-based anomaly.
/stress-based/site-client-side-defense string disabled optional read/write Enables or disables Site-wide client side integrity defense in Stress-based anomaly.
/stress-based/site-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-maximum-tps integer 10000 optional read/write Specifies the amount which TPS reached in Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-minimum-tps integer 2000 optional read/write Specifies the minimum TPS threshold for detection in Site-wide detection criteria of Stress-based anomaly.
/stress-based/site-rate-limiting string disabled optional read/write Enables or disables Site-wide rate limiting in Stress-based anomaly.
/stress-based/site-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Site-wide detection criteria of Stress-based anomaly.
/stress-based/thresholds-mode string manual optional read/write Specifies the thresholds mode of Stress-based anomaly.
/stress-based/url-captcha-challenge string disabled optional read/write Enables or disables URL-based CAPTCHA challenge in Stress-based anomaly.
/stress-based/url-client-side-defense string disabled optional read/write Enables or disables URL-based client side integrity defense in Stress-based anomaly.
/stress-based/url-enable-heavy string enabled optional read/write Enables or disables heavy URL protection in Stress-based anomaly.
/stress-based/url-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for URL detection criteria of Stress-based anomaly.
/stress-based/url-maximum-tps integer 1000 optional read/write Specifies the amount which TPS reached in URL detection criteria of Stress-based anomaly.
/stress-based/url-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for URL detection criteria of Stress-based anomaly.
/stress-based/url-minimum-tps integer 200 optional read/write Specifies the minimum TPS threshold for detection in URL detection criteria of Stress-based anomaly.
/stress-based/url-rate-limiting string enabled optional read/write Enables or disables URL-based rate limiting in Stress-based anomaly.
/stress-based/url-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in URL detection criteria of Stress-based anomaly.
/tcp-dump array_structure   optional read/write  
/tcp-dump/maximum-duration integer 30 optional read/write Specifies the TCP dump maximum duration (in seconds).
/tcp-dump/maximum-size integer 10 optional read/write Specifies the TCP dump maximum size (in megabytes).
/tcp-dump/record-traffic string disabled optional read/write Enables or disables traffic recording during attacks.
/tcp-dump/repetition-interval string 120 optional read/write Specifies the TCP dump repetition interval (in seconds).
/tcp-dump/maximum-duration integer 30 optional read/write Specifies the TCP dump maximum duration (in seconds).
/tcp-dump/maximum-size integer 10 optional read/write Specifies the TCP dump maximum size (in megabytes).
/tcp-dump/record-traffic string disabled optional read/write Enables or disables traffic recording during attacks.
/tcp-dump/repetition-interval string 120 optional read/write Specifies the TCP dump repetition interval (in seconds).
/tps-based array_structure   optional read/write  
/tps-based/de-escalation-period integer 7200 optional read/write Specifies the de-escalation period (in seconds) in TPS-based anomaly.
/tps-based/device-captcha-challenge string disabled optional read/write Enables or disables Device ID-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/device-client-side-defense string disabled optional read/write Enables or disables Device ID-based client side integrity defense in TPS-based anomaly.
/tps-based/device-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Device ID detection criteria of TPS-based anomaly.
/tps-based/device-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in Device ID detection criteria of TPS-based anomaly.
/tps-based/device-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Device ID detection criteria of TPS-based anomaly.
/tps-based/device-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in Device ID detection criteria of TPS-based anomaly.
/tps-based/device-rate-limiting string disabled optional read/write Enables or disables Device ID-based rate limiting in TPS-based anomaly.
/tps-based/device-request-blocking-mode string rate-limit optional read/write Specifies a Device ID-based request blocking mode of TPS-based anomaly.
/tps-based/device-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Device ID detection criteria of TPS-based anomaly.
/tps-based/escalation-period integer 120 optional read/write Specifies the escalation period (in seconds) in TPS-based anomaly.
/tps-based/geo-captcha-challenge string disabled optional read/write Enables or disables Geolocation-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/geo-client-side-defense string disabled optional read/write Enables or disables Geolocation-based client side integrity defense in TPS-based anomaly.
/tps-based/geo-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-minimum-share integer 10 optional read/write Specifies the minimum traffic share for detection in Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-rate-limiting string disabled optional read/write Enables or disables Geolocation-based rate limiting in TPS-based anomaly.
/tps-based/geo-request-blocking-mode string rate-limit optional read/write Specifies a Geolocation-based request blocking mode of TPS-based anomaly.
/tps-based/geo-share-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Geolocation detection criteria of TPS-based anomaly.
/tps-based/ip-captcha-challenge string disabled optional read/write Enables or disables Source IP-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/ip-client-side-defense string disabled optional read/write Enables or disables Source IP-based client side integrity defense in TPS-based anomaly.
/tps-based/ip-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Source IP detection criteria of TPS-based anomaly.
/tps-based/ip-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in IP detection criteria of TPS-based anomaly.
/tps-based/ip-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Source IP detection criteria of TPS-based anomaly.
/tps-based/ip-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in IP detection criteria of TPS-based anomaly.
/tps-based/ip-rate-limiting string enabled optional read/write Enables or disables Source IP-based rate limiting in TPS-based anomaly.
/tps-based/ip-request-blocking-mode string rate-limit optional read/write Specifies a Source IP-based request blocking mode of TPS-based anomaly.
/tps-based/ip-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in IP detection criteria of TPS-based anomaly.
/tps-based/mode string blocking optional read/write Specifies an operation mode of TPS-based anomaly.
/tps-based/site-captcha-challenge string disabled optional read/write Enables or disables Site-wide CAPTCHA challenge in TPS-based anomaly.
/tps-based/site-client-side-defense string disabled optional read/write Enables or disables Site-wide client side integrity defense in TPS-based anomaly.
/tps-based/site-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-maximum-tps integer 10000 optional read/write Specifies the amount which TPS reached in Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-minimum-tps integer 2000 optional read/write Specifies the minimum TPS threshold for detection in Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-rate-limiting string disabled optional read/write Enables or disables Site-wide rate limiting in TPS-based anomaly.
/tps-based/site-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Site-wide detection criteria of TPS-based anomaly.
/tps-based/thresholds-mode string manual optional read/write Specifies the thresholds mode of TPS-based anomaly.
/tps-based/url-captcha-challenge string disabled optional read/write Enables or disables URL-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/url-client-side-defense string disabled optional read/write Enables or disables URL-based client side integrity defense in TPS-based anomaly.
/tps-based/url-enable-heavy string enabled optional read/write Enables or disables heavy URL protection in TPS-based anomaly.
/tps-based/url-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for URL detection criteria of TPS-based anomaly.
/tps-based/url-maximum-tps integer 1000 optional read/write Specifies the amount which TPS reached in URL detection criteria of TPS-based anomaly.
/tps-based/url-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for URL detection criteria of TPS-based anomaly.
/tps-based/url-minimum-tps integer 200 optional read/write Specifies the minimum TPS threshold for detection in URL detection criteria of TPS-based anomaly.
/tps-based/url-rate-limiting string enabled optional read/write Enables or disables URL-based rate limiting in TPS-based anomaly.
/tps-based/url-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in URL detection criteria of TPS-based anomaly.
/tps-based/de-escalation-period integer 7200 optional read/write Specifies the de-escalation period (in seconds) in TPS-based anomaly.
/tps-based/device-captcha-challenge string disabled optional read/write Enables or disables Device ID-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/device-client-side-defense string disabled optional read/write Enables or disables Device ID-based client side integrity defense in TPS-based anomaly.
/tps-based/device-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Device ID detection criteria of TPS-based anomaly.
/tps-based/device-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in Device ID detection criteria of TPS-based anomaly.
/tps-based/device-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Device ID detection criteria of TPS-based anomaly.
/tps-based/device-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in Device ID detection criteria of TPS-based anomaly.
/tps-based/device-rate-limiting string disabled optional read/write Enables or disables Device ID-based rate limiting in TPS-based anomaly.
/tps-based/device-request-blocking-mode string rate-limit optional read/write Specifies a Device ID-based request blocking mode of TPS-based anomaly.
/tps-based/device-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Device ID detection criteria of TPS-based anomaly.
/tps-based/escalation-period integer 120 optional read/write Specifies the escalation period (in seconds) in TPS-based anomaly.
/tps-based/geo-captcha-challenge string disabled optional read/write Enables or disables Geolocation-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/geo-client-side-defense string disabled optional read/write Enables or disables Geolocation-based client side integrity defense in TPS-based anomaly.
/tps-based/geo-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-minimum-share integer 10 optional read/write Specifies the minimum traffic share for detection in Geolocation detection criteria of TPS-based anomaly.
/tps-based/geo-rate-limiting string disabled optional read/write Enables or disables Geolocation-based rate limiting in TPS-based anomaly.
/tps-based/geo-request-blocking-mode string rate-limit optional read/write Specifies a Geolocation-based request blocking mode of TPS-based anomaly.
/tps-based/geo-share-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Geolocation detection criteria of TPS-based anomaly.
/tps-based/ip-captcha-challenge string disabled optional read/write Enables or disables Source IP-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/ip-client-side-defense string disabled optional read/write Enables or disables Source IP-based client side integrity defense in TPS-based anomaly.
/tps-based/ip-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for Source IP detection criteria of TPS-based anomaly.
/tps-based/ip-maximum-tps integer 200 optional read/write Specifies the amount which TPS reached in IP detection criteria of TPS-based anomaly.
/tps-based/ip-minimum-auto-tps integer 5 optional read/write Specifies the minimum automatic threshold than can be calculated for Source IP detection criteria of TPS-based anomaly.
/tps-based/ip-minimum-tps integer 40 optional read/write Specifies the minimum TPS threshold for detection in IP detection criteria of TPS-based anomaly.
/tps-based/ip-rate-limiting string enabled optional read/write Enables or disables Source IP-based rate limiting in TPS-based anomaly.
/tps-based/ip-request-blocking-mode string rate-limit optional read/write Specifies a Source IP-based request blocking mode of TPS-based anomaly.
/tps-based/ip-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in IP detection criteria of TPS-based anomaly.
/tps-based/mode string blocking optional read/write Specifies an operation mode of TPS-based anomaly.
/tps-based/site-captcha-challenge string disabled optional read/write Enables or disables Site-wide CAPTCHA challenge in TPS-based anomaly.
/tps-based/site-client-side-defense string disabled optional read/write Enables or disables Site-wide client side integrity defense in TPS-based anomaly.
/tps-based/site-maximum-auto-tps integer 20000 optional read/write Specifies the maximum automatic threshold than can be calculated for Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-maximum-tps integer 10000 optional read/write Specifies the amount which TPS reached in Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-minimum-tps integer 2000 optional read/write Specifies the minimum TPS threshold for detection in Site-wide detection criteria of TPS-based anomaly.
/tps-based/site-rate-limiting string disabled optional read/write Enables or disables Site-wide rate limiting in TPS-based anomaly.
/tps-based/site-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in Site-wide detection criteria of TPS-based anomaly.
/tps-based/thresholds-mode string manual optional read/write Specifies the thresholds mode of TPS-based anomaly.
/tps-based/url-captcha-challenge string disabled optional read/write Enables or disables URL-based CAPTCHA challenge in TPS-based anomaly.
/tps-based/url-client-side-defense string disabled optional read/write Enables or disables URL-based client side integrity defense in TPS-based anomaly.
/tps-based/url-enable-heavy string enabled optional read/write Enables or disables heavy URL protection in TPS-based anomaly.
/tps-based/url-maximum-auto-tps integer 5000 optional read/write Specifies the maximum automatic threshold than can be calculated for URL detection criteria of TPS-based anomaly.
/tps-based/url-maximum-tps integer 1000 optional read/write Specifies the amount which TPS reached in URL detection criteria of TPS-based anomaly.
/tps-based/url-minimum-auto-tps integer 50 optional read/write Specifies the minimum automatic threshold than can be calculated for URL detection criteria of TPS-based anomaly.
/tps-based/url-minimum-tps integer 200 optional read/write Specifies the minimum TPS threshold for detection in URL detection criteria of TPS-based anomaly.
/tps-based/url-rate-limiting string enabled optional read/write Enables or disables URL-based rate limiting in TPS-based anomaly.
/tps-based/url-tps-increase-rate integer 500 optional read/write Specifies the percentage by which TPS increased in URL detection criteria of TPS-based anomaly.

Array Structures

Name Type Default Value Required Access Description
/geolocations array_structure   optional read/write  
/geolocations/app-service string   optional read/write  
/geolocations/black-listed boolean false optional read/write  
/geolocations/white-listed boolean false optional read/write  
/ip-whitelist array_structure   optional read/write  
/ip-whitelist/app-service string   optional read/write  
iControl Reference Index
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.