@robinmordasiewicz/f5xc-terraform-mcp 3.5.1 → 3.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (110) hide show
  1. package/dist/docs/data-sources/bgp.md +2 -2
  2. package/dist/docs/data-sources/discovery.md +2 -2
  3. package/dist/docs/data-sources/fast_acl.md +2 -2
  4. package/dist/docs/data-sources/fast_acl_rule.md +2 -2
  5. package/dist/docs/data-sources/irule.md +2 -2
  6. package/dist/docs/data-sources/log_receiver.md +2 -2
  7. package/dist/docs/data-sources/network_policy.md +2 -2
  8. package/dist/docs/data-sources/route.md +2 -2
  9. package/dist/docs/data-sources/site.md +2 -2
  10. package/dist/docs/resources/address_allocator.md +7 -7
  11. package/dist/docs/resources/advertise_policy.md +57 -57
  12. package/dist/docs/resources/alert_policy.md +40 -40
  13. package/dist/docs/resources/alert_receiver.md +57 -57
  14. package/dist/docs/resources/api_crawler.md +13 -13
  15. package/dist/docs/resources/api_definition.md +11 -11
  16. package/dist/docs/resources/api_discovery.md +4 -4
  17. package/dist/docs/resources/api_testing.md +27 -27
  18. package/dist/docs/resources/apm.md +40 -40
  19. package/dist/docs/resources/app_api_group.md +20 -20
  20. package/dist/docs/resources/app_firewall.md +50 -50
  21. package/dist/docs/resources/app_setting.md +19 -19
  22. package/dist/docs/resources/app_type.md +7 -7
  23. package/dist/docs/resources/authentication.md +29 -29
  24. package/dist/docs/resources/aws_tgw_site.md +140 -140
  25. package/dist/docs/resources/aws_vpc_site.md +174 -174
  26. package/dist/docs/resources/azure_vnet_site.md +245 -245
  27. package/dist/docs/resources/bgp.md +37 -205
  28. package/dist/docs/resources/bgp_asn_set.md +1 -1
  29. package/dist/docs/resources/bgp_routing_policy.md +19 -19
  30. package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
  31. package/dist/docs/resources/cdn_cache_rule.md +5 -5
  32. package/dist/docs/resources/cdn_loadbalancer.md +418 -418
  33. package/dist/docs/resources/certificate.md +1 -1
  34. package/dist/docs/resources/certificate_chain.md +1 -1
  35. package/dist/docs/resources/cloud_connect.md +28 -28
  36. package/dist/docs/resources/cloud_credentials.md +35 -35
  37. package/dist/docs/resources/cloud_elastic_ip.md +8 -8
  38. package/dist/docs/resources/cloud_link.md +36 -36
  39. package/dist/docs/resources/cluster.md +86 -86
  40. package/dist/docs/resources/cminstance.md +22 -22
  41. package/dist/docs/resources/code_base_integration.md +24 -24
  42. package/dist/docs/resources/container_registry.md +13 -13
  43. package/dist/docs/resources/crl.md +1 -1
  44. package/dist/docs/resources/data_type.md +16 -16
  45. package/dist/docs/resources/dc_cluster_group.md +4 -4
  46. package/dist/docs/resources/discovery.md +8 -259
  47. package/dist/docs/resources/dns_compliance_checks.md +1 -1
  48. package/dist/docs/resources/dns_domain.md +3 -3
  49. package/dist/docs/resources/endpoint.md +44 -44
  50. package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
  51. package/dist/docs/resources/external_connector.md +42 -42
  52. package/dist/docs/resources/fast_acl.md +60 -166
  53. package/dist/docs/resources/fast_acl_rule.md +28 -28
  54. package/dist/docs/resources/filter_set.md +10 -10
  55. package/dist/docs/resources/fleet.md +160 -160
  56. package/dist/docs/resources/forward_proxy_policy.md +82 -82
  57. package/dist/docs/resources/forwarding_class.md +14 -14
  58. package/dist/docs/resources/gcp_vpc_site.md +152 -152
  59. package/dist/docs/resources/global_log_receiver.md +238 -238
  60. package/dist/docs/resources/healthcheck.md +17 -17
  61. package/dist/docs/resources/http_loadbalancer.md +1003 -1003
  62. package/dist/docs/resources/irule.md +5 -7
  63. package/dist/docs/resources/log_receiver.md +825 -44
  64. package/dist/docs/resources/malicious_user_mitigation.md +10 -10
  65. package/dist/docs/resources/nat_policy.md +86 -86
  66. package/dist/docs/resources/network_connector.md +31 -31
  67. package/dist/docs/resources/network_firewall.md +22 -22
  68. package/dist/docs/resources/network_interface.md +77 -77
  69. package/dist/docs/resources/network_policy.md +38 -217
  70. package/dist/docs/resources/network_policy_rule.md +21 -21
  71. package/dist/docs/resources/network_policy_view.md +65 -65
  72. package/dist/docs/resources/nfv_service.md +76 -76
  73. package/dist/docs/resources/nginx_service_discovery.md +10 -10
  74. package/dist/docs/resources/origin_pool.md +166 -166
  75. package/dist/docs/resources/policer.md +4 -4
  76. package/dist/docs/resources/policy_based_routing.md +28 -28
  77. package/dist/docs/resources/protocol_inspection.md +12 -12
  78. package/dist/docs/resources/protocol_policer.md +14 -14
  79. package/dist/docs/resources/proxy.md +111 -111
  80. package/dist/docs/resources/rate_limiter.md +15 -15
  81. package/dist/docs/resources/rate_limiter_policy.md +56 -56
  82. package/dist/docs/resources/route.md +183 -183
  83. package/dist/docs/resources/secret_management_access.md +68 -68
  84. package/dist/docs/resources/securemesh_site.md +1619 -258
  85. package/dist/docs/resources/segment.md +4 -4
  86. package/dist/docs/resources/sensitive_data_policy.md +9 -9
  87. package/dist/docs/resources/service_policy.md +175 -175
  88. package/dist/docs/resources/service_policy_rule.md +142 -142
  89. package/dist/docs/resources/site.md +381 -303
  90. package/dist/docs/resources/site_mesh_group.md +18 -18
  91. package/dist/docs/resources/subnet.md +17 -17
  92. package/dist/docs/resources/tcp_loadbalancer.md +130 -130
  93. package/dist/docs/resources/tenant_configuration.md +10 -10
  94. package/dist/docs/resources/trusted_ca_list.md +1 -1
  95. package/dist/docs/resources/tunnel.md +36 -36
  96. package/dist/docs/resources/udp_loadbalancer.md +59 -59
  97. package/dist/docs/resources/usb_policy.md +6 -6
  98. package/dist/docs/resources/user_identification.md +16 -16
  99. package/dist/docs/resources/virtual_host.md +225 -225
  100. package/dist/docs/resources/virtual_network.md +14 -14
  101. package/dist/docs/resources/virtual_site.md +3 -3
  102. package/dist/docs/resources/voltstack_site.md +141 -141
  103. package/dist/docs/resources/waf_exclusion_policy.md +17 -17
  104. package/dist/docs/resources/workload.md +327 -327
  105. package/dist/docs/resources/workload_flavor.md +3 -3
  106. package/dist/metadata/resource-metadata.json +1484 -942
  107. package/dist/types.d.ts +11 -0
  108. package/dist/types.d.ts.map +1 -1
  109. package/dist/types.js.map +1 -1
  110. package/package.json +1 -1
@@ -2,12 +2,12 @@
2
2
  page_title: "f5xc_route Resource - terraform-provider-f5xc"
3
3
  subcategory: "Load Balancing"
4
4
  description: |-
5
- Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. Virtual host object has reference to route object. in F5 Distributed Cloud.
5
+ Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. in F5 Distributed Cloud.
6
6
  ---
7
7
 
8
8
  # f5xc_route (Resource)
9
9
 
10
- Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. Virtual host object has reference to route object. in F5 Distributed Cloud.
10
+ Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. in F5 Distributed Cloud.
11
11
 
