Skip to content

GET Content.

GET
/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys/{name}/versions/{number}
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/bot_endpoint_policys/example/versions/example \
--header 'Authorization: <Authorization>'

GET the content of the specific policy version.

Examples of this operation.

namespace
required
string

Namespace Namespace.

name
required
string

Name Name of the policy.

number
required
string

Number Version of the policy.

A successful response.

Media typeapplication/json
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
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
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.

string
<= 1024 characters
header_value
Header Value

Enter the Header Value.

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.

string
<= 256 characters
no_headers
object
domain
object
all_domain
object
domain_and
object
domain_match
Domain Matchers

Domain Matchers.

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.

string
>= 1 characters <= 256 characters
domain_none
object
domain_match
Domain Matchers

Domain Matchers.

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.

string
>= 1 characters <= 256 characters
domain_or
object
domain_match
Domain Matchers

Domain Matchers.

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.

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.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
header_none
object
header_match
Header Matchers

Header Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
header_or
object
header_match
Header Matchers

Header Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
not_present_header
object
http_methods
HTTP Methods

List of HTTP methods.

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.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
path
object
all_path
object
path_and
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
path_none
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
path_or
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
query
object
all_query
object
query_and
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
query_none
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
query_or
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
regular_request
object
request_body
object
all_request_body
object
request_body_and
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
request_body_none
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
request_body_or
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
transaction_result_criteria
object
transaction_result_failure
object
cookie_v2
object
cookies_all
object
cookies_and
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_none
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_or
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
responseBody
object
responseBody_all
object
responseBody_and
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_none
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_or
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseCode
object
responseCode_all
object
responseCode_and
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_none
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_or
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
response_header_v2
object
response_header_all
object
response_header_and
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_none
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_or
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
transaction_result_success
object
cookie_v2
object
cookies_all
object
cookies_and
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_none
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_or
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
responseBody
object
responseBody_all
object
responseBody_and
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_none
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_or
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseCode
object
responseCode_all
object
responseCode_and
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_none
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_or
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
response_header_v2
object
response_header_all
object
response_header_and
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_none
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_or
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
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.

string
<= 1024 characters
header_value
Header Value

Enter the Header Value.

string
<= 1024 characters
no_headers
object
usernames
Username Reporting

Add the field name where you store username on the Request Body.

Array<object>
<= 64 items
Username Type
object
encryption_type
string
default: PlainText
Allowed values: PlainText Hashed
username_reporting
Username Reporting

Human-readable name for the resource

string
>= 1 characters <= 256 characters
protected_web_endpoints
object
protected_web_endpoints
Protected Web Endpoints List

Endpoint or connection point

Array<object>
ProtectedWebEndpoint

Protected Application Endpoint.

object
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
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.

string
<= 1024 characters
header_value
Header Value

Enter the Header Value.

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.

string
<= 256 characters
no_headers
object
domain
object
all_domain
object
domain_and
object
domain_match
Domain Matchers

Domain Matchers.

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.

string
>= 1 characters <= 256 characters
domain_none
object
domain_match
Domain Matchers

Domain Matchers.

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.

string
>= 1 characters <= 256 characters
domain_or
object
domain_match
Domain Matchers

Domain Matchers.

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.

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.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
header_none
object
header_match
Header Matchers

Header Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
header_or
object
header_match
Header Matchers

Header Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
not_present_header
object
http_methods
HTTP Methods

List of HTTP methods.

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.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
path
object
all_path
object
path_and
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
path_none
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
path_or
object
path_match
Path Matchers

Path Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 2048 characters
query
object
all_query
object
query_and
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
query_none
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
query_or
object
query_match
Query Matchers

Query Matchers.

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.

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.

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.

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.

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.

string
<= 1024 characters
regular_request
object
request_body
object
all_request_body
object
request_body_and
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
request_body_none
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
request_body_or
object
request_body_match
RequestBody Matchers

RequestBody Matchers.

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.

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.

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.

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.

string
>= 1 characters <= 256 characters
transaction_result_criteria
object
transaction_result_failure
object
cookie_v2
object
cookies_all
object
cookies_and
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_none
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_or
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
responseBody
object
responseBody_all
object
responseBody_and
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_none
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_or
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseCode
object
responseCode_all
object
responseCode_and
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_none
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_or
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
response_header_v2
object
response_header_all
object
response_header_and
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_none
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_or
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
transaction_result_success
object
cookie_v2
object
cookies_all
object
cookies_and
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_none
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
cookies_or
object
cookie_operator
Cookies

Configuration parameter for cookie operator

Array<object>
Cookie
object
cookie
object
cookie_and
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_anything
object
cookie_none
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
cookie_not_present
object
cookie_or
object
cookie_match_v2
Cookie Matchers

Cookie Matchers.

