GET Bot Endpoint Policy.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/bot_endpoint_policys/example?response_format=GET_RSP_FORMAT_DEFAULT';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/bot_endpoint_policys/example?response_format=GET_RSP_FORMAT_DEFAULT' \ --header 'Authorization: <Authorization>'GET Bot Endpoint Policy.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace The namespace in which the configuration object is present.
Name The name of the configuration object to be fetched.
Query Parameters
Section titled “Query Parameters”The format in which the configuration object is to be fetched. This could be for example
- in GetSpec form for the contents of object
- in CreateRequest form to create a new similar object
- to ReplaceRequest form to replace changeable values
Default format of returned resource Response should be in ReplaceRequest format Response should be in StatusObject(s) format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.
Responses
Section titled “Responses”A successful response.
This is the output message of the ‘GET’ RPC.
object
The set of deleted objects that are referred by this object.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
The set of deleted objects that are referred by this object.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
object
Human readable description for the object.
A value of true will administratively disable the object.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.
object
This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.
This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
The set of objects that are referring to this object in their spec.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
object
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
object
Human readable description for the object.
A value of true will administratively disable the object.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.
object
This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.
This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""
object
object
Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.
object
Endpoint or connection point
Protected Application Endpoint.
object
object
Request or response body content
Response Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
object
A case-insensitive HTTP header name. Required: YES.
object
object
object
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Header matcher.
Header Operators.
object
object
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
Operator Name
Required: YES.
object
List of HTTP methods.
Required: YES.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
object
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
Request Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
Add the condition for fetching the username from the Request Body.
object
Required: YES.
object
Select Known Bots to allow to proceed to the origin.
Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.
Blocking or denial configuration
object
object
Endpoint or connection point
Protected Application Endpoint.
object
object
Request or response body content
Response Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
object
A case-insensitive HTTP header name. Required: YES.
object
object
object
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Header matcher.
Header Operators.
object
object
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
Operator Name
Required: YES.
object
List of HTTP methods.
Required: YES.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
object
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
URI location for redirect may be relative or absolute. Required: YES.
object
object
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
Request Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
Add the condition for fetching the username from the Request Body.
object
Required: YES.
object
Select Known Bots to allow to proceed to the origin.
Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.
Blocking or denial configuration
object
object
object
Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.
object
Endpoint or connection point
Protected Application Endpoint.
object
object
Request or response body content
Response Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
object
A case-insensitive HTTP header name. Required: YES.
object
object
object
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Header matcher.
Header Operators.
object
object
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
Operator Name
Required: YES.
object
List of HTTP methods.
Required: YES.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
object
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
Request Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
Add the condition for fetching the username from the Request Body.
object
Required: YES.
object
Select Known Bots to allow to proceed to the origin.
Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.
Blocking or denial configuration
object
object
Endpoint or connection point
Protected Application Endpoint.
object
object
Request or response body content
Response Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
object
A case-insensitive HTTP header name. Required: YES.
object
object
object
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
Domain Matchers
Required: YES.
Matcher
object
Domain Matcher Value
Required: YES.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Header matcher.
Header Operators.
object
object
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Header Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
Operator Name
Required: YES.
object
List of HTTP methods.
Required: YES.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.
object
object
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Path Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Path Matcher Value
Required: YES.
object
object
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Query Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
URI location for redirect may be relative or absolute. Required: YES.
object
object
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
RequestBody Matchers
Required: YES.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
Case insensitive checker.
Not checker.
Query Matcher Value
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
Conditions in Cookie, if any, that would help identify valid Requests to the Origin.
object
object
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Cookie Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Body Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
object
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
object
Required: YES.
Conditions in Response Header, if any, that would help identify valid Requests to the Origin.
Response Header values.
object
object
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Response Code Matchers
Required: YES.
object
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
object
Configuration parameter for case sensitive
Configuration parameter for not value
Required: YES.
Operator Name
Required: YES.
object
object
object
Request Header Pair.
object
Enter the Header Name
Required: YES.
Enter the Header Value
Required: YES.
object
Add the condition for fetching the username from the Request Body.
object
Required: YES.
object
Select Known Bots to allow to proceed to the origin.
Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.
Blocking or denial configuration
object
The version number to Endpoint Policy Version for the latest version.
The status reported by different services for this configuration object.
Most recently observed status of object.
object
Conditions reported by various component of the system.
Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.
object
Hostname of the instance of the site that sent the status.
Last time the condition was updated.
A human readable string explaining the reason for reaching this condition.
Name of the service that sent the status.
Status of the condition “Success” Validation has succeeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.
Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.
object
Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.
Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.
ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.
Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)
Uid is the unique in time and space value for a StatusObject.
Origin of this status exchanged by VTRP.
Indicate whether mars deems this object to be stale via graceful restart timer information.
Object reference.
This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)
object
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.
object
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
A value identifying the class of the user or service which created this configuration object.
A value identifying the exact user or service that created this configuration object.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
object
Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
Initializer is information about an initializer that has not yet completed.
object
Name of the service that is responsible for initializing this object.
object
Suggested HTTP return code for this status, 0 if not set.
A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.
Status of the operation. One of: “Success” or “Failure”.
Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).
object
ModificationTimestamp is a timestamp representing the server time when this object was last modified.
Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.
object
Kind of the view object.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.
When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.
UID of the view object.
Tenant to which this configuration object belongs to. The value for this is found from presented credentials.
Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.
Example
{ "replace_form": { "spec": { "endpoint_policy_content": { "protected_mobile_endpoints": { "protected_mobile_endpoints": [ { "block": { "status": "EmptyStatusCode" }, "domain": { "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] } }, "http_methods": [ "BP_METHOD_GET" ], "transaction_result_criteria": { "transaction_result_failure": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } }, "transaction_result_success": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } } } } ] }, "protected_web_endpoints": { "protected_web_endpoints": [ { "block": { "status": "EmptyStatusCode" }, "domain": { "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] } }, "http_methods": [ "BP_METHOD_GET" ], "redirect": { "status": "EmptyStatusCode" }, "transaction_result_criteria": { "transaction_result_failure": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } }, "transaction_result_success": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } } } } ] } } } }, "spec": { "endpoint_policy_content": { "protected_mobile_endpoints": { "protected_mobile_endpoints": [ { "block": { "status": "EmptyStatusCode" }, "domain": { "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] } }, "http_methods": [ "BP_METHOD_GET" ], "transaction_result_criteria": { "transaction_result_failure": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } }, "transaction_result_success": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } } } } ] }, "protected_web_endpoints": { "protected_web_endpoints": [ { "block": { "status": "EmptyStatusCode" }, "domain": { "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT" } ] } }, "http_methods": [ "BP_METHOD_GET" ], "redirect": { "status": "EmptyStatusCode" }, "transaction_result_criteria": { "transaction_result_failure": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } }, "transaction_result_success": { "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } } } } } ] } } }, "status": [ { "metadata": { "publish": "STATUS_DO_NOT_PUBLISH" } } ]}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example