- Home
- API Enriched
- Shape
- shape
- GET Content.
GET Content.
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/versions/example';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/versions/example \ --header 'Authorization: <Authorization>'GET the content of the specific policy version.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Namespace Namespace.
Name Name of the policy.
Number Version of the policy.
Responses
Section titled “Responses”A successful response.
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
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
Request or response body content
Response Header Pair.
object
Enter the Header Name.
Enter the Header Value.
object
object
A case-insensitive HTTP header name.
object
object
object
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
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.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Header Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Header Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
Operator Name.
object
List of HTTP methods.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format.
object
object
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
object
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
object
object
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
object
object
object
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
object
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
object
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
object
object
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
object
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
object
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
object
Request Header Pair.
object
Enter the Header Name.
Enter the Header Value.
object
Add the field name where you store username on the Request Body.
object
Human-readable name for the resource
object
Endpoint or connection point
Protected Application Endpoint.
object
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
Request or response body content
Response Header Pair.
object
Enter the Header Name.
Enter the Header Value.
object
object
A case-insensitive HTTP header name.
object
object
object
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
Domain Matchers.
Matcher
object
Domain Matcher Value.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
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.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Header Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Header Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
Operator Name.
object
List of HTTP methods.
object
Human readable description.
This is the name of the message. The value of name has to follow DNS-1035 format.
object
object
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Path Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
Case insensitive checker.
Not checker.
Path Matcher Value.
object
object
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Query Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
URI location for redirect may be relative or absolute.
object
object
object
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
RequestBody Matchers.
Matcher
object
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
Case insensitive checker.
Not checker.
Query Matcher Value.
object
object
object
object
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
object
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
object
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
object
object
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
Configuration parameter for cookie operator
object
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Cookie Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Operator Name.
object
object
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
Response Body Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
Response Code Matchers.
object
Configuration parameter for value
object
object
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
Configuration parameter for response header operator
Response Header values.
object
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
object
object
Response Header Matchers.
object
Configuration parameter for case sensitive
Configuration parameter for not
Configuration parameter for value
Header Name.
object
object
Request Header Pair.
object
Enter the Header Name.
Enter the Header Value.
object
Add the field name where you store username on the Request Body.
object
Human-readable name for the resource
Example
{ "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": { "cookie_v2": { "cookies_and": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_none": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_or": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } }, "responseBody": { "responseBody_and": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_none": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_or": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } }, "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } }, "response_header_v2": { "response_header_and": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_none": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_or": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } } }, "transaction_result_success": { "cookie_v2": { "cookies_and": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_none": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_or": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } }, "responseBody": { "responseBody_and": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_none": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_or": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } }, "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } }, "response_header_v2": { "response_header_and": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_none": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_or": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } } } }, "usernames": [ { "encryption_type": "PlainText" } ] } ] }, "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": { "cookie_v2": { "cookies_and": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_none": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_or": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } }, "responseBody": { "responseBody_and": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_none": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_or": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } }, "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } }, "response_header_v2": { "response_header_and": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_none": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_or": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } } }, "transaction_result_success": { "cookie_v2": { "cookies_and": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_none": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "cookies_or": { "cookie_operator": [ { "cookie": { "cookie_and": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_none": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "cookie_or": { "cookie_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } }, "responseBody": { "responseBody_and": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_none": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "responseBody_or": { "response_body_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } }, "responseCode": { "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS" } ] } }, "response_header_v2": { "response_header_and": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_none": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] }, "response_header_or": { "response_header_operator": [ { "header": { "header_and": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_none": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] }, "header_or": { "response_header_match_v2": [ { "operator": "RESPONSE_OPERATOR_EQUALS_TO" } ] } } } ] } } } }, "usernames": [ { "encryption_type": "PlainText" } ] } ] } }}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