Array<object>
Cookie Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Operator Name

Operator Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
responseBody
object
responseBody_all
object
responseBody_and
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_none
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseBody_or
object
response_body_match_v2
Response Body Matchers

Response Body Matchers.

Array<object>
Response Body Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Body Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
responseCode
object
responseCode_all
object
responseCode_and
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_none
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
responseCode_or
object
responseCode_match
Response Code Matchers

Response Code Matchers.

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

Configuration parameter for value

integer format: int64
>= 3 characters <= 15 characters
response_header_v2
object
response_header_all
object
response_header_and
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_none
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
response_header_or
object
response_header_operator
Response Header

Configuration parameter for response header operator

Array<object>
Response Header Name Operator Pair

Response Header values.

object
header
object
header_and
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_anything
object
header_none
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
header_not_present
object
header_or
object
response_header_match_v2
Response Header Matchers

Response Header Matchers.

Array<object>
Response Header Matcher Type
object
case_sensitive
Case sensitive

Configuration parameter for case sensitive

boolean format: boolean
not
Check not

Configuration parameter for not

boolean format: boolean
operator
string
default: RESPONSE_OPERATOR_EQUALS_TO
Allowed values: RESPONSE_OPERATOR_EQUALS_TO RESPONSE_OPERATOR_CONTAINS RESPONSE_OPERATOR_STARTS_WITH RESPONSE_OPERATOR_ENDS_WITH
value
Response Header Matcher Value

Configuration parameter for value

string
>= 1 characters <= 256 characters
name
Header Name

Header Name.

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
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.

string
<= 1024 characters
header_value
Header Value

Enter the Header Value.

string
<= 1024 characters
no_headers
object
usernames
Username Reporting

Add the field name where you store username on the Request Body.

Array<object>
<= 64 items
Username Type
object
encryption_type
string
default: PlainText
Allowed values: PlainText Hashed
username_reporting
Username Reporting

Human-readable name for the resource

string
>= 1 characters <= 256 characters
Example
{
"endpoint_policy_content": {
"protected_mobile_endpoints": {
"protected_mobile_endpoints": [
{
"block": {
"status": "EmptyStatusCode"
},
"domain": {
"domain_and": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
},
"domain_none": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
},
"domain_or": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
}
},
"http_methods": [
"BP_METHOD_GET"
],
"transaction_result_criteria": {
"transaction_result_failure": {
"cookie_v2": {
"cookies_and": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_none": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_or": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
},
"responseBody": {
"responseBody_and": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_none": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_or": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
},
"responseCode": {
"responseCode_and": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_none": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_or": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
}
},
"response_header_v2": {
"response_header_and": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_none": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_or": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
}
},
"transaction_result_success": {
"cookie_v2": {
"cookies_and": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_none": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_or": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
},
"responseBody": {
"responseBody_and": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_none": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_or": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
},
"responseCode": {
"responseCode_and": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_none": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_or": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
}
},
"response_header_v2": {
"response_header_and": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_none": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_or": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
}
}
},
"usernames": [
{
"encryption_type": "PlainText"
}
]
}
]
},
"protected_web_endpoints": {
"protected_web_endpoints": [
{
"block": {
"status": "EmptyStatusCode"
},
"domain": {
"domain_and": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
},
"domain_none": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
},
"domain_or": {
"domain_match": [
{
"negation": "NO",
"operator": "EXACT"
}
]
}
},
"http_methods": [
"BP_METHOD_GET"
],
"redirect": {
"status": "EmptyStatusCode"
},
"transaction_result_criteria": {
"transaction_result_failure": {
"cookie_v2": {
"cookies_and": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_none": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_or": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
},
"responseBody": {
"responseBody_and": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_none": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_or": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
},
"responseCode": {
"responseCode_and": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_none": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_or": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
}
},
"response_header_v2": {
"response_header_and": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_none": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_or": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
}
},
"transaction_result_success": {
"cookie_v2": {
"cookies_and": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_none": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"cookies_or": {
"cookie_operator": [
{
"cookie": {
"cookie_and": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_none": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"cookie_or": {
"cookie_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
},
"responseBody": {
"responseBody_and": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_none": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"responseBody_or": {
"response_body_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
},
"responseCode": {
"responseCode_and": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_none": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
},
"responseCode_or": {
"responseCode_match": [
{
"operator": "CODE_EQUALS"
}
]
}
},
"response_header_v2": {
"response_header_and": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_none": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
},
"response_header_or": {
"response_header_operator": [
{
"header": {
"header_and": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_none": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
},
"header_or": {
"response_header_match_v2": [
{
"operator": "RESPONSE_OPERATOR_EQUALS_TO"
}
]
}
}
}
]
}
}
}
},
"usernames": [
{
"encryption_type": "PlainText"
}
]
}
]
}
}
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example