12
12
  ~> **Note** For more information about this resource, please refer to the [F5 XC API Documentation](https://docs.cloud.f5.com/docs/api/).
13
13
 
@@ -15,7 +15,7 @@ Manages route object in a given namespace. Route object is list of route rules.
15
15
 
16
16
  ```terraform
17
17
  # Route Resource Example
18
- # Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. Virtual host object has reference to route object. in F5 Distributed Cloud.
18
+ # Manages route object in a given namespace. Route object is list of route rules. Each rule has match condition to match incoming requests and actions to take on matching requests. in F5 Distributed Cloud.
19
19
 
20
20
  # Basic Route configuration
21
21
  resource "f5xc_route" "example" {
@@ -70,7 +70,7 @@ resource "f5xc_route" "example" {
70
70
 
71
71
  ### Spec Argument Reference
72
72
 
73
- <a id="routes"></a>&#x2022; [`routes`](#routes) - Optional Block<br>Routes. List of routes to match for incoming request<br>See [Routes](#routes) below for details.
73
+ <a id="routes"></a>&#x2022; [`routes`](#routes) - Optional Block<br>List of routes to match for incoming request<br>See [Routes](#routes) below for details.
74
74
 
75
75
  <a id="timeouts"></a>&#x2022; [`timeouts`](#timeouts) - Optional Block
76
76
 
@@ -86,59 +86,59 @@ In addition to all arguments above, the following attributes are exported:
86
86
 
87
87
  A [`routes`](#routes) block supports the following:
88
88
 
89
- <a id="routes-bot-defense-javascript-injection"></a>&#x2022; [`bot_defense_javascript_injection`](#routes-bot-defense-javascript-injection) - Optional Block<br>Bot Defense Javascript Injection Configuration for inline deployments. Bot Defense Javascript Injection Configuration for inline bot defense deployments<br>See [Bot Defense Javascript Injection](#routes-bot-defense-javascript-injection) below.
89
+ <a id="routes-bot-defense-javascript-injection"></a>&#x2022; [`bot_defense_javascript_injection`](#routes-bot-defense-javascript-injection) - Optional Block<br>Bot Defense Javascript Injection Configuration for inline bot defense deployments<br>See [Bot Defense Javascript Injection](#routes-bot-defense-javascript-injection) below.
90
90
 
91
- <a id="routes-disable-location-add"></a>&#x2022; [`disable_location_add`](#routes-disable-location-add) - Optional Bool<br>Disable Location Addition. Disables append of x-F5 Distributed Cloud-location = `<RE-site-name>` at route level, if it is configured at virtual-host level. This configuration is ignored on CE sites
91
+ <a id="routes-disable-location-add"></a>&#x2022; [`disable_location_add`](#routes-disable-location-add) - Optional Bool<br>Disables append of x-F5 Distributed Cloud-location = `<RE-site-name>` at route level, if it is configured at virtual-host level. This configuration is ignored on CE sites
92
92
 
93
- <a id="injection-2c38a2"></a>&#x2022; [`inherited_bot_defense_javascript_injection`](#injection-2c38a2) - Optional Block<br>Enable this option
93
+ <a id="injection-2c38a2"></a>&#x2022; [`inherited_bot_defense_javascript_injection`](#injection-2c38a2) - Optional Block<br>Can be used for messages where no values are needed
94
94
 
95
- <a id="routes-inherited-waf-exclusion"></a>&#x2022; [`inherited_waf_exclusion`](#routes-inherited-waf-exclusion) - Optional Block<br>Enable this option
95
+ <a id="routes-inherited-waf-exclusion"></a>&#x2022; [`inherited_waf_exclusion`](#routes-inherited-waf-exclusion) - Optional Block<br>Can be used for messages where no values are needed
96
96
 
97
97
  <a id="routes-match"></a>&#x2022; [`match`](#routes-match) - Optional Block<br>Match. Route match condition<br>See [Match](#routes-match) below.
98
98
 
99
- <a id="routes-request-cookies-to-add"></a>&#x2022; [`request_cookies_to_add`](#routes-request-cookies-to-add) - Optional Block<br>Add Cookies in Cookie Header. Cookies are key-value pairs to be added to HTTP request being routed towards upstream<br>See [Request Cookies To Add](#routes-request-cookies-to-add) below.
99
+ <a id="routes-request-cookies-to-add"></a>&#x2022; [`request_cookies_to_add`](#routes-request-cookies-to-add) - Optional Block<br>Cookies are key-value pairs to be added to HTTP request being routed towards upstream<br>See [Request Cookies To Add](#routes-request-cookies-to-add) below.
100
100
 
101
- <a id="routes-request-cookies-to-remove"></a>&#x2022; [`request_cookies_to_remove`](#routes-request-cookies-to-remove) - Optional List<br>Remove Cookies from Cookie Header. List of keys of Cookies to be removed from the HTTP request being sent towards upstream
101
+ <a id="routes-request-cookies-to-remove"></a>&#x2022; [`request_cookies_to_remove`](#routes-request-cookies-to-remove) - Optional List<br>List of keys of Cookies to be removed from the HTTP request being sent towards upstream
102
102
 
103
- <a id="routes-request-headers-to-add"></a>&#x2022; [`request_headers_to_add`](#routes-request-headers-to-add) - Optional Block<br>Request Headers to Add. Headers are key-value pairs to be added to HTTP requests being sent towards upstream. Headers specified at this level are applied before headers from the enclosing VirtualHost object level<br>See [Request Headers To Add](#routes-request-headers-to-add) below.
103
+ <a id="routes-request-headers-to-add"></a>&#x2022; [`request_headers_to_add`](#routes-request-headers-to-add) - Optional Block<br>Headers are key-value pairs to be added to HTTP requests being sent towards upstream. Headers specified at this level are applied before headers from the enclosing VirtualHost object level<br>See [Request Headers To Add](#routes-request-headers-to-add) below.
104
104
 
105
- <a id="routes-request-headers-to-remove"></a>&#x2022; [`request_headers_to_remove`](#routes-request-headers-to-remove) - Optional List<br>Request Headers to Remove. List of keys of Headers to be removed from the HTTP request being sent towards upstream
105
+ <a id="routes-request-headers-to-remove"></a>&#x2022; [`request_headers_to_remove`](#routes-request-headers-to-remove) - Optional List<br>List of keys of Headers to be removed from the HTTP request being sent towards upstream
106
106
 
107
- <a id="routes-response-cookies-to-add"></a>&#x2022; [`response_cookies_to_add`](#routes-response-cookies-to-add) - Optional Block<br>Add Set-Cookie Headers. Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream<br>See [Response Cookies To Add](#routes-response-cookies-to-add) below.
107
+ <a id="routes-response-cookies-to-add"></a>&#x2022; [`response_cookies_to_add`](#routes-response-cookies-to-add) - Optional Block<br>Cookies are name-value pairs along with optional attribute parameters to be added to HTTP response being sent towards downstream<br>See [Response Cookies To Add](#routes-response-cookies-to-add) below.
108
108
 
109
- <a id="routes-response-cookies-to-remove"></a>&#x2022; [`response_cookies_to_remove`](#routes-response-cookies-to-remove) - Optional List<br>Remove Cookies from Set-Cookie Headers. List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
109
+ <a id="routes-response-cookies-to-remove"></a>&#x2022; [`response_cookies_to_remove`](#routes-response-cookies-to-remove) - Optional List<br>List of name of Cookies to be removed from the HTTP response being sent towards downstream. Entire set-cookie header will be removed
110
110
 
111
- <a id="routes-response-headers-to-add"></a>&#x2022; [`response_headers_to_add`](#routes-response-headers-to-add) - Optional Block<br>Response Headers to Add. Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied before headers from the enclosing VirtualHost object level<br>See [Response Headers To Add](#routes-response-headers-to-add) below.
111
+ <a id="routes-response-headers-to-add"></a>&#x2022; [`response_headers_to_add`](#routes-response-headers-to-add) - Optional Block<br>Headers are key-value pairs to be added to HTTP response being sent towards downstream. Headers specified at this level are applied before headers from the enclosing VirtualHost object level<br>See [Response Headers To Add](#routes-response-headers-to-add) below.
112
112
 
113
- <a id="routes-response-headers-to-remove"></a>&#x2022; [`response_headers_to_remove`](#routes-response-headers-to-remove) - Optional List<br>Response Headers to Remove. List of keys of Headers to be removed from the HTTP response being sent towards downstream
113
+ <a id="routes-response-headers-to-remove"></a>&#x2022; [`response_headers_to_remove`](#routes-response-headers-to-remove) - Optional List<br>List of keys of Headers to be removed from the HTTP response being sent towards downstream
114
114
 
115
- <a id="routes-route-destination"></a>&#x2022; [`route_destination`](#routes-route-destination) - Optional Block<br>Destination List. List of destination to choose if the route is match<br>See [Route Destination](#routes-route-destination) below.
115
+ <a id="routes-route-destination"></a>&#x2022; [`route_destination`](#routes-route-destination) - Optional Block<br>List of destination to choose if the route is match<br>See [Route Destination](#routes-route-destination) below.
116
116
 
117
- <a id="routes-route-direct-response"></a>&#x2022; [`route_direct_response`](#routes-route-direct-response) - Optional Block<br>Direct Response. Send this direct response in case of route match action is direct response<br>See [Route Direct Response](#routes-route-direct-response) below.
117
+ <a id="routes-route-direct-response"></a>&#x2022; [`route_direct_response`](#routes-route-direct-response) - Optional Block<br>Send this direct response in case of route match action is direct response<br>See [Route Direct Response](#routes-route-direct-response) below.
118
118
 
119
- <a id="routes-route-redirect"></a>&#x2022; [`route_redirect`](#routes-route-redirect) - Optional Block<br>Redirect. Route redirect parameters when match action is redirect<br>See [Route Redirect](#routes-route-redirect) below.
119
+ <a id="routes-route-redirect"></a>&#x2022; [`route_redirect`](#routes-route-redirect) - Optional Block<br>Route redirect parameters when match action is redirect<br>See [Route Redirect](#routes-route-redirect) below.
120
120
 
121
- <a id="routes-service-policy"></a>&#x2022; [`service_policy`](#routes-service-policy) - Optional Block<br>Service Policy Configuration. ServicePolicy configuration details at route level<br>See [Service Policy](#routes-service-policy) below.
121
+ <a id="routes-service-policy"></a>&#x2022; [`service_policy`](#routes-service-policy) - Optional Block<br>ServicePolicy configuration details at route level<br>See [Service Policy](#routes-service-policy) below.
122
122
 
123
- <a id="routes-waf-exclusion-policy"></a>&#x2022; [`waf_exclusion_policy`](#routes-waf-exclusion-policy) - Optional Block<br>Object reference. This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [WAF Exclusion Policy](#routes-waf-exclusion-policy) below.
123
+ <a id="routes-waf-exclusion-policy"></a>&#x2022; [`waf_exclusion_policy`](#routes-waf-exclusion-policy) - Optional Block<br>Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name<br>See [WAF Exclusion Policy](#routes-waf-exclusion-policy) below.
124
124
 
125
- <a id="routes-waf-type"></a>&#x2022; [`waf_type`](#routes-waf-type) - Optional Block<br>WAF Instance. WAF instance will be pointing to an app_firewall object<br>See [WAF Type](#routes-waf-type) below.
125
+ <a id="routes-waf-type"></a>&#x2022; [`waf_type`](#routes-waf-type) - Optional Block<br>WAF instance will be pointing to an app_firewall object<br>See [WAF Type](#routes-waf-type) below.
126
126
 
127
127
  #### Routes Bot Defense Javascript Injection
128
128
 
129
129
  A [`bot_defense_javascript_injection`](#routes-bot-defense-javascript-injection) block (within [`routes`](#routes)) supports the following:
130
130
 
131
- <a id="location-95316f"></a>&#x2022; [`javascript_location`](#location-95316f) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT] JavaScript Location. All inside networks. Insert JavaScript after `<HEAD>` tag Insert JavaScript after `</title>` tag. Insert JavaScript before first &lt;script> tag
131
+ <a id="location-95316f"></a>&#x2022; [`javascript_location`](#location-95316f) - Optional String Defaults to `AFTER_HEAD`<br>Possible values are `AFTER_HEAD`, `AFTER_TITLE_END`, `BEFORE_SCRIPT`<br>[Enum: AFTER_HEAD|AFTER_TITLE_END|BEFORE_SCRIPT] All inside networks. Insert JavaScript after `<HEAD>` tag Insert JavaScript after `</title>` tag. Insert JavaScript before first &lt;script> tag
132
132
 
133
- <a id="tags-60ccf3"></a>&#x2022; [`javascript_tags`](#tags-60ccf3) - Optional Block<br>JavaScript Tags. Select Add item to configure your javascript tag. If adding both Bot Adv and Fraud, the Bot Javascript should be added first<br>See [Javascript Tags](#tags-60ccf3) below.
133
+ <a id="tags-60ccf3"></a>&#x2022; [`javascript_tags`](#tags-60ccf3) - Optional Block<br>Select Add item to configure your javascript tag. If adding both Bot Adv and Fraud, the Bot Javascript should be added first<br>See [Javascript Tags](#tags-60ccf3) below.
134
134
 
135
135
  #### Routes Bot Defense Javascript Injection Javascript Tags
136
136
 
137
137
  A [`javascript_tags`](#tags-60ccf3) block (within [`routes.bot_defense_javascript_injection`](#routes-bot-defense-javascript-injection)) supports the following:
138
138
 
139
- <a id="url-f5fba1"></a>&#x2022; [`javascript_url`](#url-f5fba1) - Optional String<br>URL. Please enter the full URL (include domain and path), or relative path
139
+ <a id="url-f5fba1"></a>&#x2022; [`javascript_url`](#url-f5fba1) - Optional String<br>Please enter the full URL (include domain and path), or relative path
140
140
 
141
- <a id="attributes-f612c4"></a>&#x2022; [`tag_attributes`](#attributes-f612c4) - Optional Block<br>Tag Attributes. Add the tag attributes you want to include in your Javascript tag<br>See [Tag Attributes](#attributes-f612c4) below.
141
+ <a id="attributes-f612c4"></a>&#x2022; [`tag_attributes`](#attributes-f612c4) - Optional Block<br>Add the tag attributes you want to include in your Javascript tag<br>See [Tag Attributes](#attributes-f612c4) below.
142
142
 
143
143
  #### Routes Bot Defense Javascript Injection Javascript Tags Tag Attributes
144
144
 
@@ -150,11 +150,11 @@ A [`match`](#routes-match) block (within [`routes`](#routes)) supports the follo
150
150
 
151
151
  <a id="routes-match-headers"></a>&#x2022; [`headers`](#routes-match-headers) - Optional Block<br>Headers. List of (key, value) headers<br>See [Headers](#routes-match-headers) below.
152
152
 
153
- <a id="routes-match-http-method"></a>&#x2022; [`http_method`](#routes-match-http-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> HTTP Method. Specifies the HTTP method used to access a resource. Any HTTP Method
153
+ <a id="routes-match-http-method"></a>&#x2022; [`http_method`](#routes-match-http-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br> Specifies the HTTP method used to access a resource. Any HTTP Method
154
154
 
155
- <a id="routes-match-incoming-port"></a>&#x2022; [`incoming_port`](#routes-match-incoming-port) - Optional Block<br>Port to Match. Port match of the request can be a range or a specific port<br>See [Incoming Port](#routes-match-incoming-port) below.
155
+ <a id="routes-match-incoming-port"></a>&#x2022; [`incoming_port`](#routes-match-incoming-port) - Optional Block<br>Port match of the request can be a range or a specific port<br>See [Incoming Port](#routes-match-incoming-port) below.
156
156
 
157
- <a id="routes-match-path"></a>&#x2022; [`path`](#routes-match-path) - Optional Block<br>Path to Match. Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#routes-match-path) below.
157
+ <a id="routes-match-path"></a>&#x2022; [`path`](#routes-match-path) - Optional Block<br>Path match of the URI can be either be, Prefix match or exact match or regular expression match<br>See [Path](#routes-match-path) below.
158
158
 
159
159
  <a id="routes-match-query-params"></a>&#x2022; [`query_params`](#routes-match-query-params) - Optional Block<br>Query Parameters. List of (key, value) query parameters<br>See [Query Params](#routes-match-query-params) below.
160
160
 
@@ -162,65 +162,65 @@ A [`match`](#routes-match) block (within [`routes`](#routes)) supports the follo
162
162
 
163
163
  A [`headers`](#routes-match-headers) block (within [`routes.match`](#routes-match)) supports the following:
164
164
 
165
- <a id="routes-match-headers-exact"></a>&#x2022; [`exact`](#routes-match-headers-exact) - Optional String<br>Exact. Header value to match exactly
165
+ <a id="routes-match-headers-exact"></a>&#x2022; [`exact`](#routes-match-headers-exact) - Optional String<br>Header value to match exactly
166
166
 
167
- <a id="routes-match-headers-invert-match"></a>&#x2022; [`invert_match`](#routes-match-headers-invert-match) - Optional Bool<br>NOT of match. Invert the result of the match to detect missing header or non-matching value
167
+ <a id="routes-match-headers-invert-match"></a>&#x2022; [`invert_match`](#routes-match-headers-invert-match) - Optional Bool<br>Invert the result of the match to detect missing header or non-matching value
168
168
 
169
169
  <a id="routes-match-headers-name"></a>&#x2022; [`name`](#routes-match-headers-name) - Optional String<br>Name. Name of the header
170
170
 
171
- <a id="routes-match-headers-presence"></a>&#x2022; [`presence`](#routes-match-headers-presence) - Optional Bool<br>Presence. If true, check for presence of header
171
+ <a id="routes-match-headers-presence"></a>&#x2022; [`presence`](#routes-match-headers-presence) - Optional Bool<br>If true, check for presence of header
172
172
 
173
- <a id="routes-match-headers-regex"></a>&#x2022; [`regex`](#routes-match-headers-regex) - Optional String<br>Regex. Regex match of the header value in re2 format
173
+ <a id="routes-match-headers-regex"></a>&#x2022; [`regex`](#routes-match-headers-regex) - Optional String<br>Regex match of the header value in re2 format
174
174
 
175
175
  #### Routes Match Incoming Port
176
176
 
177
177
  An [`incoming_port`](#routes-match-incoming-port) block (within [`routes.match`](#routes-match)) supports the following:
178
178
 
179
- <a id="match-1d4edd"></a>&#x2022; [`no_port_match`](#match-1d4edd) - Optional Block<br>Enable this option
179
+ <a id="match-1d4edd"></a>&#x2022; [`no_port_match`](#match-1d4edd) - Optional Block<br>Can be used for messages where no values are needed
180
180
 
181
- <a id="routes-match-incoming-port-port"></a>&#x2022; [`port`](#routes-match-incoming-port-port) - Optional Number<br>Port. Exact Port to match
181
+ <a id="routes-match-incoming-port-port"></a>&#x2022; [`port`](#routes-match-incoming-port-port) - Optional Number<br>Exact Port to match
182
182
 
183
- <a id="routes-match-incoming-port-port-ranges"></a>&#x2022; [`port_ranges`](#routes-match-incoming-port-port-ranges) - Optional String<br>Port range. Port range to match
183
+ <a id="routes-match-incoming-port-port-ranges"></a>&#x2022; [`port_ranges`](#routes-match-incoming-port-port-ranges) - Optional String<br>Port range to match
184
184
 
185
185
  #### Routes Match Path
186
186
 
187
187
  A [`path`](#routes-match-path) block (within [`routes.match`](#routes-match)) supports the following:
188
188
 
189
- <a id="routes-match-path-path"></a>&#x2022; [`path`](#routes-match-path-path) - Optional String<br>Exact. Exact path value to match
189
+ <a id="routes-match-path-path"></a>&#x2022; [`path`](#routes-match-path-path) - Optional String<br>Exact path value to match
190
190
 
191
- <a id="routes-match-path-prefix"></a>&#x2022; [`prefix`](#routes-match-path-prefix) - Optional String<br>Prefix. Path prefix to match (e.g. The value / will match on all paths)
191
+ <a id="routes-match-path-prefix"></a>&#x2022; [`prefix`](#routes-match-path-prefix) - Optional String<br>Path prefix to match (e.g. The value / will match on all paths)
192
192
 
193
- <a id="routes-match-path-regex"></a>&#x2022; [`regex`](#routes-match-path-regex) - Optional String<br>Regex. Regular expression of path match (e.g. The value .* will match on all paths)
193
+ <a id="routes-match-path-regex"></a>&#x2022; [`regex`](#routes-match-path-regex) - Optional String<br>Regular expression of path match (e.g. The value .* will match on all paths)
194
194
 
195
195
  #### Routes Match Query Params
196
196
 
197
197
  A [`query_params`](#routes-match-query-params) block (within [`routes.match`](#routes-match)) supports the following:
198
198
 
199
- <a id="routes-match-query-params-exact"></a>&#x2022; [`exact`](#routes-match-query-params-exact) - Optional String<br>Exact. Exact match value for the query parameter key
199
+ <a id="routes-match-query-params-exact"></a>&#x2022; [`exact`](#routes-match-query-params-exact) - Optional String<br>Exact match value for the query parameter key
200
200
 
201
- <a id="routes-match-query-params-key"></a>&#x2022; [`key`](#routes-match-query-params-key) - Optional String<br>Key. Query parameter key In the above example, assignee_username is the key
201
+ <a id="routes-match-query-params-key"></a>&#x2022; [`key`](#routes-match-query-params-key) - Optional String<br>Query parameter key In the above example, assignee_username is the key
202
202
 
203
- <a id="routes-match-query-params-regex"></a>&#x2022; [`regex`](#routes-match-query-params-regex) - Optional String<br>Regex. Regex match value for the query parameter key
203
+ <a id="routes-match-query-params-regex"></a>&#x2022; [`regex`](#routes-match-query-params-regex) - Optional String<br>Regex match value for the query parameter key
204
204
 
205
205
  #### Routes Request Cookies To Add
206
206
 
207
207
  A [`request_cookies_to_add`](#routes-request-cookies-to-add) block (within [`routes`](#routes)) supports the following:
208
208
 
209
- <a id="routes-request-cookies-to-add-name"></a>&#x2022; [`name`](#routes-request-cookies-to-add-name) - Optional String<br>Name. Name of the cookie in Cookie header
209
+ <a id="routes-request-cookies-to-add-name"></a>&#x2022; [`name`](#routes-request-cookies-to-add-name) - Optional String<br>Name of the cookie in Cookie header
210
210
 
211
- <a id="routes-request-cookies-to-add-overwrite"></a>&#x2022; [`overwrite`](#routes-request-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Overwrite. Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
211
+ <a id="routes-request-cookies-to-add-overwrite"></a>&#x2022; [`overwrite`](#routes-request-cookies-to-add-overwrite) - Optional Bool Defaults to `do`<br>Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
212
212
 
213
- <a id="value-4c340b"></a>&#x2022; [`secret_value`](#value-4c340b) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-4c340b) below.
213
+ <a id="value-4c340b"></a>&#x2022; [`secret_value`](#value-4c340b) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-4c340b) below.
214
214
 
215
- <a id="routes-request-cookies-to-add-value"></a>&#x2022; [`value`](#routes-request-cookies-to-add-value) - Optional String<br>Value. Value of the Cookie header
215
+ <a id="routes-request-cookies-to-add-value"></a>&#x2022; [`value`](#routes-request-cookies-to-add-value) - Optional String<br>Value of the Cookie header
216
216
 
217
217
  #### Routes Request Cookies To Add Secret Value
218
218
 
219
219
  A [`secret_value`](#value-4c340b) block (within [`routes.request_cookies_to_add`](#routes-request-cookies-to-add)) supports the following:
220
220
 
221
- <a id="info-8a6590"></a>&#x2022; [`blindfold_secret_info`](#info-8a6590) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-8a6590) below.
221
+ <a id="info-8a6590"></a>&#x2022; [`blindfold_secret_info`](#info-8a6590) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-8a6590) below.
222
222
 
223
- <a id="info-f8c679"></a>&#x2022; [`clear_secret_info`](#info-f8c679) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-f8c679) below.
223
+ <a id="info-f8c679"></a>&#x2022; [`clear_secret_info`](#info-f8c679) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-f8c679) below.
224
224
 
225
225
  #### Routes Request Cookies To Add Secret Value Blindfold Secret Info
226
226
 
@@ -234,21 +234,21 @@ A [`secret_value`](#value-4c340b) block (within [`routes.request_cookies_to_add`
234
234
 
235
235
  A [`request_headers_to_add`](#routes-request-headers-to-add) block (within [`routes`](#routes)) supports the following:
236
236
 
237
- <a id="routes-request-headers-to-add-append"></a>&#x2022; [`append`](#routes-request-headers-to-add-append) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
237
+ <a id="routes-request-headers-to-add-append"></a>&#x2022; [`append`](#routes-request-headers-to-add-append) - Optional Bool Defaults to `do`<br>Should the value be appended? If true, the value is appended to existing values. not append
238
238
 
239
239
  <a id="routes-request-headers-to-add-name"></a>&#x2022; [`name`](#routes-request-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
240
240
 
241
- <a id="value-ce9ebf"></a>&#x2022; [`secret_value`](#value-ce9ebf) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-ce9ebf) below.
241
+ <a id="value-ce9ebf"></a>&#x2022; [`secret_value`](#value-ce9ebf) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-ce9ebf) below.
242
242
 
243
- <a id="routes-request-headers-to-add-value"></a>&#x2022; [`value`](#routes-request-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
243
+ <a id="routes-request-headers-to-add-value"></a>&#x2022; [`value`](#routes-request-headers-to-add-value) - Optional String<br>Value of the HTTP header
244
244
 
245
245
  #### Routes Request Headers To Add Secret Value
246
246
 
247
247
  A [`secret_value`](#value-ce9ebf) block (within [`routes.request_headers_to_add`](#routes-request-headers-to-add)) supports the following:
248
248
 
249
- <a id="info-452306"></a>&#x2022; [`blindfold_secret_info`](#info-452306) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-452306) below.
249
+ <a id="info-452306"></a>&#x2022; [`blindfold_secret_info`](#info-452306) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-452306) below.
250
250
 
251
- <a id="info-eaa03d"></a>&#x2022; [`clear_secret_info`](#info-eaa03d) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-eaa03d) below.
251
+ <a id="info-eaa03d"></a>&#x2022; [`clear_secret_info`](#info-eaa03d) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-eaa03d) below.
252
252
 
253
253
  #### Routes Request Headers To Add Secret Value Blindfold Secret Info
254
254
 
@@ -262,59 +262,59 @@ A [`secret_value`](#value-ce9ebf) block (within [`routes.request_headers_to_add`
262
262
 
263
263
  A [`response_cookies_to_add`](#routes-response-cookies-to-add) block (within [`routes`](#routes)) supports the following:
264
264
 
265
- <a id="domain-245f48"></a>&#x2022; [`add_domain`](#domain-245f48) - Optional String<br>Add Domain. Add domain attribute
265
+ <a id="domain-245f48"></a>&#x2022; [`add_domain`](#domain-245f48) - Optional String<br>Add domain attribute
266
266
 
267
- <a id="expiry-62b700"></a>&#x2022; [`add_expiry`](#expiry-62b700) - Optional String<br>Add expiry. Add expiry attribute
267
+ <a id="expiry-62b700"></a>&#x2022; [`add_expiry`](#expiry-62b700) - Optional String<br>Add expiry attribute
268
268
 
269
- <a id="httponly-c2890d"></a>&#x2022; [`add_httponly`](#httponly-c2890d) - Optional Block<br>Enable this option
269
+ <a id="httponly-c2890d"></a>&#x2022; [`add_httponly`](#httponly-c2890d) - Optional Block<br>Can be used for messages where no values are needed
270
270
 
271
- <a id="partitioned-aa1f08"></a>&#x2022; [`add_partitioned`](#partitioned-aa1f08) - Optional Block<br>Enable this option
271
+ <a id="partitioned-aa1f08"></a>&#x2022; [`add_partitioned`](#partitioned-aa1f08) - Optional Block<br>Can be used for messages where no values are needed
272
272
 
273
- <a id="routes-response-cookies-to-add-add-path"></a>&#x2022; [`add_path`](#routes-response-cookies-to-add-add-path) - Optional String<br>Add path. Add path attribute
273
+ <a id="routes-response-cookies-to-add-add-path"></a>&#x2022; [`add_path`](#routes-response-cookies-to-add-add-path) - Optional String<br>Add path attribute
274
274
 
275
- <a id="secure-9cd35a"></a>&#x2022; [`add_secure`](#secure-9cd35a) - Optional Block<br>Enable this option
275
+ <a id="secure-9cd35a"></a>&#x2022; [`add_secure`](#secure-9cd35a) - Optional Block<br>Can be used for messages where no values are needed
276
276
 
277
- <a id="domain-c754cb"></a>&#x2022; [`ignore_domain`](#domain-c754cb) - Optional Block<br>Enable this option
277
+ <a id="domain-c754cb"></a>&#x2022; [`ignore_domain`](#domain-c754cb) - Optional Block<br>Can be used for messages where no values are needed
278
278
 
279
- <a id="expiry-44cdc8"></a>&#x2022; [`ignore_expiry`](#expiry-44cdc8) - Optional Block<br>Enable this option
279
+ <a id="expiry-44cdc8"></a>&#x2022; [`ignore_expiry`](#expiry-44cdc8) - Optional Block<br>Can be used for messages where no values are needed
280
280
 
281
- <a id="httponly-99def6"></a>&#x2022; [`ignore_httponly`](#httponly-99def6) - Optional Block<br>Enable this option
281
+ <a id="httponly-99def6"></a>&#x2022; [`ignore_httponly`](#httponly-99def6) - Optional Block<br>Can be used for messages where no values are needed
282
282
 
283
- <a id="age-478fc0"></a>&#x2022; [`ignore_max_age`](#age-478fc0) - Optional Block<br>Enable this option
283
+ <a id="age-478fc0"></a>&#x2022; [`ignore_max_age`](#age-478fc0) - Optional Block<br>Can be used for messages where no values are needed
284
284
 
285
- <a id="partitioned-7a224c"></a>&#x2022; [`ignore_partitioned`](#partitioned-7a224c) - Optional Block<br>Enable this option
285
+ <a id="partitioned-7a224c"></a>&#x2022; [`ignore_partitioned`](#partitioned-7a224c) - Optional Block<br>Can be used for messages where no values are needed
286
286
 
287
- <a id="path-3677c1"></a>&#x2022; [`ignore_path`](#path-3677c1) - Optional Block<br>Enable this option
287
+ <a id="path-3677c1"></a>&#x2022; [`ignore_path`](#path-3677c1) - Optional Block<br>Can be used for messages where no values are needed
288
288
 
289
- <a id="samesite-0d04a2"></a>&#x2022; [`ignore_samesite`](#samesite-0d04a2) - Optional Block<br>Enable this option
289
+ <a id="samesite-0d04a2"></a>&#x2022; [`ignore_samesite`](#samesite-0d04a2) - Optional Block<br>Can be used for messages where no values are needed
290
290
 
291
- <a id="secure-effaa1"></a>&#x2022; [`ignore_secure`](#secure-effaa1) - Optional Block<br>Enable this option
291
+ <a id="secure-effaa1"></a>&#x2022; [`ignore_secure`](#secure-effaa1) - Optional Block<br>Can be used for messages where no values are needed
292
292
 
293
- <a id="value-0e603e"></a>&#x2022; [`ignore_value`](#value-0e603e) - Optional Block<br>Enable this option
293
+ <a id="value-0e603e"></a>&#x2022; [`ignore_value`](#value-0e603e) - Optional Block<br>Can be used for messages where no values are needed
294
294
 
295
- <a id="value-e8b96e"></a>&#x2022; [`max_age_value`](#value-e8b96e) - Optional Number<br>Add Max Age. Add max age attribute
295
+ <a id="value-e8b96e"></a>&#x2022; [`max_age_value`](#value-e8b96e) - Optional Number<br>Add max age attribute
296
296
 
297
- <a id="routes-response-cookies-to-add-name"></a>&#x2022; [`name`](#routes-response-cookies-to-add-name) - Optional String<br>Name. Name of the cookie in Cookie header
297
+ <a id="routes-response-cookies-to-add-name"></a>&#x2022; [`name`](#routes-response-cookies-to-add-name) - Optional String<br>Name of the cookie in Cookie header
298
298
 
299
- <a id="overwrite-25fb1c"></a>&#x2022; [`overwrite`](#overwrite-25fb1c) - Optional Bool Defaults to `do`<br>Overwrite. Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
299
+ <a id="overwrite-25fb1c"></a>&#x2022; [`overwrite`](#overwrite-25fb1c) - Optional Bool Defaults to `do`<br>Should the value be overwritten? If true, the value is overwritten to existing values. not overwrite
300
300
 
301
- <a id="lax-3799dd"></a>&#x2022; [`samesite_lax`](#lax-3799dd) - Optional Block<br>Enable this option
301
+ <a id="lax-3799dd"></a>&#x2022; [`samesite_lax`](#lax-3799dd) - Optional Block<br>Can be used for messages where no values are needed
302
302
 
303
- <a id="none-d063b8"></a>&#x2022; [`samesite_none`](#none-d063b8) - Optional Block<br>Enable this option
303
+ <a id="none-d063b8"></a>&#x2022; [`samesite_none`](#none-d063b8) - Optional Block<br>Can be used for messages where no values are needed
304
304
 
305
- <a id="strict-b3db69"></a>&#x2022; [`samesite_strict`](#strict-b3db69) - Optional Block<br>Enable this option
305
+ <a id="strict-b3db69"></a>&#x2022; [`samesite_strict`](#strict-b3db69) - Optional Block<br>Can be used for messages where no values are needed
306
306
 
307
- <a id="value-172895"></a>&#x2022; [`secret_value`](#value-172895) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-172895) below.
307
+ <a id="value-172895"></a>&#x2022; [`secret_value`](#value-172895) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-172895) below.
308
308
 
309
- <a id="routes-response-cookies-to-add-value"></a>&#x2022; [`value`](#routes-response-cookies-to-add-value) - Optional String<br>Value. Value of the Cookie header
309
+ <a id="routes-response-cookies-to-add-value"></a>&#x2022; [`value`](#routes-response-cookies-to-add-value) - Optional String<br>Value of the Cookie header
310
310
 
311
311
  #### Routes Response Cookies To Add Secret Value
312
312
 
313
313
  A [`secret_value`](#value-172895) block (within [`routes.response_cookies_to_add`](#routes-response-cookies-to-add)) supports the following:
314
314
 
315
- <a id="info-2f1e53"></a>&#x2022; [`blindfold_secret_info`](#info-2f1e53) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-2f1e53) below.
315
+ <a id="info-2f1e53"></a>&#x2022; [`blindfold_secret_info`](#info-2f1e53) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-2f1e53) below.
316
316
 
317
- <a id="info-a85975"></a>&#x2022; [`clear_secret_info`](#info-a85975) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-a85975) below.
317
+ <a id="info-a85975"></a>&#x2022; [`clear_secret_info`](#info-a85975) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-a85975) below.
318
318
 
319
319
  #### Routes Response Cookies To Add Secret Value Blindfold Secret Info
320
320
 
@@ -328,21 +328,21 @@ A [`secret_value`](#value-172895) block (within [`routes.response_cookies_to_add
328
328
 
329
329
  A [`response_headers_to_add`](#routes-response-headers-to-add) block (within [`routes`](#routes)) supports the following:
330
330
 
331
- <a id="routes-response-headers-to-add-append"></a>&#x2022; [`append`](#routes-response-headers-to-add-append) - Optional Bool Defaults to `do`<br>Append. Should the value be appended? If true, the value is appended to existing values. not append
331
+ <a id="routes-response-headers-to-add-append"></a>&#x2022; [`append`](#routes-response-headers-to-add-append) - Optional Bool Defaults to `do`<br>Should the value be appended? If true, the value is appended to existing values. not append
332
332
 
333
333
  <a id="routes-response-headers-to-add-name"></a>&#x2022; [`name`](#routes-response-headers-to-add-name) - Optional String<br>Name. Name of the HTTP header
334
334
 
335
- <a id="value-6b60b8"></a>&#x2022; [`secret_value`](#value-6b60b8) - Optional Block<br>Secret. SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-6b60b8) below.
335
+ <a id="value-6b60b8"></a>&#x2022; [`secret_value`](#value-6b60b8) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Secret Value](#value-6b60b8) below.
336
336
 
337
- <a id="routes-response-headers-to-add-value"></a>&#x2022; [`value`](#routes-response-headers-to-add-value) - Optional String<br>Value. Value of the HTTP header
337
+ <a id="routes-response-headers-to-add-value"></a>&#x2022; [`value`](#routes-response-headers-to-add-value) - Optional String<br>Value of the HTTP header
338
338
 
339
339
  #### Routes Response Headers To Add Secret Value
340
340
 
341
341
  A [`secret_value`](#value-6b60b8) block (within [`routes.response_headers_to_add`](#routes-response-headers-to-add)) supports the following:
342
342
 
343
- <a id="info-02903c"></a>&#x2022; [`blindfold_secret_info`](#info-02903c) - Optional Block<br>Blindfold Secret. BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-02903c) below.
343
+ <a id="info-02903c"></a>&#x2022; [`blindfold_secret_info`](#info-02903c) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-02903c) below.
344
344
 
345
- <a id="info-4128a5"></a>&#x2022; [`clear_secret_info`](#info-4128a5) - Optional Block<br>In-Clear Secret. ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-4128a5) below.
345
+ <a id="info-4128a5"></a>&#x2022; [`clear_secret_info`](#info-4128a5) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-4128a5) below.
346
346
 
347
347
  #### Routes Response Headers To Add Secret Value Blindfold Secret Info
348
348
 
@@ -356,81 +356,81 @@ A [`secret_value`](#value-6b60b8) block (within [`routes.response_headers_to_add
356
356
 
357
357
  A [`route_destination`](#routes-route-destination) block (within [`routes`](#routes)) supports the following:
358
358
 
359
- <a id="rewrite-f07d9f"></a>&#x2022; [`auto_host_rewrite`](#rewrite-f07d9f) - Optional Bool<br>Automatic Host Rewrite. Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster
359
+ <a id="rewrite-f07d9f"></a>&#x2022; [`auto_host_rewrite`](#rewrite-f07d9f) - Optional Bool<br>Indicates that during forwarding, the host header will be swapped with the hostname of the upstream host chosen by the cluster
360
360
 
361
- <a id="routes-route-destination-buffer-policy"></a>&#x2022; [`buffer_policy`](#routes-route-destination-buffer-policy) - Optional Block<br>Buffer Configuration. Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config. Buffering can be enabled and disabled at VirtualHost and Route levels Route level buffer configuration takes precedence<br>See [Buffer Policy](#routes-route-destination-buffer-policy) below.
361
+ <a id="routes-route-destination-buffer-policy"></a>&#x2022; [`buffer_policy`](#routes-route-destination-buffer-policy) - Optional Block<br>Some upstream applications are not capable of handling streamed data. This config enables buffering the entire request before sending to upstream application. We can specify the maximum buffer size and buffer interval with this config<br>See [Buffer Policy](#routes-route-destination-buffer-policy) below.
362
362
 
363
- <a id="routes-route-destination-cors-policy"></a>&#x2022; [`cors_policy`](#routes-route-destination-cors-policy) - Optional Block<br>CORS Policy. Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Referrer: `HTTP://foo.example/examples/access-control/simplexsinvocation.HTML` Origin: `HTTP://foo.example` HTTP/1.1 200 OK Date: Mon, 01 Dec 2008 00:23:53 GMT Server: Apache/2.0.61 Access-Control-Allow-Origin: \* Keep-Alive: timeout=2, max=100 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: application/XML An example for cross origin HTTP OPTIONS request with Access-Control-Request-* header OPTIONS /resources/POST-here/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre Accept: text/HTML,application/xhtml+XML,application/XML;q=0.9,*/*;q=0.8 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Connection: keep-alive Origin: `HTTP://foo.example` Access-Control-Request-Method: POST Access-Control-Request-Headers: X-PINGOTHER, Content-Type HTTP/1.1 204 No Content Date: Mon, 01 Dec 2008 01:15:39 GMT Server: Apache/2.0.61 (Unix) Access-Control-Allow-Origin: `HTTP://foo.example` Access-Control-Allow-Methods: POST, GET, OPTIONS Access-Control-Allow-Headers: X-PINGOTHER, Content-Type Access-Control-Max-Age: 86400 Vary: Accept-Encoding, Origin Keep-Alive: timeout=2, max=100 Connection: Keep-Alive<br>See [CORS Policy](#routes-route-destination-cors-policy) below.
363
+ <a id="routes-route-destination-cors-policy"></a>&#x2022; [`cors_policy`](#routes-route-destination-cors-policy) - Optional Block<br>Cross-Origin Resource Sharing requests configuration specified at Virtual-host or Route level. Route level configuration takes precedence. An example of an Cross origin HTTP request GET /resources/public-data/ HTTP/1.1 Host: bar.other User-Agent: Mozilla/5.0 (Macintosh; U; Intel MAC OS X 10.5<br>See [CORS Policy](#routes-route-destination-cors-policy) below.
364
364
 
365
- <a id="routes-route-destination-csrf-policy"></a>&#x2022; [`csrf_policy`](#routes-route-destination-csrf-policy) - Optional Block<br>CSRF Policy. To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its detination.the policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent to issue the request (source origin). 2. The origin that the request is going to (target origin). When the policy evaluating a request, it ensures both pieces of information are present and compare their values. If the source origin is missing or origins do not match the request is rejected. The exception to this being if the source-origin has been added to they policy as valid. Because CSRF attacks specifically target state-changing requests, the policy only acts on the HTTP requests that have state-changing method (PUT,POST, etc.)<br>See [CSRF Policy](#routes-route-destination-csrf-policy) below.
365
+ <a id="routes-route-destination-csrf-policy"></a>&#x2022; [`csrf_policy`](#routes-route-destination-csrf-policy) - Optional Block<br>To mitigate CSRF attack , the policy checks where a request is coming from to determine if the request's origin is the same as its detination.the policy relies on two pieces of information used in determining if a request originated from the same host. 1. The origin that caused the user agent to<br>See [CSRF Policy](#routes-route-destination-csrf-policy) below.
366
366
 
367
- <a id="routes-route-destination-destinations"></a>&#x2022; [`destinations`](#routes-route-destination-destinations) - Optional Block<br>Destination Origin pools (clusters). When requests have to distributed among multiple upstream clusters, multiple destinations are configured, each having its own cluster and weight. Traffic is distributed among clusters based on the weight configured. destinations: - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-1 weight: 20 - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-2 weight: 30 - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-3 weight: 50 This indicates that out of every 100 requests, 50 goes to cluster-3, 30 to cluster-2 and 20 to cluster-1 When single destination is configured, weight is ignored. All the requests are sent to the cluster specified in the destination<br>See [Destinations](#routes-route-destination-destinations) below.
367
+ <a id="routes-route-destination-destinations"></a>&#x2022; [`destinations`](#routes-route-destination-destinations) - Optional Block<br>When requests have to distributed among multiple upstream clusters, multiple destinations are configured, each having its own cluster and weight. Traffic is distributed among clusters based on the weight configured<br>See [Destinations](#routes-route-destination-destinations) below.
368
368
 
369
- <a id="cluster-098c21"></a>&#x2022; [`do_not_retract_cluster`](#cluster-098c21) - Optional Block<br>Enable this option
369
+ <a id="cluster-098c21"></a>&#x2022; [`do_not_retract_cluster`](#cluster-098c21) - Optional Block<br>Can be used for messages where no values are needed
370
370
 
371
- <a id="subsets-17b178"></a>&#x2022; [`endpoint_subsets`](#subsets-17b178) - Optional Block<br>Endpoint Subsets. Upstream cluster may be configured to divide its endpoints into subsets based on metadata attached to the endpoints. Routes may then specify the metadata that a endpoint must match in order to be selected by the load balancer Labels field of endpoint object's metadata is used for subset matching. For endpoint's which are discovered in K8S or Consul cluster, the label of the service is merged with endpoint's labels. In case of Consul, the label is derived from the 'Tag' field. For labels that are common between configured endpoint and discovered service, labels from discovered service takes precedence. List of key-value pairs that will be used as matching metadata. Only those endpoints of upstream cluster which match this metadata will be selected for load balancing
371
+ <a id="subsets-17b178"></a>&#x2022; [`endpoint_subsets`](#subsets-17b178) - Optional Block<br>Upstream cluster may be configured to divide its endpoints into subsets based on metadata attached to the endpoints. Routes may then specify the metadata that a endpoint must match in order to be selected by the load balancer Labels field of endpoint object's metadata is used for subset
372
372
 
373
- <a id="routes-route-destination-hash-policy"></a>&#x2022; [`hash_policy`](#routes-route-destination-hash-policy) - Optional Block<br>Hash Policy. Specifies a list of hash policies to use for ring hash load balancing. Each hash policy is evaluated individually and the combined result is used to route the request<br>See [Hash Policy](#routes-route-destination-hash-policy) below.
373
+ <a id="routes-route-destination-hash-policy"></a>&#x2022; [`hash_policy`](#routes-route-destination-hash-policy) - Optional Block<br>Specifies a list of hash policies to use for ring hash load balancing. Each hash policy is evaluated individually and the combined result is used to route the request<br>See [Hash Policy](#routes-route-destination-hash-policy) below.
374
374
 
375
- <a id="routes-route-destination-host-rewrite"></a>&#x2022; [`host_rewrite`](#routes-route-destination-host-rewrite) - Optional String<br>Host Rewrite. Indicates that during forwarding, the host header will be swapped with this value
375
+ <a id="routes-route-destination-host-rewrite"></a>&#x2022; [`host_rewrite`](#routes-route-destination-host-rewrite) - Optional String<br>Indicates that during forwarding, the host header will be swapped with this value
376
376
 
377
- <a id="routes-route-destination-mirror-policy"></a>&#x2022; [`mirror_policy`](#routes-route-destination-mirror-policy) - Optional Block<br>Mirror Policy. MirrorPolicy is used for shadowing traffic from one cluster to another. The approach used is 'fire and forget', meaning it will not wait for the shadow cluster to respond before returning the response from the primary cluster. All normal statistics are collected for the shadow cluster making this feature useful for testing and troubleshooting<br>See [Mirror Policy](#routes-route-destination-mirror-policy) below.
377
+ <a id="routes-route-destination-mirror-policy"></a>&#x2022; [`mirror_policy`](#routes-route-destination-mirror-policy) - Optional Block<br>MirrorPolicy is used for shadowing traffic from one cluster to another. The approach used is 'fire and forget', meaning it will not wait for the shadow cluster to respond before returning the response from the primary cluster. All normal statistics are collected for the shadow cluster making<br>See [Mirror Policy](#routes-route-destination-mirror-policy) below.
378
378
 
379
- <a id="routes-route-destination-prefix-rewrite"></a>&#x2022; [`prefix_rewrite`](#routes-route-destination-prefix-rewrite) - Optional String<br>Prefix Rewrite. prefix_rewrite indicates that during forwarding, the matched prefix (or path) should be swapped with its value. When using regex path matching, the entire path (not including the query string) will be swapped with this value. This option allows application URLs to be rooted at a different path from those exposed at the reverse proxy layer. Example : gcSpec: routes: - match: - headers: [] path: prefix : /register/ query_params: [] - headers: [] path: prefix: /register query_params: [] routeDestination: prefixRewrite: '/' destinations: - cluster: - kind: cluster.object uid: cluster-1 Having above entries in the config, requests to /register will be stripped to /, while requests to /register/public will be stripped to /public
379
+ <a id="routes-route-destination-prefix-rewrite"></a>&#x2022; [`prefix_rewrite`](#routes-route-destination-prefix-rewrite) - Optional String<br>prefix_rewrite indicates that during forwarding, the matched prefix (or path) should be swapped with its value. When using regex path matching, the entire path (not including the query string) will be swapped with this value. This option allows application URLs to
380
380
 
381
- <a id="routes-route-destination-priority"></a>&#x2022; [`priority`](#routes-route-destination-priority) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH] Routing Priority. Priority routing for each request. Different connection pools are used based on the priority selected for the request. Also, circuit-breaker configuration at destination cluster is chosen based on selected priority. Default routing mechanism High-Priority routing mechanism
381
+ <a id="routes-route-destination-priority"></a>&#x2022; [`priority`](#routes-route-destination-priority) - Optional String Defaults to `DEFAULT`<br>Possible values are `DEFAULT`, `HIGH`<br>[Enum: DEFAULT|HIGH] Priority routing for each request. Different connection pools are used based on the priority selected for the request. Also, circuit-breaker configuration at destination cluster is chosen based on selected priority
382
382
 
383
- <a id="routes-route-destination-query-params"></a>&#x2022; [`query_params`](#routes-route-destination-query-params) - Optional Block<br>Query Parameters. Handling of incoming query parameters in simple route<br>See [Query Params](#routes-route-destination-query-params) below.
383
+ <a id="routes-route-destination-query-params"></a>&#x2022; [`query_params`](#routes-route-destination-query-params) - Optional Block<br>Handling of incoming query parameters in simple route<br>See [Query Params](#routes-route-destination-query-params) below.
384
384
 
385
- <a id="routes-route-destination-regex-rewrite"></a>&#x2022; [`regex_rewrite`](#routes-route-destination-regex-rewrite) - Optional Block<br>Regex Match Rewrite. RegexMatchRewrite describes how to match a string and then produce a new string using a regular expression and a substitution string<br>See [Regex Rewrite](#routes-route-destination-regex-rewrite) below.
385
+ <a id="routes-route-destination-regex-rewrite"></a>&#x2022; [`regex_rewrite`](#routes-route-destination-regex-rewrite) - Optional Block<br>RegexMatchRewrite describes how to match a string and then produce a new string using a regular expression and a substitution string<br>See [Regex Rewrite](#routes-route-destination-regex-rewrite) below.
386
386
 
387
- <a id="cluster-96a194"></a>&#x2022; [`retract_cluster`](#cluster-96a194) - Optional Block<br>Enable this option
387
+ <a id="cluster-96a194"></a>&#x2022; [`retract_cluster`](#cluster-96a194) - Optional Block<br>Can be used for messages where no values are needed
388
388
 
389
- <a id="routes-route-destination-retry-policy"></a>&#x2022; [`retry_policy`](#routes-route-destination-retry-policy) - Optional Block<br>Retry Policy. Retry policy configuration for route destination<br>See [Retry Policy](#routes-route-destination-retry-policy) below.
389
+ <a id="routes-route-destination-retry-policy"></a>&#x2022; [`retry_policy`](#routes-route-destination-retry-policy) - Optional Block<br>Retry policy configuration for route destination<br>See [Retry Policy](#routes-route-destination-retry-policy) below.
390
390
 
391
- <a id="routes-route-destination-spdy-config"></a>&#x2022; [`spdy_config`](#routes-route-destination-spdy-config) - Optional Block<br>SPDY Configuration. Request headers of such upgrade looks like below 'connection', 'Upgrade' 'upgrade', 'SPDY/3.1' Configuration to allow UPGRADE of connection to SPDY and any additional tuning With configuration to allow SPDY upgrade, ADC will produce following response 'HTTP/1.1 101 Switching Protocols 'Upgrade': 'SPDY/3.1' 'Connection': 'Upgrade'<br>See [Spdy Config](#routes-route-destination-spdy-config) below.
391
+ <a id="routes-route-destination-spdy-config"></a>&#x2022; [`spdy_config`](#routes-route-destination-spdy-config) - Optional Block<br>Request headers of such upgrade looks like below 'connection', 'Upgrade' 'upgrade', 'SPDY/3.1' Configuration to allow UPGRADE of connection to SPDY and any additional tuning With configuration to allow SPDY upgrade, ADC will produce following response 'HTTP/1.1 101 Switching Protocols 'Upgrade'<br>See [Spdy Config](#routes-route-destination-spdy-config) below.
392
392
 
393
- <a id="routes-route-destination-timeout"></a>&#x2022; [`timeout`](#routes-route-destination-timeout) - Optional Number<br>Timeout. Specifies the timeout for the route in milliseconds. This timeout includes all retries. For server side streaming, configure this field with higher value or leave it un-configured for infinite timeout
393
+ <a id="routes-route-destination-timeout"></a>&#x2022; [`timeout`](#routes-route-destination-timeout) - Optional Number<br>Specifies the timeout for the route in milliseconds. This timeout includes all retries. For server side streaming, configure this field with higher value or leave it un-configured for infinite timeout
394
394
 
395
- <a id="config-449c3d"></a>&#x2022; [`web_socket_config`](#config-449c3d) - Optional Block<br>WebSocket Configuration. Configuration to allow WebSocket Request headers of such upgrade looks like below 'connection', 'Upgrade' 'upgrade', 'WebSocket' With configuration to allow WebSocket upgrade, ADC will produce following response 'HTTP/1.1 101 Switching Protocols 'Upgrade': 'WebSocket' 'Connection': 'Upgrade'<br>See [Web Socket Config](#config-449c3d) below.
395
+ <a id="config-449c3d"></a>&#x2022; [`web_socket_config`](#config-449c3d) - Optional Block<br>Configuration to allow WebSocket Request headers of such upgrade looks like below 'connection', 'Upgrade' 'upgrade', 'WebSocket' With configuration to allow WebSocket upgrade, ADC will produce following response 'HTTP/1.1 101 Switching Protocols 'Upgrade': 'WebSocket' 'Connection': 'Upgrade'<br>See [Web Socket Config](#config-449c3d) below.
396
396
 
397
397
  #### Routes Route Destination Buffer Policy
398
398
 
399
399
  A [`buffer_policy`](#routes-route-destination-buffer-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
400
400
 
401
- <a id="disabled-2d309c"></a>&#x2022; [`disabled`](#disabled-2d309c) - Optional Bool<br>Disable. Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
401
+ <a id="disabled-2d309c"></a>&#x2022; [`disabled`](#disabled-2d309c) - Optional Bool<br>Disable buffering for a particular route. This is useful when virtual-host has buffering, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
402
402
 
403
- <a id="bytes-9a9963"></a>&#x2022; [`max_request_bytes`](#bytes-9a9963) - Optional Number<br>Max Request Bytes. The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
403
+ <a id="bytes-9a9963"></a>&#x2022; [`max_request_bytes`](#bytes-9a9963) - Optional Number<br>The maximum request size that the filter will buffer before the connection manager will stop buffering and return a RequestEntityTooLarge (413) response
404
404
 
405
405
  #### Routes Route Destination CORS Policy
406
406
 
407
407
  A [`cors_policy`](#routes-route-destination-cors-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
408
408
 
409
- <a id="credentials-2b4ba7"></a>&#x2022; [`allow_credentials`](#credentials-2b4ba7) - Optional Bool<br>Allow Credentials. Specifies whether the resource allows credentials
409
+ <a id="credentials-2b4ba7"></a>&#x2022; [`allow_credentials`](#credentials-2b4ba7) - Optional Bool<br>Specifies whether the resource allows credentials
410
410
 
411
- <a id="headers-ce10f0"></a>&#x2022; [`allow_headers`](#headers-ce10f0) - Optional String<br>Allow Headers. Specifies the content for the access-control-allow-headers header
411
+ <a id="headers-ce10f0"></a>&#x2022; [`allow_headers`](#headers-ce10f0) - Optional String<br>Specifies the content for the access-control-allow-headers header
412
412
 
413
- <a id="methods-2a71b7"></a>&#x2022; [`allow_methods`](#methods-2a71b7) - Optional String<br>Allow Methods. Specifies the content for the access-control-allow-methods header
413
+ <a id="methods-2a71b7"></a>&#x2022; [`allow_methods`](#methods-2a71b7) - Optional String<br>Specifies the content for the access-control-allow-methods header
414
414
 
415
- <a id="origin-c066d0"></a>&#x2022; [`allow_origin`](#origin-c066d0) - Optional List<br>Allow Origin. Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
415
+ <a id="origin-c066d0"></a>&#x2022; [`allow_origin`](#origin-c066d0) - Optional List<br>Specifies the origins that will be allowed to do CORS requests. An origin is allowed if either allow_origin or allow_origin_regex match
416
416
 
417
- <a id="regex-8cd4d2"></a>&#x2022; [`allow_origin_regex`](#regex-8cd4d2) - Optional List<br>Allow Origin Regex. Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
417
+ <a id="regex-8cd4d2"></a>&#x2022; [`allow_origin_regex`](#regex-8cd4d2) - Optional List<br>Specifies regex patterns that match allowed origins. An origin is allowed if either allow_origin or allow_origin_regex match
418
418
 
419
- <a id="disabled-373d60"></a>&#x2022; [`disabled`](#disabled-373d60) - Optional Bool<br>Disabled. Disable the CorsPolicy for a particular route. This is useful when virtual-host has CorsPolicy, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
419
+ <a id="disabled-373d60"></a>&#x2022; [`disabled`](#disabled-373d60) - Optional Bool<br>Disable the CorsPolicy for a particular route. This is useful when virtual-host has CorsPolicy, but we need to disable it on a specific route. The value of this field is ignored for virtual-host
420
420
 
421
- <a id="headers-ddfa2e"></a>&#x2022; [`expose_headers`](#headers-ddfa2e) - Optional String<br>Expose Headers. Specifies the content for the access-control-expose-headers header
421
+ <a id="headers-ddfa2e"></a>&#x2022; [`expose_headers`](#headers-ddfa2e) - Optional String<br>Specifies the content for the access-control-expose-headers header
422
422
 
423
- <a id="age-1581b8"></a>&#x2022; [`maximum_age`](#age-1581b8) - Optional Number<br>Maximum Age. Specifies the content for the access-control-max-age header in seconds. This indicates the maximum number of seconds the results can be cached A value of -1 will disable caching. Maximum permitted value is 86400 seconds (24 hours)
423
+ <a id="age-1581b8"></a>&#x2022; [`maximum_age`](#age-1581b8) - Optional Number<br>Specifies the content for the access-control-max-age header in seconds. This indicates the maximum number of seconds the results can be cached A value of -1 will disable caching. Maximum permitted value is 86400 seconds (24 hours)
424
424
 
425
425
  #### Routes Route Destination CSRF Policy
426
426
 
427
427
  A [`csrf_policy`](#routes-route-destination-csrf-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
428
428
 
429
- <a id="domains-a58e7f"></a>&#x2022; [`all_load_balancer_domains`](#domains-a58e7f) - Optional Block<br>Enable this option
429
+ <a id="domains-a58e7f"></a>&#x2022; [`all_load_balancer_domains`](#domains-a58e7f) - Optional Block<br>Can be used for messages where no values are needed
430
430
 
431
- <a id="list-904516"></a>&#x2022; [`custom_domain_list`](#list-904516) - Optional Block<br>Domain name list. List of domain names used for Host header matching<br>See [Custom Domain List](#list-904516) below.
431
+ <a id="list-904516"></a>&#x2022; [`custom_domain_list`](#list-904516) - Optional Block<br>List of domain names used for Host header matching<br>See [Custom Domain List](#list-904516) below.
432
432
 
433
- <a id="disabled-8b18cb"></a>&#x2022; [`disabled`](#disabled-8b18cb) - Optional Block<br>Enable this option
433
+ <a id="disabled-8b18cb"></a>&#x2022; [`disabled`](#disabled-8b18cb) - Optional Block<br>Can be used for messages where no values are needed
434
434
 
435
435
  #### Routes Route Destination CSRF Policy Custom Domain List
436
436
 
@@ -440,37 +440,37 @@ A [`csrf_policy`](#routes-route-destination-csrf-policy) block (within [`routes.
440
440
 
441
441
  A [`destinations`](#routes-route-destination-destinations) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
442
442
 
443
- <a id="cluster-d8ac1b"></a>&#x2022; [`cluster`](#cluster-d8ac1b) - Optional Block<br>Cluster. Indicates the upstream cluster to which the request should be sent. If the cluster does not exist ServiceUnavailable response will be sent<br>See [Cluster](#cluster-d8ac1b) below.
443
+ <a id="cluster-d8ac1b"></a>&#x2022; [`cluster`](#cluster-d8ac1b) - Optional Block<br>Indicates the upstream cluster to which the request should be sent. If the cluster does not exist ServiceUnavailable response will be sent<br>See [Cluster](#cluster-d8ac1b) below.
444
444
 
445
- <a id="subsets-23862f"></a>&#x2022; [`endpoint_subsets`](#subsets-23862f) - Optional Block<br>Endpoint Subsets. Upstream cluster may be configured to divide its endpoints into subsets based on metadata attached to the endpoints. Routes may then specify the metadata that a endpoint must match in order to be selected by the load balancer Labels field of endpoint object's metadata is used for subset matching. For endpoints which are discovered in K8S or Consul cluster, the label of the service is merged with endpoint's labels. In case of Consul, the label is derived from the 'Tag' field. For labels that are common between configured endpoint and discovered service, labels from discovered service takes precedence. List of key-value pairs that will be used as matching metadata. Only those endpoints of upstream cluster which match this metadata will be selected for load balancing
445
+ <a id="subsets-23862f"></a>&#x2022; [`endpoint_subsets`](#subsets-23862f) - Optional Block<br>Upstream cluster may be configured to divide its endpoints into subsets based on metadata attached to the endpoints. Routes may then specify the metadata that a endpoint must match in order to be selected by the load balancer Labels field of endpoint object's metadata is used for subset
446
446
 
447
- <a id="priority-830655"></a>&#x2022; [`priority`](#priority-830655) - Optional Number<br>Priority. Priority of this cluster, valid only with multiple destinations are configured. Value of 0 will make the cluster as lowest priority upstream cluster Priority of 1 means highest priority and is considered active. When active cluster is not available, lower priority clusters are made active as per the increasing priority
447
+ <a id="priority-830655"></a>&#x2022; [`priority`](#priority-830655) - Optional Number<br>Priority of this cluster, valid only with multiple destinations are configured. Value of 0 will make the cluster as lowest priority upstream cluster Priority of 1 means highest priority and is considered active. When active cluster is not available, lower priority clusters are made active as per
448
448
 
449
- <a id="weight-2acc2c"></a>&#x2022; [`weight`](#weight-2acc2c) - Optional Number<br>Weight. When requests have to distributed among multiple upstream clusters, multiple destinations are configured, each having its own cluster and weight. Traffic is distributed among clusters based on the weight configured. destinations: - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-1 weight: 20 - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-2 weight: 30 - cluster: - kind: F5 xc.vega.cfg.adc.cluster.object uid: cluster-3 weight: 10 This indicates that out of every 60 requests, 10 goes to cluster-3, 30 to cluster-2 and 20 to cluster-1 When single destination is configured, weight is ignored. All the requests are sent to the cluster specified in the destination
449
+ <a id="weight-2acc2c"></a>&#x2022; [`weight`](#weight-2acc2c) - Optional Number<br>When requests have to distributed among multiple upstream clusters, multiple destinations are configured, each having its own cluster and weight. Traffic is distributed among clusters based on the weight configured
450
450
 
451
451
  #### Routes Route Destination Destinations Cluster
452
452
 
453
453
  A [`cluster`](#cluster-d8ac1b) block (within [`routes.route_destination.destinations`](#routes-route-destination-destinations)) supports the following:
454
454
 
455
- <a id="kind-24578a"></a>&#x2022; [`kind`](#kind-24578a) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
455
+ <a id="kind-24578a"></a>&#x2022; [`kind`](#kind-24578a) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
456
456
 
457
- <a id="name-638083"></a>&#x2022; [`name`](#name-638083) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
457
+ <a id="name-638083"></a>&#x2022; [`name`](#name-638083) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
458
458
 
459
- <a id="namespace-effaa4"></a>&#x2022; [`namespace`](#namespace-effaa4) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
459
+ <a id="namespace-effaa4"></a>&#x2022; [`namespace`](#namespace-effaa4) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
460
460
 
461
- <a id="tenant-4f2bb0"></a>&#x2022; [`tenant`](#tenant-4f2bb0) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
461
+ <a id="tenant-4f2bb0"></a>&#x2022; [`tenant`](#tenant-4f2bb0) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
462
462
 
463
- <a id="uid-a2437e"></a>&#x2022; [`uid`](#uid-a2437e) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
463
+ <a id="uid-a2437e"></a>&#x2022; [`uid`](#uid-a2437e) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
464
464
 
465
465
  #### Routes Route Destination Hash Policy
466
466
 
467
467
  A [`hash_policy`](#routes-route-destination-hash-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
468
468
 
469
- <a id="cookie-fa8e38"></a>&#x2022; [`cookie`](#cookie-fa8e38) - Optional Block<br>Hashing using Cookie. Two types of cookie affinity: 1. Passive. Takes a cookie that's present in the cookies header and hashes on its value. 2. Generated. Generates and sets a cookie with an expiration (TTL) on the first request from the client in its response to the client, based on the endpoint the request gets sent to. The client then presents this on the next and all subsequent requests. The hash of this is sufficient to ensure these requests GET sent to the same endpoint. The cookie is generated by hashing the source and destination ports and addresses so that multiple independent HTTP2 streams on the same connection will independently receive the same cookie, even if they arrive simultaneously<br>See [Cookie](#cookie-fa8e38) below.
469
+ <a id="cookie-fa8e38"></a>&#x2022; [`cookie`](#cookie-fa8e38) - Optional Block<br>Two types of cookie affinity: 1. Passive. Takes a cookie that's present in the cookies header and hashes on its value. 2. Generated. Generates and sets a cookie with an expiration (TTL) on the first request from the client in its response to the client, based on the endpoint the request gets<br>See [Cookie](#cookie-fa8e38) below.
470
470
 
471
- <a id="name-5f3d35"></a>&#x2022; [`header_name`](#name-5f3d35) - Optional String<br>Header Name. The name or key of the request header that will be used to obtain the hash key
471
+ <a id="name-5f3d35"></a>&#x2022; [`header_name`](#name-5f3d35) - Optional String<br>The name or key of the request header that will be used to obtain the hash key
472
472
 
473
- <a id="source-ip-279e98"></a>&#x2022; [`source_ip`](#source-ip-279e98) - Optional Bool<br>Source IP. Hash based on source IP address
473
+ <a id="source-ip-279e98"></a>&#x2022; [`source_ip`](#source-ip-279e98) - Optional Bool<br>Hash based on source IP address
474
474
 
475
475
  <a id="terminal-2ae5fd"></a>&#x2022; [`terminal`](#terminal-2ae5fd) - Optional Bool<br>Terminal. Specify if its a terminal policy
476
476
 
@@ -478,115 +478,115 @@ A [`hash_policy`](#routes-route-destination-hash-policy) block (within [`routes.
478
478
 
479
479
  A [`cookie`](#cookie-fa8e38) block (within [`routes.route_destination.hash_policy`](#routes-route-destination-hash-policy)) supports the following:
480
480
 
481
- <a id="httponly-c187b0"></a>&#x2022; [`add_httponly`](#httponly-c187b0) - Optional Block<br>Enable this option
481
+ <a id="httponly-c187b0"></a>&#x2022; [`add_httponly`](#httponly-c187b0) - Optional Block<br>Can be used for messages where no values are needed
482
482
 
483
- <a id="secure-141faf"></a>&#x2022; [`add_secure`](#secure-141faf) - Optional Block<br>Enable this option
483
+ <a id="secure-141faf"></a>&#x2022; [`add_secure`](#secure-141faf) - Optional Block<br>Can be used for messages where no values are needed
484
484
 
485
- <a id="httponly-d1eb99"></a>&#x2022; [`ignore_httponly`](#httponly-d1eb99) - Optional Block<br>Enable this option
485
+ <a id="httponly-d1eb99"></a>&#x2022; [`ignore_httponly`](#httponly-d1eb99) - Optional Block<br>Can be used for messages where no values are needed
486
486
 
487
- <a id="samesite-dc4309"></a>&#x2022; [`ignore_samesite`](#samesite-dc4309) - Optional Block<br>Enable this option
487
+ <a id="samesite-dc4309"></a>&#x2022; [`ignore_samesite`](#samesite-dc4309) - Optional Block<br>Can be used for messages where no values are needed
488
488
 
489
- <a id="secure-9eb9ca"></a>&#x2022; [`ignore_secure`](#secure-9eb9ca) - Optional Block<br>Enable this option
489
+ <a id="secure-9eb9ca"></a>&#x2022; [`ignore_secure`](#secure-9eb9ca) - Optional Block<br>Can be used for messages where no values are needed
490
490
 
491
- <a id="name-a648a7"></a>&#x2022; [`name`](#name-a648a7) - Optional String<br>Name. The name of the cookie that will be used to obtain the hash key. If the cookie is not present and TTL below is not set, no hash will be produced
491
+ <a id="name-a648a7"></a>&#x2022; [`name`](#name-a648a7) - Optional String<br>The name of the cookie that will be used to obtain the hash key. If the cookie is not present and TTL below is not set, no hash will be produced
492
492
 
493
- <a id="path-b96c24"></a>&#x2022; [`path`](#path-b96c24) - Optional String<br>Path. The name of the path for the cookie. If no path is specified here, no path will be set for the cookie
493
+ <a id="path-b96c24"></a>&#x2022; [`path`](#path-b96c24) - Optional String<br>The name of the path for the cookie. If no path is specified here, no path will be set for the cookie
494
494
 
495
- <a id="lax-fbe3d9"></a>&#x2022; [`samesite_lax`](#lax-fbe3d9) - Optional Block<br>Enable this option
495
+ <a id="lax-fbe3d9"></a>&#x2022; [`samesite_lax`](#lax-fbe3d9) - Optional Block<br>Can be used for messages where no values are needed
496
496
 
497
- <a id="none-087d30"></a>&#x2022; [`samesite_none`](#none-087d30) - Optional Block<br>Enable this option
497
+ <a id="none-087d30"></a>&#x2022; [`samesite_none`](#none-087d30) - Optional Block<br>Can be used for messages where no values are needed
498
498
 
499
- <a id="strict-3e3555"></a>&#x2022; [`samesite_strict`](#strict-3e3555) - Optional Block<br>Enable this option
499
+ <a id="strict-3e3555"></a>&#x2022; [`samesite_strict`](#strict-3e3555) - Optional Block<br>Can be used for messages where no values are needed
500
500
 
501
- <a id="ttl-e740ae"></a>&#x2022; [`ttl`](#ttl-e740ae) - Optional Number<br>TTL. If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie. TTL value is in milliseconds
501
+ <a id="ttl-e740ae"></a>&#x2022; [`ttl`](#ttl-e740ae) - Optional Number<br>If specified, a cookie with the TTL will be generated if the cookie is not present. If the TTL is present and zero, the generated cookie will be a session cookie. TTL value is in milliseconds
502
502
 
503
503
  #### Routes Route Destination Mirror Policy
504
504
 
505
505
  A [`mirror_policy`](#routes-route-destination-mirror-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
506
506
 
507
- <a id="cluster-1c80ee"></a>&#x2022; [`cluster`](#cluster-1c80ee) - Optional Block<br>Mirror Destination Cluster. Specifies the cluster to which the requests will be mirrored. The cluster object referred here must be present<br>See [Cluster](#cluster-1c80ee) below.
507
+ <a id="cluster-1c80ee"></a>&#x2022; [`cluster`](#cluster-1c80ee) - Optional Block<br>Specifies the cluster to which the requests will be mirrored. The cluster object referred here must be present<br>See [Cluster](#cluster-1c80ee) below.
508
508
 
509
- <a id="percent-e76235"></a>&#x2022; [`percent`](#percent-e76235) - Optional Block<br>Fractional Percent. Fraction used where sampling percentages are needed. Example sampled requests<br>See [Percent](#percent-e76235) below.
509
+ <a id="percent-e76235"></a>&#x2022; [`percent`](#percent-e76235) - Optional Block<br>Fraction used where sampling percentages are needed. Example sampled requests<br>See [Percent](#percent-e76235) below.
510
510
 
511
511
  #### Routes Route Destination Mirror Policy Cluster
512
512
 
513
513
  A [`cluster`](#cluster-1c80ee) block (within [`routes.route_destination.mirror_policy`](#routes-route-destination-mirror-policy)) supports the following:
514
514
 
515
- <a id="kind-5f5f46"></a>&#x2022; [`kind`](#kind-5f5f46) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
515
+ <a id="kind-5f5f46"></a>&#x2022; [`kind`](#kind-5f5f46) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
516
516
 
517
- <a id="name-99bc18"></a>&#x2022; [`name`](#name-99bc18) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
517
+ <a id="name-99bc18"></a>&#x2022; [`name`](#name-99bc18) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
518
518
 
519
- <a id="namespace-d5b69a"></a>&#x2022; [`namespace`](#namespace-d5b69a) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
519
+ <a id="namespace-d5b69a"></a>&#x2022; [`namespace`](#namespace-d5b69a) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
520
520
 
521
- <a id="tenant-5fcce8"></a>&#x2022; [`tenant`](#tenant-5fcce8) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
521
+ <a id="tenant-5fcce8"></a>&#x2022; [`tenant`](#tenant-5fcce8) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
522
522
 
523
- <a id="uid-417dc0"></a>&#x2022; [`uid`](#uid-417dc0) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
523
+ <a id="uid-417dc0"></a>&#x2022; [`uid`](#uid-417dc0) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
524
524
 
525
525
  #### Routes Route Destination Mirror Policy Percent
526
526
 
527
527
  A [`percent`](#percent-e76235) block (within [`routes.route_destination.mirror_policy`](#routes-route-destination-mirror-policy)) supports the following:
528
528
 
529
- <a id="denominator-94e819"></a>&#x2022; [`denominator`](#denominator-94e819) - Optional String Defaults to `HUNDRED`<br>Possible values are `HUNDRED`, `TEN_THOUSAND`, `MILLION`<br>[Enum: HUNDRED|TEN_THOUSAND|MILLION] Denominator. Denominator used in fraction where sampling percentages are needed. Example sampled requests Use hundred as denominator Use ten thousand as denominator Use million as denominator
529
+ <a id="denominator-94e819"></a>&#x2022; [`denominator`](#denominator-94e819) - Optional String Defaults to `HUNDRED`<br>Possible values are `HUNDRED`, `TEN_THOUSAND`, `MILLION`<br>[Enum: HUNDRED|TEN_THOUSAND|MILLION] Denominator used in fraction where sampling percentages are needed. Example sampled requests Use hundred as denominator Use ten thousand as denominator Use million as denominator
530
530
 
531
- <a id="numerator-9f6259"></a>&#x2022; [`numerator`](#numerator-9f6259) - Optional Number<br>Numerator. Sampled parts per denominator. If denominator was 10000, then value of 5 will be 5 in 10000
531
+ <a id="numerator-9f6259"></a>&#x2022; [`numerator`](#numerator-9f6259) - Optional Number<br>Sampled parts per denominator. If denominator was 10000, then value of 5 will be 5 in 10000
532
532
 
533
533
  #### Routes Route Destination Query Params
534
534
 
535
535
  A [`query_params`](#routes-route-destination-query-params) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
536
536
 
537
- <a id="params-29da85"></a>&#x2022; [`remove_all_params`](#params-29da85) - Optional Block<br>Enable this option
537
+ <a id="params-29da85"></a>&#x2022; [`remove_all_params`](#params-29da85) - Optional Block<br>Can be used for messages where no values are needed
538
538
 
539
- <a id="params-cfccb5"></a>&#x2022; [`replace_params`](#params-cfccb5) - Optional String<br>Replace All Parameters
539
+ <a id="params-cfccb5"></a>&#x2022; [`replace_params`](#params-cfccb5) - Optional String
540
540
 
541
- <a id="params-7e3845"></a>&#x2022; [`retain_all_params`](#params-7e3845) - Optional Block<br>Enable this option
541
+ <a id="params-7e3845"></a>&#x2022; [`retain_all_params`](#params-7e3845) - Optional Block<br>Can be used for messages where no values are needed
542
542
 
543
543
  #### Routes Route Destination Regex Rewrite
544
544
 
545
545
  A [`regex_rewrite`](#routes-route-destination-regex-rewrite) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
546
546
 
547
- <a id="pattern-a0e73b"></a>&#x2022; [`pattern`](#pattern-a0e73b) - Optional String<br>Pattern. The regular expression used to find portions of a string that should be replaced
547
+ <a id="pattern-a0e73b"></a>&#x2022; [`pattern`](#pattern-a0e73b) - Optional String<br>The regular expression used to find portions of a string that should be replaced
548
548
 
549
- <a id="substitution-90a61f"></a>&#x2022; [`substitution`](#substitution-90a61f) - Optional String<br>Substitution. The string that should be substituted into matching portions of the subject string during a substitution operation to produce a new string
549
+ <a id="substitution-90a61f"></a>&#x2022; [`substitution`](#substitution-90a61f) - Optional String<br>The string that should be substituted into matching portions of the subject string during a substitution operation to produce a new string
550
550
 
551
551
  #### Routes Route Destination Retry Policy
552
552
 
553
553
  A [`retry_policy`](#routes-route-destination-retry-policy) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
554
554
 
555
- <a id="off-5007a2"></a>&#x2022; [`back_off`](#off-5007a2) - Optional Block<br>Retry BackOff Interval. Specifies parameters that control retry back off<br>See [Back Off](#off-5007a2) below.
555
+ <a id="off-5007a2"></a>&#x2022; [`back_off`](#off-5007a2) - Optional Block<br>Specifies parameters that control retry back off<br>See [Back Off](#off-5007a2) below.
556
556
 
557
- <a id="retries-cc8e48"></a>&#x2022; [`num_retries`](#retries-cc8e48) - Optional Number Defaults to `1`<br>Number of Retries. Specifies the allowed number of retries. Retries can be done any number of times. An exponential back-off algorithm is used between each retry
557
+ <a id="retries-cc8e48"></a>&#x2022; [`num_retries`](#retries-cc8e48) - Optional Number Defaults to `1`<br>Specifies the allowed number of retries. Retries can be done any number of times. An exponential back-off algorithm is used between each retry
558
558
 
559
- <a id="timeout-16fe27"></a>&#x2022; [`per_try_timeout`](#timeout-16fe27) - Optional Number<br>Per Try Timeout. Specifies a non-zero timeout per retry attempt. In milliseconds
559
+ <a id="timeout-16fe27"></a>&#x2022; [`per_try_timeout`](#timeout-16fe27) - Optional Number<br>Specifies a non-zero timeout per retry attempt. In milliseconds
560
560
 
561
- <a id="codes-b9b5e6"></a>&#x2022; [`retriable_status_codes`](#codes-b9b5e6) - Optional List<br>Status Code to Retry. HTTP status codes that should trigger a retry in addition to those specified by retry_on
561
+ <a id="codes-b9b5e6"></a>&#x2022; [`retriable_status_codes`](#codes-b9b5e6) - Optional List<br>HTTP status codes that should trigger a retry in addition to those specified by retry_on
562
562
 
563
- <a id="condition-4593ce"></a>&#x2022; [`retry_condition`](#condition-4593ce) - Optional List<br>Retry Condition. Specifies the conditions under which retry takes place. Retries can be on different types of condition depending on application requirements. For example, network failure, all 5xx response codes, idempotent 4xx response codes, etc The possible values are '5xx' : Retry will be done if the upstream server responds with any 5xx response code, or does not respond at all (disconnect/reset/read timeout). 'gateway-error' : Retry will be done only if the upstream server responds with 502, 503 or 504 responses (Included in 5xx) 'connect-failure' : Retry will be done if the request fails because of a connection failure to the upstream server (connect timeout, etc.). (Included in 5xx) 'refused-stream' : Retry is done if the upstream server resets the stream with a REFUSED_STREAM error code (Included in 5xx) 'retriable-4xx' : Retry is done if the upstream server responds with a retriable 4xx response code. The only response code in this category is HTTP CONFLICT (409) 'retriable-status-codes' : Retry is done if the upstream server responds with any response code matching one defined in retriable_status_codes field 'reset' : Retry is done if the upstream server does not respond at all (disconnect/reset/read timeout.)
563
+ <a id="condition-4593ce"></a>&#x2022; [`retry_condition`](#condition-4593ce) - Optional List<br>Specifies the conditions under which retry takes place. Retries can be on different types of condition depending on application requirements. For example, network failure, all 5xx response codes, idempotent 4xx response codes, etc The possible values are '5xx' : Retry will be done if the
564
564
 
565
565
  #### Routes Route Destination Retry Policy Back Off
566
566
 
567
567
  A [`back_off`](#off-5007a2) block (within [`routes.route_destination.retry_policy`](#routes-route-destination-retry-policy)) supports the following:
568
568
 
569
- <a id="interval-8d7a2c"></a>&#x2022; [`base_interval`](#interval-8d7a2c) - Optional Number<br>Base Retry Interval. Specifies the base interval between retries in milliseconds
569
+ <a id="interval-8d7a2c"></a>&#x2022; [`base_interval`](#interval-8d7a2c) - Optional Number<br>Specifies the base interval between retries in milliseconds
570
570
 
571
- <a id="interval-311cb7"></a>&#x2022; [`max_interval`](#interval-311cb7) - Optional Number Defaults to `10`<br>Maximum Retry Interval. Specifies the maximum interval between retries in milliseconds. This parameter is optional, but must be greater than or equal to the base_interval if set. The times the base_interval
571
+ <a id="interval-311cb7"></a>&#x2022; [`max_interval`](#interval-311cb7) - Optional Number Defaults to `10`<br>Specifies the maximum interval between retries in milliseconds. This parameter is optional, but must be greater than or equal to the base_interval if set. The times the base_interval
572
572
 
573
573
  #### Routes Route Destination Spdy Config
574
574
 
575
575
  A [`spdy_config`](#routes-route-destination-spdy-config) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
576
576
 
577
- <a id="spdy-22a727"></a>&#x2022; [`use_spdy`](#spdy-22a727) - Optional Bool<br>Use SPDY. Specifies that the HTTP client connection to this route is allowed to upgrade to a SPDY connection
577
+ <a id="spdy-22a727"></a>&#x2022; [`use_spdy`](#spdy-22a727) - Optional Bool<br>Specifies that the HTTP client connection to this route is allowed to upgrade to a SPDY connection
578
578
 
579
579
  #### Routes Route Destination Web Socket Config
580
580
 
581
581
  A [`web_socket_config`](#config-449c3d) block (within [`routes.route_destination`](#routes-route-destination)) supports the following:
582
582
 
583
- <a id="websocket-dbbf3e"></a>&#x2022; [`use_websocket`](#websocket-dbbf3e) - Optional Bool<br>Use WebSocket. Specifies that the HTTP client connection to this route is allowed to upgrade to a WebSocket connection
583
+ <a id="websocket-dbbf3e"></a>&#x2022; [`use_websocket`](#websocket-dbbf3e) - Optional Bool<br>Specifies that the HTTP client connection to this route is allowed to upgrade to a WebSocket connection
584
584
 
585
585
  #### Routes Route Direct Response
586
586
 
587
587
  A [`route_direct_response`](#routes-route-direct-response) block (within [`routes`](#routes)) supports the following:
588
588
 
589
- <a id="encoded-023a3e"></a>&#x2022; [`response_body_encoded`](#encoded-023a3e) - Optional String<br>Response Body. Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format. The message can be either plain text or HTML. E.g. '`<p>` Access Denied `</p>`'. Base64 encoded string URL for this is string:///PHA+IEFjY2VzcyBEZW5pZWQgPC9wPg==
589
+ <a id="encoded-023a3e"></a>&#x2022; [`response_body_encoded`](#encoded-023a3e) - Optional String<br>Response body to send. Currently supported URL schemes is string:/// for which message should be encoded in Base64 format. The message can be either plain text or HTML
590
590
 
591
591
  <a id="code-e27cc8"></a>&#x2022; [`response_code`](#code-e27cc8) - Optional Number<br>Response Code. Response code to send
592
592
 
@@ -594,67 +594,67 @@ A [`route_direct_response`](#routes-route-direct-response) block (within [`route
594
594
 
595
595
  A [`route_redirect`](#routes-route-redirect) block (within [`routes`](#routes)) supports the following:
596
596
 
597
- <a id="routes-route-redirect-host-redirect"></a>&#x2022; [`host_redirect`](#routes-route-redirect-host-redirect) - Optional String<br>Host. Swap host part of incoming URL in redirect URL
597
+ <a id="routes-route-redirect-host-redirect"></a>&#x2022; [`host_redirect`](#routes-route-redirect-host-redirect) - Optional String<br>Swap host part of incoming URL in redirect URL
598
598
 
599
- <a id="routes-route-redirect-path-redirect"></a>&#x2022; [`path_redirect`](#routes-route-redirect-path-redirect) - Optional String<br>Path. swap path part of incoming URL in redirect URL
599
+ <a id="routes-route-redirect-path-redirect"></a>&#x2022; [`path_redirect`](#routes-route-redirect-path-redirect) - Optional String<br>swap path part of incoming URL in redirect URL
600
600
 
601
- <a id="routes-route-redirect-prefix-rewrite"></a>&#x2022; [`prefix_rewrite`](#routes-route-redirect-prefix-rewrite) - Optional String<br>Prefix Rewrite. In Redirect response, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request
601
+ <a id="routes-route-redirect-prefix-rewrite"></a>&#x2022; [`prefix_rewrite`](#routes-route-redirect-prefix-rewrite) - Optional String<br>In Redirect response, the matched prefix (or path) should be swapped with this value. This option allows redirect URLs be dynamically created based on the request
602
602
 
603
- <a id="routes-route-redirect-proto-redirect"></a>&#x2022; [`proto_redirect`](#routes-route-redirect-proto-redirect) - Optional String<br>Protocol. Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified, swapping of protocol is not done
603
+ <a id="routes-route-redirect-proto-redirect"></a>&#x2022; [`proto_redirect`](#routes-route-redirect-proto-redirect) - Optional String<br>Swap protocol part of incoming URL in redirect URL The protocol can be swapped with either HTTP or HTTPS When incoming-proto option is specified, swapping of protocol is not done
604
604
 
605
- <a id="routes-route-redirect-remove-all-params"></a>&#x2022; [`remove_all_params`](#routes-route-redirect-remove-all-params) - Optional Block<br>Enable this option
605
+ <a id="routes-route-redirect-remove-all-params"></a>&#x2022; [`remove_all_params`](#routes-route-redirect-remove-all-params) - Optional Block<br>Can be used for messages where no values are needed
606
606
 
607
- <a id="routes-route-redirect-replace-params"></a>&#x2022; [`replace_params`](#routes-route-redirect-replace-params) - Optional String<br>Replace All Parameters
607
+ <a id="routes-route-redirect-replace-params"></a>&#x2022; [`replace_params`](#routes-route-redirect-replace-params) - Optional String
608
608
 
609
- <a id="routes-route-redirect-response-code"></a>&#x2022; [`response_code`](#routes-route-redirect-response-code) - Optional Number<br>Response Code. The HTTP status code to use in the redirect response
609
+ <a id="routes-route-redirect-response-code"></a>&#x2022; [`response_code`](#routes-route-redirect-response-code) - Optional Number<br>The HTTP status code to use in the redirect response
610
610
 
611
- <a id="routes-route-redirect-retain-all-params"></a>&#x2022; [`retain_all_params`](#routes-route-redirect-retain-all-params) - Optional Block<br>Enable this option
611
+ <a id="routes-route-redirect-retain-all-params"></a>&#x2022; [`retain_all_params`](#routes-route-redirect-retain-all-params) - Optional Block<br>Can be used for messages where no values are needed
612
612
 
613
613
  #### Routes Service Policy
614
614
 
615
615
  A [`service_policy`](#routes-service-policy) block (within [`routes`](#routes)) supports the following:
616
616
 
617
- <a id="routes-service-policy-disable"></a>&#x2022; [`disable`](#routes-service-policy-disable) - Optional Bool<br>Disable. disable service policy at route level, if it is configured at virtual-host level
617
+ <a id="routes-service-policy-disable"></a>&#x2022; [`disable`](#routes-service-policy-disable) - Optional Bool<br>disable service policy at route level, if it is configured at virtual-host level
618
618
 
619
619
  #### Routes WAF Exclusion Policy
620
620
 
621
621
  A [`waf_exclusion_policy`](#routes-waf-exclusion-policy) block (within [`routes`](#routes)) supports the following:
622
622
 
623
- <a id="routes-waf-exclusion-policy-name"></a>&#x2022; [`name`](#routes-waf-exclusion-policy-name) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
623
+ <a id="routes-waf-exclusion-policy-name"></a>&#x2022; [`name`](#routes-waf-exclusion-policy-name) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
624
624
 
625
- <a id="routes-waf-exclusion-policy-namespace"></a>&#x2022; [`namespace`](#routes-waf-exclusion-policy-namespace) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
625
+ <a id="routes-waf-exclusion-policy-namespace"></a>&#x2022; [`namespace`](#routes-waf-exclusion-policy-namespace) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
626
626
 
627
- <a id="routes-waf-exclusion-policy-tenant"></a>&#x2022; [`tenant`](#routes-waf-exclusion-policy-tenant) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
627
+ <a id="routes-waf-exclusion-policy-tenant"></a>&#x2022; [`tenant`](#routes-waf-exclusion-policy-tenant) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
628
628
 
629
629
  #### Routes WAF Type
630
630
 
631
631
  A [`waf_type`](#routes-waf-type) block (within [`routes`](#routes)) supports the following:
632
632
 
633
- <a id="routes-waf-type-app-firewall"></a>&#x2022; [`app_firewall`](#routes-waf-type-app-firewall) - Optional Block<br>App Firewall Reference. A list of references to the app_firewall configuration objects<br>See [App Firewall](#routes-waf-type-app-firewall) below.
633
+ <a id="routes-waf-type-app-firewall"></a>&#x2022; [`app_firewall`](#routes-waf-type-app-firewall) - Optional Block<br>List of references to the app_firewall configuration objects<br>See [App Firewall](#routes-waf-type-app-firewall) below.
634
634
 
635
- <a id="routes-waf-type-disable-waf"></a>&#x2022; [`disable_waf`](#routes-waf-type-disable-waf) - Optional Block<br>Enable this option
635
+ <a id="routes-waf-type-disable-waf"></a>&#x2022; [`disable_waf`](#routes-waf-type-disable-waf) - Optional Block<br>Can be used for messages where no values are needed
636
636
 
637
- <a id="routes-waf-type-inherit-waf"></a>&#x2022; [`inherit_waf`](#routes-waf-type-inherit-waf) - Optional Block<br>Enable this option
637
+ <a id="routes-waf-type-inherit-waf"></a>&#x2022; [`inherit_waf`](#routes-waf-type-inherit-waf) - Optional Block<br>Can be used for messages where no values are needed
638
638
 
639
639
  #### Routes WAF Type App Firewall
640
640
 
641
641
  An [`app_firewall`](#routes-waf-type-app-firewall) block (within [`routes.waf_type`](#routes-waf-type)) supports the following:
642
642
 
643
- <a id="firewall-9775b3"></a>&#x2022; [`app_firewall`](#firewall-9775b3) - Optional Block<br>Application Firewall. References to an Application Firewall configuration object<br>See [App Firewall](#firewall-9775b3) below.
643
+ <a id="firewall-9775b3"></a>&#x2022; [`app_firewall`](#firewall-9775b3) - Optional Block<br>References to an Application Firewall configuration object<br>See [App Firewall](#firewall-9775b3) below.
644
644
 
645
645
  #### Routes WAF Type App Firewall App Firewall
646
646
 
647
647
  An [`app_firewall`](#firewall-9775b3) block (within [`routes.waf_type.app_firewall`](#routes-waf-type-app-firewall)) supports the following:
648
648
 
649
- <a id="kind-13aebd"></a>&#x2022; [`kind`](#kind-13aebd) - Optional String<br>Kind. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
649
+ <a id="kind-13aebd"></a>&#x2022; [`kind`](#kind-13aebd) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. 'route')
650
650
 
651
- <a id="name-028577"></a>&#x2022; [`name`](#name-028577) - Optional String<br>Name. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
651
+ <a id="name-028577"></a>&#x2022; [`name`](#name-028577) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name
652
652
 
653
- <a id="namespace-38fd49"></a>&#x2022; [`namespace`](#namespace-38fd49) - Optional String<br>Namespace. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
653
+ <a id="namespace-38fd49"></a>&#x2022; [`namespace`](#namespace-38fd49) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace
654
654
 
655
- <a id="tenant-853650"></a>&#x2022; [`tenant`](#tenant-853650) - Optional String<br>Tenant. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
655
+ <a id="tenant-853650"></a>&#x2022; [`tenant`](#tenant-853650) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant
656
656
 
657
- <a id="uid-f378e6"></a>&#x2022; [`uid`](#uid-f378e6) - Optional String<br>UID. When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
657
+ <a id="uid-f378e6"></a>&#x2022; [`uid`](#uid-f378e6) - Optional String<br>When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid
658
658
 
659
659
  #### Timeouts
660
660