Configure the Bot Endpoint Policy

Published April 5, 2023 | Last modified January 17, 2025

Important: Bot Defense Advanced Self-Service Policy Management is an Early Access feature.

The Bot Endpoint Policy defines the endpoints you want to protect with Bot Defense Advanced and the mitigation actions that Bot Defense takes when it detects automated traffic. Before you configure your Bot Endpoint Policy, you should perform a site analysis and compile a list of endpoints that you need to protect.

Note: You can only edit the most recent version of the policy.

From the Bot Defense navigation menu, click Manage > Bot Policies and then click Bot Endpoint Policy.
From the list of saved Bot Endpoint Policies, in the Actions column, click the Action menu (…) next to the most recent policy version.

If you are configuring a Bot Endpoint Policy for the first time, it is likely that you only have one saved policy version.
Click Manage Configuration and then click Edit Configuration.
To add a new protected endpoint, in the Protected Endpoints section, click Add Item and then configure the endpoint settings.
Enter a Name and Description for the new endpoint.
Specify the Domain from which you will accept traffic on this endpoint. You can add more than one domain.
1. From the Operator drop-down list, decide how you want to match the domain:
  - ALL: Match only if all the domain matchers match the domain in the request.
  - ANY: Match if any of the domain matchers match the domain in the request.
  - ANYTHING: No match is necessary. The endpoint accepts traffic from any domain.
  - NONE: Match only if none of the domain matchers match the domain in the request.
2. Enter a Comparison Operator, either Exact, Contain, Start With or End With, and then enter the value you want to match.
3. (Optional) From the Not (!) drop-down list, select Yes or No. The default selection is No. Change the setting to Yes if you want Bot Defense to match values that are the opposite of the values you entered above.
4. (Optional) To protect another domain, click Add Item.
  
  Figure: Domain Matchers
  
  Note that if you do not specify a domain, the domain column is blank, and the endpoint accepts traffic from any domain.
  
  Figure: No Domain Specified
Enter the Path for the endpoint you want to protect. For example, enter /login.
1. From the Operator drop-down list, decide how you want to match the path:
  - ALL: Match only if all the path matchers match the path targeted by the request.
  - ANY: Match if any of the path matchers match the path targeted by the request.
  - ANYTHING: No match is necessary. Match regardless of the path targeted by the request.
  - NONE: Match if none of the path matchers match the path targeted in the request.
2. Click Add Item.
3. Select a Comparison Operator, either Exact, Contain, Start With or End With, and then enter the value you want to match.
4. (Optional) If you want Bot Defense to match values that are the opposite of the values you entered above, select Not (!).
5. Click Apply.
  
  Figure: Path Matchers
To protect specific endpoint functionality, enter Query criteria that identifies the functionality.

For example, if the query string of a URI you want to protect is <yourdomain>/account.do/issue?account=moneytransfer, enter the parameter name and parameter value account=moneytransfer to protect the moneytransfer function.

When you enter a Query parameter, the Bot Defense service looks at both the Path and Query values.
1. From the Operator drop-down list, decide how you want Bot Defense to match query strings:
  - ALL: Match only if all the query matchers match the functionality targeted by the request.
  - ANY: Match if any of the query matchers match the functionality targeted by the request.
  - ANYTHING: No match is necessary. Match regardless of the functionality targeted by the request.
  - NONE: Match if none of the path matchers match the functionality targeted in the request.
2. Click Add Item.
3. Select a Comparison Operator, either Exact, Contain, Start With or End With, and then enter the value you want to match.
4. (Optional) If you want Bot Defense to match values that are the opposite of the values you entered above, select Not (!).
5. Click Apply.
  
  Figure: Query Matcher
Request Body: Content in the body of the request targeting the endpoint must match this criteria to be evaluated by Bot Defense.
1. From the Operator drop-down list, decide how you want Bot Defense to match the body content:
  - ALL: Match only if all the request body matchers match content in the request body.
  - ANY: Match if any of the request body matchers match content in the request body.
  - ANYTHING: No match is necessary. Match regardless of the content of the request body.
  - NONE: Match if none of the request body matchers match content in the request body.
2. Click Add Item.
3. Select a Comparison Operator, either Exact, Contain, Start With or End With, and then enter the value you want to match.
4. (Optional) If you want Bot Defense to match values that are the opposite of the values you entered above, select Not (!).
5. Click Apply.
  
  Figure: Request Body Matcher
