Custom Replace Bot Endpoint Policy.

PUT

/api/shape/bot/custom/namespaces/{namespace}/bot_endpoint_policys/{name}

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/custom/namespaces/example/bot_endpoint_policys/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "namespace": "example", "spec": { "endpoint_policy_content": { "js_download_path": "example", "protected_mobile_endpoints": { "protected_mobile_endpoints": [ { "block": { "body": "example", "name_value_pair": [ { "header_name": "example", "header_value": "example" } ], "status": "EmptyStatusCode" }, "continue": { "append_headers": { "auto_type_header_name": "example" }, "no_headers": {} }, "domain": { "all_domain": {}, "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] } }, "flow_label_choice": { "account_management": { "change_password": {}, "check_eligibility": {}, "create": {}, "exists": {}, "password_forgot": {}, "password_recover": {}, "password_reset": {} }, "authentication": { "login": {}, "login_alexa": {}, "login_mfa": {}, "login_partner": {}, "logout": {}, "token_refresh": {}, "token_validate": {}, "zelle_retrieve_token": {} }, "credit_card": { "activate": {}, "apply": {}, "apply_to_account": {}, "view_history": {}, "view_list": {} }, "delivery_services": { "hold": {}, "incorrectly_routed": {}, "view_items": {} }, "financial_services": { "account_apply": {}, "loan_personal_apply": {}, "money_send": {}, "money_transfer": {}, "ofx": {}, "request_credit_score": {}, "student_apply": {}, "zelle_execute_transaction": {} }, "flight": { "change_flight": {}, "checkin": {}, "flight_status": {}, "submit_travel_documents": {}, "time_table": {}, "view_flight": {} }, "guest_session": { "create": {} }, "loyalty": { "conversion": {}, "reset_miles": {}, "view_account": {} }, "mailing_list": { "create_password": {}, "signup": {}, "unsubscribe": {} }, "media": { "content": {}, "play": {}, "record": {} }, "miscellaneous": { "contact_us": {}, "ratings": {} }, "profile_management": { "create": {}, "update": {}, "view": {} }, "quotes": { "insurance_fire_request": {}, "request": {} }, "search": { "fare_search": {}, "find_user": {}, "flight_search": {}, "location_search": {}, "product_search": {}, "room_search": {}, "shipment_search": {}, "ticket_search": {} }, "shopping_gift_cards": { "gift_card_check_balance": {}, "gift_card_make_purches_with_card": {}, "gift_card_purchase_card": {}, "shop_add_to_cart": {}, "shop_apply_gift_card": {}, "shop_apply_promo_code": {}, "shop_checkout": {}, "shop_choose_seat": {}, "shop_enter_drawing_submission": {}, "shop_hold_inventory": {}, "shop_make_payment": {}, "shop_offer": {}, "shop_order": {}, "shop_price_inquiry": {}, "shop_purchase_gift_card": {}, "shop_return": {}, "shop_schedule_pickup": {}, "shop_track_order": {}, "shop_update_quantity": {} }, "socials": { "follow": {}, "like": {}, "message": {} }, "undefined_flow_label": {} }, "header": [ { "all_header": {}, "header_and": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "header_none": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "header_or": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ], "http_methods": [ "BP_METHOD_GET" ], "metadata": { "description": "example", "name": "example" }, "path": { "all_path": {}, "path_and": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "path_none": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "path_or": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "query": { "all_query": {}, "query_and": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "query_none": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "query_or": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "request_body": { "all_request_body": {}, "request_body_and": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "request_body_none": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "request_body_or": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "transaction_result_criteria": { "transaction_result_failure": { "cookie": [ { "cookie_all": {}, "cookie_and": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_none": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_or": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_cookie": {} } ], "responseBody": { "responseBody_all": {}, "responseBody_and": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_none": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_or": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] } }, "responseCode": { "responseCode_all": {}, "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] } }, "responseHeader": [ { "header_all": {}, "header_and": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_none": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_or": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ] }, "transaction_result_success": { "cookie": [ { "cookie_all": {}, "cookie_and": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_none": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_or": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_cookie": {} } ], "responseBody": { "responseBody_all": {}, "responseBody_and": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_none": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_or": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] } }, "responseCode": { "responseCode_all": {}, "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] } }, "responseHeader": [ { "header_all": {}, "header_and": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_none": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_or": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ] } }, "transform": { "add_headers": { "name_value_pair": [ { "header_name": "example", "header_value": "example" } ] }, "no_headers": {} }, "usernames": [ { "username_reporting": "example" } ], "allow_deny": { "allow_list": [ "example" ], "deny_list": [ "example" ], "text_block": "example" }, "regular_request": {} } ] }, "protected_web_endpoints": { "protected_web_endpoints": [ { "block": { "body": "example", "name_value_pair": [ { "header_name": "example", "header_value": "example" } ], "status": "EmptyStatusCode" }, "continue": { "append_headers": { "auto_type_header_name": "example" }, "no_headers": {} }, "domain": { "all_domain": {}, "domain_and": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] }, "domain_none": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] }, "domain_or": { "domain_match": [ { "negation": "NO", "operator": "EXACT", "value": "example" } ] } }, "flow_label_choice": { "account_management": { "change_password": {}, "check_eligibility": {}, "create": {}, "exists": {}, "password_forgot": {}, "password_recover": {}, "password_reset": {} }, "authentication": { "login": {}, "login_alexa": {}, "login_mfa": {}, "login_partner": {}, "logout": {}, "token_refresh": {}, "token_validate": {}, "zelle_retrieve_token": {} }, "credit_card": { "activate": {}, "apply": {}, "apply_to_account": {}, "view_history": {}, "view_list": {} }, "delivery_services": { "hold": {}, "incorrectly_routed": {}, "view_items": {} }, "financial_services": { "account_apply": {}, "loan_personal_apply": {}, "money_send": {}, "money_transfer": {}, "ofx": {}, "request_credit_score": {}, "student_apply": {}, "zelle_execute_transaction": {} }, "flight": { "change_flight": {}, "checkin": {}, "flight_status": {}, "submit_travel_documents": {}, "time_table": {}, "view_flight": {} }, "guest_session": { "create": {} }, "loyalty": { "conversion": {}, "reset_miles": {}, "view_account": {} }, "mailing_list": { "create_password": {}, "signup": {}, "unsubscribe": {} }, "media": { "content": {}, "play": {}, "record": {} }, "miscellaneous": { "contact_us": {}, "ratings": {} }, "profile_management": { "create": {}, "update": {}, "view": {} }, "quotes": { "insurance_fire_request": {}, "request": {} }, "search": { "fare_search": {}, "find_user": {}, "flight_search": {}, "location_search": {}, "product_search": {}, "room_search": {}, "shipment_search": {}, "ticket_search": {} }, "shopping_gift_cards": { "gift_card_check_balance": {}, "gift_card_make_purches_with_card": {}, "gift_card_purchase_card": {}, "shop_add_to_cart": {}, "shop_apply_gift_card": {}, "shop_apply_promo_code": {}, "shop_checkout": {}, "shop_choose_seat": {}, "shop_enter_drawing_submission": {}, "shop_hold_inventory": {}, "shop_make_payment": {}, "shop_offer": {}, "shop_order": {}, "shop_price_inquiry": {}, "shop_purchase_gift_card": {}, "shop_return": {}, "shop_schedule_pickup": {}, "shop_track_order": {}, "shop_update_quantity": {} }, "socials": { "follow": {}, "like": {}, "message": {} }, "undefined_flow_label": {} }, "header": [ { "all_header": {}, "header_and": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "header_none": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "header_or": { "header_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ], "http_methods": [ "BP_METHOD_GET" ], "metadata": { "description": "example", "name": "example" }, "path": { "all_path": {}, "path_and": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "path_none": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "path_or": { "path_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "query": { "all_query": {}, "query_and": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "query_none": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "query_or": { "query_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "redirect": { "status": "EmptyStatusCode", "uri": "example" }, "request_body": { "all_request_body": {}, "request_body_and": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "request_body_none": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] }, "request_body_or": { "request_body_match": [ { "contain_value": { "case_insensitive": true, "not": true, "value": "example" }, "end_with_value": { "case_insensitive": true, "not": true, "value": "example" }, "exact_value": { "case_insensitive": true, "not": true, "value": "example" }, "start_with_value": { "case_insensitive": true, "not": true, "value": "example" } } ] } }, "transaction_result_criteria": { "transaction_result_failure": { "cookie": [ { "cookie_all": {}, "cookie_and": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_none": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_or": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_cookie": {} } ], "responseBody": { "responseBody_all": {}, "responseBody_and": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_none": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_or": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] } }, "responseCode": { "responseCode_all": {}, "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] } }, "responseHeader": [ { "header_all": {}, "header_and": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_none": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_or": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ] }, "transaction_result_success": { "cookie": [ { "cookie_all": {}, "cookie_and": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_none": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "cookie_or": { "cookie_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_cookie": {} } ], "responseBody": { "responseBody_all": {}, "responseBody_and": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_none": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "responseBody_or": { "responseBody_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] } }, "responseCode": { "responseCode_all": {}, "responseCode_and": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_none": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] }, "responseCode_or": { "responseCode_match": [ { "operator": "CODE_EQUALS", "value": 1 } ] } }, "responseHeader": [ { "header_all": {}, "header_and": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_none": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "header_or": { "responseHeader_match": [ { "contains": { "case_sensitive": true, "not_value": true, "value": "example" }, "ends_with": { "case_sensitive": true, "not_value": true, "value": "example" }, "equals": { "case_sensitive": true, "not_value": true, "value": "example" }, "starts_with": { "case_sensitive": true, "not_value": true, "value": "example" } } ] }, "name": "example", "not_present_header": {} } ] } }, "transform": { "add_headers": { "name_value_pair": [ { "header_name": "example", "header_value": "example" } ] }, "no_headers": {} }, "usernames": [ { "username_reporting": "example" } ], "allow_deny": { "allow_list": [ "example" ], "deny_list": [ "example" ], "text_block": "example" }, "regular_request": {} } ] } } } }'

• F5 Distributed Cloud Console

Customreplace CustomAPI.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace.

name

required

string

Name Name of the policy.

Request Body^required

Media typeapplication/json

CustomReplaceRequest is used to replace contents of a bot_endpoint_policy

object

name

Name

Name of the policy.

string

>= 6 characters <= 1024 characters

namespace

Namespace

Namespace.

string

>= 6 characters <= 1024 characters

spec

object

endpoint_policy_content

object

js_download_path

JavaScript Download Path

Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.

string

<= 1024 characters

protected_mobile_endpoints

object

protected_mobile_endpoints

Protected Mobile Endpoints List

Endpoint or connection point

Array<object>

ProtectedMobileEndpoint

Protected Application Endpoint.

object

block

object

body

body

Request or response body content

string

<= 4096 characters

name_value_pair

Response Header

Response Header Pair.

Array<object>

Header Name and Value Pair

object

header_name

Header Name

Enter the Header Name

Required: YES.

string

<= 1024 characters

header_value

Header Value

Enter the Header Value

Required: YES.

string

<= 1024 characters

status

string

default: EmptyStatusCode

Allowed values: EmptyStatusCode Continue SwitchingProtocols Processing OK Created Accepted NonAuthoritativeInformation NoContent ResetContent PartialContent MultiStatus AlreadyReported IMUsed MultipleChoices MovedPermanently Found SeeOther NotModified UseProxy TemporaryRedirect PermanentRedirect BadRequest Unauthorized PaymentRequired Forbidden NotFound MethodNotAllowed NotAcceptable ProxyAuthenticationRequired RequestTimeout Conflict Gone LengthRequired PreconditionFailed PayloadTooLarge URITooLong UnsupportedMediaType RangeNotSatisfiable ExpectationFailed TeaPot EnhanceYourCalm UnprocessableEntity Locked FailedDependency ReservedforWebDAV UpgradeRequired PreconditionRequired TooManyRequests RequestHeaderFieldsTooLarge NoResponse RetryWith Blockedby UnavailableForLegalReasons ClientClosedRequest InternalServerError NotImplemented BadGateway ServiceUnavailable GatewayTimeout HTTPVersionNotSupported VariantAlsoNegotiates InsufficientStorage LoopDetected BandwidthLimitExceeded NotExtended NetworkAuthenticationRequired NetworkReadRimeoutError NetworkConnectTimeoutError

continue

object

append_headers

object

auto_type_header_name

auto_type_header_name

A case-insensitive HTTP header name. Required: YES.

string

<= 256 characters

no_headers

object

domain

object

all_domain

object

domain_and

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

domain_none

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

domain_or

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

flow_label_choice

object

account_management

object

change_password

object

check_eligibility

object

create

object

exists

object

password_forgot

object

password_recover

object

password_reset

object

authentication

object

login

object

login_alexa

object

login_mfa

object

login_partner

object

logout

object

token_refresh

object

token_validate

object

zelle_retrieve_token

object

credit_card

object

activate

object

apply

object

apply_to_account

object

view_history

object

view_list

object

delivery_services

object

hold

object

incorrectly_routed

object

view_items

object

financial_services

object

account_apply

object

loan_personal_apply

object

money_send

object

money_transfer

object

ofx

object

request_credit_score

object

student_apply

object

zelle_execute_transaction

object

flight

object

change_flight

object

checkin

object

flight_status

object

submit_travel_documents

object

time_table

object

view_flight

object

guest_session

object

create

object

loyalty

object

conversion

object

reset_miles

object

view_account

object

mailing_list

object

create_password

object

signup

object

unsubscribe

object

media

object

content

object

play

object

record

object

miscellaneous

object

contact_us

object

ratings

object

profile_management

object

create

object

update

object

view

object

quotes

object

insurance_fire_request

object

request

object

search

object

fare_search

object

find_user

object

flight_search

object

location_search

object

product_search

object

room_search

object

shipment_search

object

ticket_search

object

shopping_gift_cards

object

gift_card_check_balance

object

gift_card_make_purches_with_card

object

gift_card_purchase_card

object

shop_add_to_cart

object

shop_apply_gift_card

object

shop_apply_promo_code

object

shop_checkout

object

shop_choose_seat

object

shop_enter_drawing_submission

object

shop_hold_inventory

object

shop_make_payment

object

shop_offer

object

shop_order

object

shop_price_inquiry

object

shop_purchase_gift_card

object

shop_return

object

shop_schedule_pickup

object

shop_track_order

object

shop_update_quantity

object

socials

object

follow

object

like

object

message

object

undefined_flow_label

object

header

Header

Header matcher.

Array<object>

Header Operators

Header Operators.

object

all_header

object

header_and

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

http_methods

HTTP Methods

List of HTTP methods.

Required: YES.

Array<string>

>= 1 items <= 9 items

Allowed values: BP_METHOD_GET BP_METHOD_POST BP_METHOD_PUT BP_METHOD_PATCH BP_METHOD_DELETE BP_METHOD_GET_DOCUMENT BP_METHOD_HEAD BP_METHOD_OPTIONS BP_METHOD_TRACE

metadata

object

description

description

Human readable description.

string

>= 21 characters <= 256 characters

name

name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 1 characters <= 1024 characters

path

object

all_path

object

path_and

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

path_none

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

path_or

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

query

object

all_query

object

query_and

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

query_none

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

query_or

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

request_body

object

all_request_body

object

request_body_and

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

request_body_none

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

request_body_or

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

transaction_result_criteria

object

transaction_result_failure

object

cookie

Cookie

Conditions in Cookie, if any, that would help identify valid Requests to the Origin.

Array<object>

Cookie

object

cookie_all

object

cookie_and

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_none

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_or

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_cookie

object

responseBody

object

responseBody_all

object

responseBody_and

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_none

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_or

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseCode

object

responseCode_all

object

responseCode_and

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_none

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_or

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseHeader

Response Header

Conditions in Response Header, if any, that would help identify valid Requests to the Origin.

Array<object>

Response Header Name Operator Pair

Response Header values.

object

header_all

object

header_and

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

transaction_result_success

object

cookie

Cookie

Conditions in Cookie, if any, that would help identify valid Requests to the Origin.

Array<object>

Cookie

object

cookie_all

object

cookie_and

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_none

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_or

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_cookie

object

responseBody

object

responseBody_all

object

responseBody_and

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_none

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_or

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseCode

object

responseCode_all

object

responseCode_and

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_none

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_or

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseHeader

Response Header

Conditions in Response Header, if any, that would help identify valid Requests to the Origin.

Array<object>

Response Header Name Operator Pair

Response Header values.

object

header_all

object

header_and

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

transform

object

add_headers

object

name_value_pair

Request Header

Request Header Pair.

Array<object>

Header Name and Value Pair

object

header_name

Header Name

Enter the Header Name

Required: YES.

string

<= 1024 characters

header_value

Header Value

Enter the Header Value

Required: YES.

string

<= 1024 characters

no_headers

object

usernames

Username Reporting

Add the condition for fetching the username from the Request Body.

Array<object>

<= 64 items

Username Type

object

username_reporting

Username Reporting

Required: YES.

string

>= 1 characters <= 256 characters

allow_deny

object

allow_list

Allow List

Select Known Bots to allow to proceed to the origin.

Array<string>

deny_list

Deny List

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.

Array<string>

text_block

All others text_block

Blocking or denial configuration

string

<= 1024 characters

regular_request

object

protected_web_endpoints

object

protected_web_endpoints

Protected Web Endpoints List

Endpoint or connection point

Array<object>

ProtectedWebEndpoint

Protected Application Endpoint.

object

block

object

body

body

Request or response body content

string

<= 4096 characters

name_value_pair

Response Header

Response Header Pair.

Array<object>

Header Name and Value Pair

object

header_name

Header Name

Enter the Header Name

Required: YES.

string

<= 1024 characters

header_value

Header Value

Enter the Header Value

Required: YES.

string

<= 1024 characters

status

string

default: EmptyStatusCode

Allowed values: EmptyStatusCode Continue SwitchingProtocols Processing OK Created Accepted NonAuthoritativeInformation NoContent ResetContent PartialContent MultiStatus AlreadyReported IMUsed MultipleChoices MovedPermanently Found SeeOther NotModified UseProxy TemporaryRedirect PermanentRedirect BadRequest Unauthorized PaymentRequired Forbidden NotFound MethodNotAllowed NotAcceptable ProxyAuthenticationRequired RequestTimeout Conflict Gone LengthRequired PreconditionFailed PayloadTooLarge URITooLong UnsupportedMediaType RangeNotSatisfiable ExpectationFailed TeaPot EnhanceYourCalm UnprocessableEntity Locked FailedDependency ReservedforWebDAV UpgradeRequired PreconditionRequired TooManyRequests RequestHeaderFieldsTooLarge NoResponse RetryWith Blockedby UnavailableForLegalReasons ClientClosedRequest InternalServerError NotImplemented BadGateway ServiceUnavailable GatewayTimeout HTTPVersionNotSupported VariantAlsoNegotiates InsufficientStorage LoopDetected BandwidthLimitExceeded NotExtended NetworkAuthenticationRequired NetworkReadRimeoutError NetworkConnectTimeoutError

continue

object

append_headers

object

auto_type_header_name

auto_type_header_name

A case-insensitive HTTP header name. Required: YES.

string

<= 256 characters

no_headers

object

domain

object

all_domain

object

domain_and

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

domain_none

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

domain_or

object

domain_match

Domain Matchers

Domain Matchers

Required: YES.

Array<object>

Domain Matcher Type

Matcher

object

negation

string

default: NO

Allowed values: NO YES

operator

string

default: EXACT

Allowed values: EXACT CONTAIN START_WITH END_WITH

value

Domain Matcher Value

Domain Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

flow_label_choice

object

account_management

object

change_password

object

check_eligibility

object

create

object

exists

object

password_forgot

object

password_recover

object

password_reset

object

authentication

object

login

object

login_alexa

object

login_mfa

object

login_partner

object

logout

object

token_refresh

object

token_validate

object

zelle_retrieve_token

object

credit_card

object

activate

object

apply

object

apply_to_account

object

view_history

object

view_list

object

delivery_services

object

hold

object

incorrectly_routed

object

view_items

object

financial_services

object

account_apply

object

loan_personal_apply

object

money_send

object

money_transfer

object

ofx

object

request_credit_score

object

student_apply

object

zelle_execute_transaction

object

flight

object

change_flight

object

checkin

object

flight_status

object

submit_travel_documents

object

time_table

object

view_flight

object

guest_session

object

create

object

loyalty

object

conversion

object

reset_miles

object

view_account

object

mailing_list

object

create_password

object

signup

object

unsubscribe

object

media

object

content

object

play

object

record

object

miscellaneous

object

contact_us

object

ratings

object

profile_management

object

create

object

update

object

view

object

quotes

object

insurance_fire_request

object

request

object

search

object

fare_search

object

find_user

object

flight_search

object

location_search

object

product_search

object

room_search

object

shipment_search

object

ticket_search

object

shopping_gift_cards

object

gift_card_check_balance

object

gift_card_make_purches_with_card

object

gift_card_purchase_card

object

shop_add_to_cart

object

shop_apply_gift_card

object

shop_apply_promo_code

object

shop_checkout

object

shop_choose_seat

object

shop_enter_drawing_submission

object

shop_hold_inventory

object

shop_make_payment

object

shop_offer

object

shop_order

object

shop_price_inquiry

object

shop_purchase_gift_card

object

shop_return

object

shop_schedule_pickup

object

shop_track_order

object

shop_update_quantity

object

socials

object

follow

object

like

object

message

object

undefined_flow_label

object

header

Header

Header matcher.

Array<object>

Header Operators

Header Operators.

object

all_header

object

header_and

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

header_match

Header Matchers

Header Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

http_methods

HTTP Methods

List of HTTP methods.

Required: YES.

Array<string>

>= 1 items <= 9 items

Allowed values: BP_METHOD_GET BP_METHOD_POST BP_METHOD_PUT BP_METHOD_PATCH BP_METHOD_DELETE BP_METHOD_GET_DOCUMENT BP_METHOD_HEAD BP_METHOD_OPTIONS BP_METHOD_TRACE

metadata

object

description

description

Human readable description.

string

>= 21 characters <= 256 characters

name

name

This is the name of the message. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 1 characters <= 1024 characters

path

object

all_path

object

path_and

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

path_none

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

path_or

object

path_match

Path Matchers

Path Matchers

Required: YES.

Array<object>

Matcher

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Path Matcher Value

Path Matcher Value

Required: YES.

string

>= 1 characters <= 2048 characters

query

object

all_query

object

query_and

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

query_none

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

query_or

object

query_match

Query Matchers

Query Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

redirect

object

status

string

default: EmptyStatusCode

Allowed values: EmptyStatusCode Continue OK Created Accepted NonAuthoritativeInformation NoContent ResetContent PartialContent MultiStatus AlreadyReported IMUsed MultipleChoices MovedPermanently Found SeeOther NotModified UseProxy TemporaryRedirect PermanentRedirect BadRequest Unauthorized PaymentRequired Forbidden NotFound MethodNotAllowed NotAcceptable ProxyAuthenticationRequired RequestTimeout Conflict Gone LengthRequired PreconditionFailed PayloadTooLarge URITooLong UnsupportedMediaType RangeNotSatisfiable ExpectationFailed MisdirectedRequest UnprocessableEntity Locked FailedDependency UpgradeRequired PreconditionRequired TooManyRequests RequestHeaderFieldsTooLarge InternalServerError NotImplemented BadGateway ServiceUnavailable GatewayTimeout HTTPVersionNotSupported VariantAlsoNegotiates InsufficientStorage LoopDetected NotExtended NetworkAuthenticationRequired

uri

URI Location

URI location for redirect may be relative or absolute. Required: YES.

string

<= 1024 characters

request_body

object

all_request_body

object

request_body_and

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

request_body_none

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

request_body_or

object

request_body_match

RequestBody Matchers

RequestBody Matchers

Required: YES.

Array<object>

Matcher Type

Matcher

object

contain_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

end_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

exact_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

start_with_value

object

case_insensitive

Check case insensitive

Case insensitive checker.

boolean format: boolean

not

Check not

Not checker.

boolean format: boolean

value

Query Matcher Value

Query Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

transaction_result_criteria

object

transaction_result_failure

object

cookie

Cookie

Conditions in Cookie, if any, that would help identify valid Requests to the Origin.

Array<object>

Cookie

object

cookie_all

object

cookie_and

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_none

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_or

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_cookie

object

responseBody

object

responseBody_all

object

responseBody_and

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_none

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_or

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseCode

object

responseCode_all

object

responseCode_and

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_none

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_or

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseHeader

Response Header

Conditions in Response Header, if any, that would help identify valid Requests to the Origin.

Array<object>

Response Header Name Operator Pair

Response Header values.

object

header_all

object

header_and

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

transaction_result_success

object

cookie

Cookie

Conditions in Cookie, if any, that would help identify valid Requests to the Origin.

Array<object>

Cookie

object

cookie_all

object

cookie_and

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_none

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

cookie_or

object

cookie_match

Cookie Matchers

Cookie Matchers

Required: YES.

Array<object>

Cookie Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Cookie Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_cookie

object

responseBody

object

responseBody_all

object

responseBody_and

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_none

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseBody_or

object

responseBody_match

Response Body Matchers

Response Body Matchers

Required: YES.

Array<object>

Response Body Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Body Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

responseCode

object

responseCode_all

object

responseCode_and

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_none

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseCode_or

object

responseCode_match

Response Code Matchers

Required: YES.

Array<object>

Response Code Matcher Type

object

operator

string

default: CODE_EQUALS

Allowed values: CODE_EQUALS CODE_NOT_EQUAL_TO CODE_LESS_THAN CODE_GREATER_THAN CODE_LESS_THAN_OR_EQUAlS_TO CODE_GREATER_THAN_OR_EQUAlS_TO

value

Response code Matcher Value

Required: YES.

integer format: int64

>= 3 characters <= 15 characters

responseHeader

Response Header

Conditions in Response Header, if any, that would help identify valid Requests to the Origin.

Array<object>

Response Header Name Operator Pair

Response Header values.

object

header_all

object

header_and

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_none

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

header_or

object

responseHeader_match

Response Header Matchers

Response Code Matchers

Required: YES.

Array<object>

Response Header Matcher Type

object

contains

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

ends_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

equals

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

starts_with

object

case_sensitive

Case sensitive

Configuration parameter for case sensitive

boolean format: boolean

not_value

Negation

Configuration parameter for not value

boolean format: boolean

value

Response Header Matcher Value

Required: YES.

string

>= 1 characters <= 256 characters

name

Operator Name

Operator Name

Required: YES.

string

>= 6 characters <= 1024 characters

not_present_header

object

transform

object

add_headers

object

name_value_pair

Request Header

Request Header Pair.

Array<object>

Header Name and Value Pair

object

header_name

Header Name

Enter the Header Name

Required: YES.

string

<= 1024 characters

header_value

Header Value

Enter the Header Value

Required: YES.

string

<= 1024 characters

no_headers

object

usernames

Username Reporting

Add the condition for fetching the username from the Request Body.

Array<object>

<= 64 items

Username Type

object

username_reporting

Username Reporting

Required: YES.

string

>= 1 characters <= 256 characters

allow_deny

object

allow_list

Allow List

Select Known Bots to allow to proceed to the origin.

Array<string>

deny_list

Deny List

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.

Array<string>

text_block

All others text_block

Blocking or denial configuration

string

<= 1024 characters

regular_request

object

Responses

200

A successful response.

Media typeapplication/json

object

Example^generated

{}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example