Header: A header in requests targeting the endpoint must match this criteria to be evaluated by Bot Defense.
1. In the Header section, click Add Item.
2. Add a Name for the set of header matchers and then from the Operator drop-down list, select one of the following options:
  - ANYTHING: No match is necessary. Matches even if no headers match.
  - ANY: Match if any of the header matchers match a header in the request.
  - ALL: Match only if all the header matchers match a header in the request.
  - NONE: Match if none of the header matchers match a header in the request.
  - NOT PRESENT: Match only if no headers are present in the request.
3. Click Add Item.
4. Select a Comparison Operator, either Exact, Contain, Start With or End With, and then enter the value you want to match.
5. (Optional) If you want Bot Defense to match values that are the opposite of the values you entered above, select Not (!).
6. Click Apply and then click Apply again.
  
  Figure: Header Matcher
HTTP Methods you want to protect with Bot Defense:
- GET(XHR/Fetch): Use when the protected application makes an XHTTPRequest or Fetch API call to get the content of the page. GET requests are protected only if they are sent by XHTTPRequest from a page with Bot Defense JavaScript injected, not from direct navigation using the address bar or link.
- POST: The most commonly attacked method. F5 recommends that you protect all POST requests. Bot Defense analyzes POST requests to determine if they are part of a bot attack such as credential stuffing or form submission abuse.
- PUT: Use to protect PUT requests and prevent data uploads or modifications from bots.
- PATCH: Use to protect PATCH requests and prevent bots from altering resource data.
- DELETE: Use to protect DELETE requests and prevent bots from deleting content or resources.
- GET(Document): Use to protect pages on a web site that can be accessible by GET requests without visiting the main page. When you configure an endpoint using GET(Document), Bot Defense displays an interstitial page that is transparent to the user but that allows it to collect telemetry data about the requests. Note that you cannot use GET(Document) with mobile endpoints.
- HEAD: Use to protect HEAD requests and to prevent bots from repeatedly pinging a server to check metadata.
- OPTIONS: Use to protect OPTION requests and to prevent bots from checking to find out what CORS options are supported by a server.
- TRACE: Use to protect TRACE requests to and prevent bots from repeatedly pinging a server with diagnostic requests.
Note: If you select both GET(XHR/Fetch) and GET(Document), only GET(XHR/Fetch) requests are protected. To protect both methods for the same endpoint, add the endpoint separately for each method.
Endpoint Category: Select an endpoint label to help identify the endpoint. This allows more granular attack intent identification and reporting when Bot Defense detects automation.

For example, to identify a multi-factor authentication flow on an endpoint, select Authentication > Login MFA.

For a full list of available endpoint labels, see Endpoint Labels.
Mitigation Action: Specify what action to take when a bot is detected. F5 recommends that you configure mitigation actions to mimic the normal behavior of the application so that an attacker does not know their request was intercepted:
- Continue: Allows requests to continue to the origin. A log record is created. You can optionally add headers to the request.
  1. From the Include Mitigation Headers drop-down list, select Headers if you want to add a header to automated requests that Bot Defense allows to continue to the origin.
  2. From the Automation Type Header Name drop-down list, select the header that you want to add. You create the headers when you configure the protected endpoint.
- Block: The endpoint returns a status code and message that you configure.
  1. From the Status drop-down list, select the status code you want to display when Bot Defense blocks a request.
  2. Enter a Header Name and corresponding Value to add to the blocked request. You can add multiple headers.
  3. Enter the Body of the message you want to display when Bot Defense blocks a request.
- Redirect: The endpoint forwards the browser to the URL that you specify. You can only select Redirect for web endpoints.
  1. In the Status field, enter the status code that you want to display when Bot Defense redirects a request.
  2. In the Location field, enter the URL where you want to send requests redirected by Bot Defense.
- Transform: Allows the request to continue to the origin. Headers are added to the request for inference and automation type. Use transform when you want to allow the request to continue and use a system other than Bot Defense to mitigate.
  1. In the Add Header(s) to Request drop-down list, select whether you want to add a header name and value pair to the request.
  2. Add a Header Name and Value to add to requests.
When you finish configuring the protected endpoint, click Apply
When you finish adding protected endpoints, click Review Changes.
When you finish reviewing the changes, choose one of the following options:
- Save Final: The policy version is saved and added to the list of policy versions that you can deploy in your Bot infrastructure.
- Save as Draft: You or another administrator can review and finalize this policy version later.
Important: Other administrators can make changes that overwrite your saved draft. Before you deploy your policy update, review the policy settings to make sure they are correct.

Next Steps

When you finish configuring your Bot Endpoint Policy version and are ready to deploy the version, see Deploy Policy Updates.

Important: F5 recommends that you first deploy and test new policy versions in your test environment to make sure the system behaves as you intended before you deploy in a production environment. For information, see Test Bot Defense Advanced.