@robinmordasiewicz/f5xc-terraform-mcp 3.5.0 → 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.
- package/README.md +283 -104
- package/dist/docs/data-sources/bgp.md +2 -2
- package/dist/docs/data-sources/discovery.md +2 -2
- package/dist/docs/data-sources/fast_acl.md +2 -2
- package/dist/docs/data-sources/fast_acl_rule.md +2 -2
- package/dist/docs/data-sources/irule.md +2 -2
- package/dist/docs/data-sources/log_receiver.md +2 -2
- package/dist/docs/data-sources/network_policy.md +2 -2
- package/dist/docs/data-sources/route.md +2 -2
- package/dist/docs/data-sources/site.md +2 -2
- package/dist/docs/resources/address_allocator.md +7 -7
- package/dist/docs/resources/advertise_policy.md +57 -57
- package/dist/docs/resources/alert_policy.md +40 -40
- package/dist/docs/resources/alert_receiver.md +57 -57
- package/dist/docs/resources/api_crawler.md +13 -13
- package/dist/docs/resources/api_definition.md +11 -11
- package/dist/docs/resources/api_discovery.md +4 -4
- package/dist/docs/resources/api_testing.md +27 -27
- package/dist/docs/resources/apm.md +40 -40
- package/dist/docs/resources/app_api_group.md +20 -20
- package/dist/docs/resources/app_firewall.md +50 -50
- package/dist/docs/resources/app_setting.md +19 -19
- package/dist/docs/resources/app_type.md +7 -7
- package/dist/docs/resources/authentication.md +29 -29
- package/dist/docs/resources/aws_tgw_site.md +140 -140
- package/dist/docs/resources/aws_vpc_site.md +174 -174
- package/dist/docs/resources/azure_vnet_site.md +245 -245
- package/dist/docs/resources/bgp.md +37 -205
- package/dist/docs/resources/bgp_asn_set.md +1 -1
- package/dist/docs/resources/bgp_routing_policy.md +19 -19
- package/dist/docs/resources/bot_defense_app_infrastructure.md +12 -12
- package/dist/docs/resources/cdn_cache_rule.md +5 -5
- package/dist/docs/resources/cdn_loadbalancer.md +418 -418
- package/dist/docs/resources/certificate.md +1 -1
- package/dist/docs/resources/certificate_chain.md +1 -1
- package/dist/docs/resources/cloud_connect.md +28 -28
- package/dist/docs/resources/cloud_credentials.md +35 -35
- package/dist/docs/resources/cloud_elastic_ip.md +8 -8
- package/dist/docs/resources/cloud_link.md +36 -36
- package/dist/docs/resources/cluster.md +86 -86
- package/dist/docs/resources/cminstance.md +22 -22
- package/dist/docs/resources/code_base_integration.md +24 -24
- package/dist/docs/resources/container_registry.md +13 -13
- package/dist/docs/resources/crl.md +1 -1
- package/dist/docs/resources/data_type.md +16 -16
- package/dist/docs/resources/dc_cluster_group.md +4 -4
- package/dist/docs/resources/discovery.md +8 -259
- package/dist/docs/resources/dns_compliance_checks.md +1 -1
- package/dist/docs/resources/dns_domain.md +3 -3
- package/dist/docs/resources/endpoint.md +44 -44
- package/dist/docs/resources/enhanced_firewall_policy.md +51 -51
- package/dist/docs/resources/external_connector.md +42 -42
- package/dist/docs/resources/fast_acl.md +60 -166
- package/dist/docs/resources/fast_acl_rule.md +28 -28
- package/dist/docs/resources/filter_set.md +10 -10
- package/dist/docs/resources/fleet.md +160 -160
- package/dist/docs/resources/forward_proxy_policy.md +82 -82
- package/dist/docs/resources/forwarding_class.md +14 -14
- package/dist/docs/resources/gcp_vpc_site.md +152 -152
- package/dist/docs/resources/global_log_receiver.md +238 -238
- package/dist/docs/resources/healthcheck.md +17 -17
- package/dist/docs/resources/http_loadbalancer.md +1003 -1003
- package/dist/docs/resources/irule.md +5 -7
- package/dist/docs/resources/log_receiver.md +825 -44
- package/dist/docs/resources/malicious_user_mitigation.md +10 -10
- package/dist/docs/resources/nat_policy.md +86 -86
- package/dist/docs/resources/network_connector.md +31 -31
- package/dist/docs/resources/network_firewall.md +22 -22
- package/dist/docs/resources/network_interface.md +77 -77
- package/dist/docs/resources/network_policy.md +38 -217
- package/dist/docs/resources/network_policy_rule.md +21 -21
- package/dist/docs/resources/network_policy_view.md +65 -65
- package/dist/docs/resources/nfv_service.md +76 -76
- package/dist/docs/resources/nginx_service_discovery.md +10 -10
- package/dist/docs/resources/origin_pool.md +166 -166
- package/dist/docs/resources/policer.md +4 -4
- package/dist/docs/resources/policy_based_routing.md +28 -28
- package/dist/docs/resources/protocol_inspection.md +12 -12
- package/dist/docs/resources/protocol_policer.md +14 -14
- package/dist/docs/resources/proxy.md +111 -111
- package/dist/docs/resources/rate_limiter.md +15 -15
- package/dist/docs/resources/rate_limiter_policy.md +56 -56
- package/dist/docs/resources/route.md +183 -183
- package/dist/docs/resources/secret_management_access.md +68 -68
- package/dist/docs/resources/securemesh_site.md +1619 -258
- package/dist/docs/resources/segment.md +4 -4
- package/dist/docs/resources/sensitive_data_policy.md +9 -9
- package/dist/docs/resources/service_policy.md +175 -175
- package/dist/docs/resources/service_policy_rule.md +142 -142
- package/dist/docs/resources/site.md +381 -303
- package/dist/docs/resources/site_mesh_group.md +18 -18
- package/dist/docs/resources/subnet.md +17 -17
- package/dist/docs/resources/tcp_loadbalancer.md +130 -130
- package/dist/docs/resources/tenant_configuration.md +10 -10
- package/dist/docs/resources/trusted_ca_list.md +1 -1
- package/dist/docs/resources/tunnel.md +36 -36
- package/dist/docs/resources/udp_loadbalancer.md +59 -59
- package/dist/docs/resources/usb_policy.md +6 -6
- package/dist/docs/resources/user_identification.md +16 -16
- package/dist/docs/resources/virtual_host.md +225 -225
- package/dist/docs/resources/virtual_network.md +14 -14
- package/dist/docs/resources/virtual_site.md +3 -3
- package/dist/docs/resources/voltstack_site.md +141 -141
- package/dist/docs/resources/waf_exclusion_policy.md +17 -17
- package/dist/docs/resources/workload.md +327 -327
- package/dist/docs/resources/workload_flavor.md +3 -3
- package/dist/metadata/resource-metadata.json +1484 -942
- package/dist/types.d.ts +11 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +1 -1
|
@@ -60,11 +60,11 @@ resource "f5xc_alert_receiver" "example" {
|
|
|
60
60
|
|
|
61
61
|
-> **One of the following:**
|
|
62
62
|
• <a id="email"></a>[`email`](#email) - Optional Block<br>Email Configuration<br>See [Email](#email) below for details.
|
|
63
|
-
<br><br>• <a id="opsgenie"></a>[`opsgenie`](#opsgenie) - Optional Block<br>OpsGenie
|
|
64
|
-
<br><br>• <a id="pagerduty"></a>[`pagerduty`](#pagerduty) - Optional Block<br>PagerDuty
|
|
65
|
-
<br><br>• <a id="slack"></a>[`slack`](#slack) - Optional Block<br>Slack
|
|
63
|
+
<br><br>• <a id="opsgenie"></a>[`opsgenie`](#opsgenie) - Optional Block<br>OpsGenie configuration to send alert notifications<br>See [Opsgenie](#opsgenie) below for details.
|
|
64
|
+
<br><br>• <a id="pagerduty"></a>[`pagerduty`](#pagerduty) - Optional Block<br>PagerDuty configuration to send alert notifications<br>See [Pagerduty](#pagerduty) below for details.
|
|
65
|
+
<br><br>• <a id="slack"></a>[`slack`](#slack) - Optional Block<br>Slack configuration to send alert notifications<br>See [Slack](#slack) below for details.
|
|
66
66
|
<br><br>• <a id="sms"></a>[`sms`](#sms) - Optional Block<br>SMS Configuration<br>See [Sms](#sms) below for details.
|
|
67
|
-
<br><br>• <a id="webhook"></a>[`webhook`](#webhook) - Optional Block<br>Webhook
|
|
67
|
+
<br><br>• <a id="webhook"></a>[`webhook`](#webhook) - Optional Block<br>Webhook configuration to send alert notifications<br>See [Webhook](#webhook) below for details.
|
|
68
68
|
|
|
69
69
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
70
70
|
|
|
@@ -86,109 +86,109 @@ An [`email`](#email) block supports the following:
|
|
|
86
86
|
|
|
87
87
|
An [`opsgenie`](#opsgenie) block supports the following:
|
|
88
88
|
|
|
89
|
-
<a id="opsgenie-api-key"></a>• [`api_key`](#opsgenie-api-key) - Optional Block<br>
|
|
89
|
+
<a id="opsgenie-api-key"></a>• [`api_key`](#opsgenie-api-key) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [API Key](#opsgenie-api-key) below.
|
|
90
90
|
|
|
91
|
-
<a id="opsgenie-url"></a>• [`url`](#opsgenie-url) - Optional String<br>
|
|
91
|
+
<a id="opsgenie-url"></a>• [`url`](#opsgenie-url) - Optional String<br>URL to send API requests to
|
|
92
92
|
|
|
93
93
|
#### Opsgenie API Key
|
|
94
94
|
|
|
95
95
|
An [`api_key`](#opsgenie-api-key) block (within [`opsgenie`](#opsgenie)) supports the following:
|
|
96
96
|
|
|
97
|
-
<a id="opsgenie-api-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#opsgenie-api-key-blindfold-secret-info) - Optional Block<br>
|
|
97
|
+
<a id="opsgenie-api-key-blindfold-secret-info"></a>• [`blindfold_secret_info`](#opsgenie-api-key-blindfold-secret-info) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#opsgenie-api-key-blindfold-secret-info) below.
|
|
98
98
|
|
|
99
|
-
<a id="opsgenie-api-key-clear-secret-info"></a>• [`clear_secret_info`](#opsgenie-api-key-clear-secret-info) - Optional Block<br>
|
|
99
|
+
<a id="opsgenie-api-key-clear-secret-info"></a>• [`clear_secret_info`](#opsgenie-api-key-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#opsgenie-api-key-clear-secret-info) below.
|
|
100
100
|
|
|
101
101
|
#### Opsgenie API Key Blindfold Secret Info
|
|
102
102
|
|
|
103
103
|
A [`blindfold_secret_info`](#opsgenie-api-key-blindfold-secret-info) block (within [`opsgenie.api_key`](#opsgenie-api-key)) supports the following:
|
|
104
104
|
|
|
105
|
-
<a id="provider-ecad4c"></a>• [`decryption_provider`](#provider-ecad4c) - Optional String<br>
|
|
105
|
+
<a id="provider-ecad4c"></a>• [`decryption_provider`](#provider-ecad4c) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
106
106
|
|
|
107
|
-
<a id="location-8a2de8"></a>• [`location`](#location-8a2de8) - Optional String<br>Location
|
|
107
|
+
<a id="location-8a2de8"></a>• [`location`](#location-8a2de8) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
108
108
|
|
|
109
|
-
<a id="provider-135329"></a>• [`store_provider`](#provider-135329) - Optional String<br>
|
|
109
|
+
<a id="provider-135329"></a>• [`store_provider`](#provider-135329) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
110
110
|
|
|
111
111
|
#### Opsgenie API Key Clear Secret Info
|
|
112
112
|
|
|
113
113
|
A [`clear_secret_info`](#opsgenie-api-key-clear-secret-info) block (within [`opsgenie.api_key`](#opsgenie-api-key)) supports the following:
|
|
114
114
|
|
|
115
|
-
<a id="ref-3e8ac3"></a>• [`provider_ref`](#ref-3e8ac3) - Optional String<br>
|
|
115
|
+
<a id="ref-3e8ac3"></a>• [`provider_ref`](#ref-3e8ac3) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
116
116
|
|
|
117
|
-
<a id="opsgenie-api-key-clear-secret-info-url"></a>• [`url`](#opsgenie-api-key-clear-secret-info-url) - Optional String<br>URL
|
|
117
|
+
<a id="opsgenie-api-key-clear-secret-info-url"></a>• [`url`](#opsgenie-api-key-clear-secret-info-url) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
118
118
|
|
|
119
119
|
#### Pagerduty
|
|
120
120
|
|
|
121
121
|
A [`pagerduty`](#pagerduty) block supports the following:
|
|
122
122
|
|
|
123
|
-
<a id="pagerduty-routing-key"></a>• [`routing_key`](#pagerduty-routing-key) - Optional Block<br>
|
|
123
|
+
<a id="pagerduty-routing-key"></a>• [`routing_key`](#pagerduty-routing-key) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Routing Key](#pagerduty-routing-key) below.
|
|
124
124
|
|
|
125
|
-
<a id="pagerduty-url"></a>• [`url`](#pagerduty-url) - Optional String<br>
|
|
125
|
+
<a id="pagerduty-url"></a>• [`url`](#pagerduty-url) - Optional String<br>URL to send API requests to
|
|
126
126
|
|
|
127
127
|
#### Pagerduty Routing Key
|
|
128
128
|
|
|
129
129
|
A [`routing_key`](#pagerduty-routing-key) block (within [`pagerduty`](#pagerduty)) supports the following:
|
|
130
130
|
|
|
131
|
-
<a id="info-338522"></a>• [`blindfold_secret_info`](#info-338522) - Optional Block<br>
|
|
131
|
+
<a id="info-338522"></a>• [`blindfold_secret_info`](#info-338522) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-338522) below.
|
|
132
132
|
|
|
133
|
-
<a id="pagerduty-routing-key-clear-secret-info"></a>• [`clear_secret_info`](#pagerduty-routing-key-clear-secret-info) - Optional Block<br>
|
|
133
|
+
<a id="pagerduty-routing-key-clear-secret-info"></a>• [`clear_secret_info`](#pagerduty-routing-key-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#pagerduty-routing-key-clear-secret-info) below.
|
|
134
134
|
|
|
135
135
|
#### Pagerduty Routing Key Blindfold Secret Info
|
|
136
136
|
|
|
137
137
|
A [`blindfold_secret_info`](#info-338522) block (within [`pagerduty.routing_key`](#pagerduty-routing-key)) supports the following:
|
|
138
138
|
|
|
139
|
-
<a id="provider-dbb438"></a>• [`decryption_provider`](#provider-dbb438) - Optional String<br>
|
|
139
|
+
<a id="provider-dbb438"></a>• [`decryption_provider`](#provider-dbb438) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
140
140
|
|
|
141
|
-
<a id="location-6bc59d"></a>• [`location`](#location-6bc59d) - Optional String<br>Location
|
|
141
|
+
<a id="location-6bc59d"></a>• [`location`](#location-6bc59d) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
142
142
|
|
|
143
|
-
<a id="provider-273f68"></a>• [`store_provider`](#provider-273f68) - Optional String<br>
|
|
143
|
+
<a id="provider-273f68"></a>• [`store_provider`](#provider-273f68) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
144
144
|
|
|
145
145
|
#### Pagerduty Routing Key Clear Secret Info
|
|
146
146
|
|
|
147
147
|
A [`clear_secret_info`](#pagerduty-routing-key-clear-secret-info) block (within [`pagerduty.routing_key`](#pagerduty-routing-key)) supports the following:
|
|
148
148
|
|
|
149
|
-
<a id="ref-67e62e"></a>• [`provider_ref`](#ref-67e62e) - Optional String<br>
|
|
149
|
+
<a id="ref-67e62e"></a>• [`provider_ref`](#ref-67e62e) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
150
150
|
|
|
151
|
-
<a id="url-13757a"></a>• [`url`](#url-13757a) - Optional String<br>URL
|
|
151
|
+
<a id="url-13757a"></a>• [`url`](#url-13757a) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
152
152
|
|
|
153
153
|
#### Slack
|
|
154
154
|
|
|
155
155
|
A [`slack`](#slack) block supports the following:
|
|
156
156
|
|
|
157
|
-
<a id="slack-channel"></a>• [`channel`](#slack-channel) - Optional String<br>Channel
|
|
157
|
+
<a id="slack-channel"></a>• [`channel`](#slack-channel) - Optional String<br>Channel or user to send notifications to
|
|
158
158
|
|
|
159
|
-
<a id="slack-url"></a>• [`url`](#slack-url) - Optional Block<br>
|
|
159
|
+
<a id="slack-url"></a>• [`url`](#slack-url) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [URL](#slack-url) below.
|
|
160
160
|
|
|
161
161
|
#### Slack URL
|
|
162
162
|
|
|
163
163
|
An [`url`](#slack-url) block (within [`slack`](#slack)) supports the following:
|
|
164
164
|
|
|
165
|
-
<a id="slack-url-blindfold-secret-info"></a>• [`blindfold_secret_info`](#slack-url-blindfold-secret-info) - Optional Block<br>
|
|
165
|
+
<a id="slack-url-blindfold-secret-info"></a>• [`blindfold_secret_info`](#slack-url-blindfold-secret-info) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#slack-url-blindfold-secret-info) below.
|
|
166
166
|
|
|
167
|
-
<a id="slack-url-clear-secret-info"></a>• [`clear_secret_info`](#slack-url-clear-secret-info) - Optional Block<br>
|
|
167
|
+
<a id="slack-url-clear-secret-info"></a>• [`clear_secret_info`](#slack-url-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#slack-url-clear-secret-info) below.
|
|
168
168
|
|
|
169
169
|
#### Slack URL Blindfold Secret Info
|
|
170
170
|
|
|
171
171
|
A [`blindfold_secret_info`](#slack-url-blindfold-secret-info) block (within [`slack.url`](#slack-url)) supports the following:
|
|
172
172
|
|
|
173
|
-
<a id="provider-c71574"></a>• [`decryption_provider`](#provider-c71574) - Optional String<br>
|
|
173
|
+
<a id="provider-c71574"></a>• [`decryption_provider`](#provider-c71574) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
174
174
|
|
|
175
|
-
<a id="location-d25688"></a>• [`location`](#location-d25688) - Optional String<br>Location
|
|
175
|
+
<a id="location-d25688"></a>• [`location`](#location-d25688) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
176
176
|
|
|
177
|
-
<a id="provider-14e49e"></a>• [`store_provider`](#provider-14e49e) - Optional String<br>
|
|
177
|
+
<a id="provider-14e49e"></a>• [`store_provider`](#provider-14e49e) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
178
178
|
|
|
179
179
|
#### Slack URL Clear Secret Info
|
|
180
180
|
|
|
181
181
|
A [`clear_secret_info`](#slack-url-clear-secret-info) block (within [`slack.url`](#slack-url)) supports the following:
|
|
182
182
|
|
|
183
|
-
<a id="ref-008757"></a>• [`provider_ref`](#ref-008757) - Optional String<br>
|
|
183
|
+
<a id="ref-008757"></a>• [`provider_ref`](#ref-008757) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
184
184
|
|
|
185
|
-
<a id="slack-url-clear-secret-info-url"></a>• [`url`](#slack-url-clear-secret-info-url) - Optional String<br>URL
|
|
185
|
+
<a id="slack-url-clear-secret-info-url"></a>• [`url`](#slack-url-clear-secret-info-url) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
186
186
|
|
|
187
187
|
#### Sms
|
|
188
188
|
|
|
189
189
|
A [`sms`](#sms) block supports the following:
|
|
190
190
|
|
|
191
|
-
<a id="sms-contact-number"></a>• [`contact_number`](#sms-contact-number) - Optional String<br>Contact
|
|
191
|
+
<a id="sms-contact-number"></a>• [`contact_number`](#sms-contact-number) - Optional String<br>Contact number of the user in ITU E.164 format [+]\[country code][subscriber number including area code]
|
|
192
192
|
|
|
193
193
|
#### Timeouts
|
|
194
194
|
|
|
@@ -208,7 +208,7 @@ A [`webhook`](#webhook) block supports the following:
|
|
|
208
208
|
|
|
209
209
|
<a id="webhook-http-config"></a>• [`http_config`](#webhook-http-config) - Optional Block<br>HTTP Configuration. Configuration for HTTP endpoint<br>See [HTTP Config](#webhook-http-config) below.
|
|
210
210
|
|
|
211
|
-
<a id="webhook-url"></a>• [`url`](#webhook-url) - Optional Block<br>
|
|
211
|
+
<a id="webhook-url"></a>• [`url`](#webhook-url) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [URL](#webhook-url) below.
|
|
212
212
|
|
|
213
213
|
#### Webhook HTTP Config
|
|
214
214
|
|
|
@@ -216,33 +216,33 @@ A [`http_config`](#webhook-http-config) block (within [`webhook`](#webhook)) sup
|
|
|
216
216
|
|
|
217
217
|
<a id="webhook-http-config-auth-token"></a>• [`auth_token`](#webhook-http-config-auth-token) - Optional Block<br>Access Token. Authentication Token for access<br>See [Auth Token](#webhook-http-config-auth-token) below.
|
|
218
218
|
|
|
219
|
-
<a id="webhook-http-config-basic-auth"></a>• [`basic_auth`](#webhook-http-config-basic-auth) - Optional Block<br>
|
|
219
|
+
<a id="webhook-http-config-basic-auth"></a>• [`basic_auth`](#webhook-http-config-basic-auth) - Optional Block<br>Authorization parameters to access HTPP alert Receiver Endpoint<br>See [Basic Auth](#webhook-http-config-basic-auth) below.
|
|
220
220
|
|
|
221
221
|
<a id="webhook-http-config-client-cert-obj"></a>• [`client_cert_obj`](#webhook-http-config-client-cert-obj) - Optional Block<br>Client Certificate Object. Configuration for client certificate<br>See [Client Cert Obj](#webhook-http-config-client-cert-obj) below.
|
|
222
222
|
|
|
223
223
|
<a id="webhook-http-config-enable-http2"></a>• [`enable_http2`](#webhook-http-config-enable-http2) - Optional Bool<br>Enable HTTP2. Configure to use HTTP2 protocol
|
|
224
224
|
|
|
225
|
-
<a id="webhook-http-config-follow-redirects"></a>• [`follow_redirects`](#webhook-http-config-follow-redirects) - Optional Bool<br>
|
|
225
|
+
<a id="webhook-http-config-follow-redirects"></a>• [`follow_redirects`](#webhook-http-config-follow-redirects) - Optional Bool<br>Configure whether HTTP requests follow HTTP 3xx redirects
|
|
226
226
|
|
|
227
|
-
<a id="webhook-http-config-no-authorization"></a>• [`no_authorization`](#webhook-http-config-no-authorization) - Optional Block<br>
|
|
227
|
+
<a id="webhook-http-config-no-authorization"></a>• [`no_authorization`](#webhook-http-config-no-authorization) - Optional Block<br>Can be used for messages where no values are needed
|
|
228
228
|
|
|
229
|
-
<a id="webhook-http-config-no-tls"></a>• [`no_tls`](#webhook-http-config-no-tls) - Optional Block<br>
|
|
229
|
+
<a id="webhook-http-config-no-tls"></a>• [`no_tls`](#webhook-http-config-no-tls) - Optional Block<br>Can be used for messages where no values are needed
|
|
230
230
|
|
|
231
|
-
<a id="webhook-http-config-use-tls"></a>• [`use_tls`](#webhook-http-config-use-tls) - Optional Block<br>
|
|
231
|
+
<a id="webhook-http-config-use-tls"></a>• [`use_tls`](#webhook-http-config-use-tls) - Optional Block<br>Configures the token request's TLS settings<br>See [Use TLS](#webhook-http-config-use-tls) below.
|
|
232
232
|
|
|
233
233
|
#### Webhook HTTP Config Auth Token
|
|
234
234
|
|
|
235
235
|
An [`auth_token`](#webhook-http-config-auth-token) block (within [`webhook.http_config`](#webhook-http-config)) supports the following:
|
|
236
236
|
|
|
237
|
-
<a id="webhook-http-config-auth-token-token"></a>• [`token`](#webhook-http-config-auth-token-token) - Optional Block<br>
|
|
237
|
+
<a id="webhook-http-config-auth-token-token"></a>• [`token`](#webhook-http-config-auth-token-token) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Token](#webhook-http-config-auth-token-token) below.
|
|
238
238
|
|
|
239
239
|
#### Webhook HTTP Config Auth Token Token
|
|
240
240
|
|
|
241
241
|
A [`token`](#webhook-http-config-auth-token-token) block (within [`webhook.http_config.auth_token`](#webhook-http-config-auth-token)) supports the following:
|
|
242
242
|
|
|
243
|
-
<a id="info-cf9560"></a>• [`blindfold_secret_info`](#info-cf9560) - Optional Block<br>
|
|
243
|
+
<a id="info-cf9560"></a>• [`blindfold_secret_info`](#info-cf9560) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-cf9560) below.
|
|
244
244
|
|
|
245
|
-
<a id="info-a3e44e"></a>• [`clear_secret_info`](#info-a3e44e) - Optional Block<br>
|
|
245
|
+
<a id="info-a3e44e"></a>• [`clear_secret_info`](#info-a3e44e) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-a3e44e) below.
|
|
246
246
|
|
|
247
247
|
#### Webhook HTTP Config Auth Token Token Blindfold Secret Info
|
|
248
248
|
|
|
@@ -256,17 +256,17 @@ A [`token`](#webhook-http-config-auth-token-token) block (within [`webhook.http_
|
|
|
256
256
|
|
|
257
257
|
A [`basic_auth`](#webhook-http-config-basic-auth) block (within [`webhook.http_config`](#webhook-http-config)) supports the following:
|
|
258
258
|
|
|
259
|
-
<a id="webhook-http-config-basic-auth-password"></a>• [`password`](#webhook-http-config-basic-auth-password) - Optional Block<br>
|
|
259
|
+
<a id="webhook-http-config-basic-auth-password"></a>• [`password`](#webhook-http-config-basic-auth-password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#webhook-http-config-basic-auth-password) below.
|
|
260
260
|
|
|
261
|
-
<a id="name-8da031"></a>• [`user_name`](#name-8da031) - Optional String<br>
|
|
261
|
+
<a id="name-8da031"></a>• [`user_name`](#name-8da031) - Optional String<br>HTTP Basic Auth User Name
|
|
262
262
|
|
|
263
263
|
#### Webhook HTTP Config Basic Auth Password
|
|
264
264
|
|
|
265
265
|
A [`password`](#webhook-http-config-basic-auth-password) block (within [`webhook.http_config.basic_auth`](#webhook-http-config-basic-auth)) supports the following:
|
|
266
266
|
|
|
267
|
-
<a id="info-f1b0b0"></a>• [`blindfold_secret_info`](#info-f1b0b0) - Optional Block<br>
|
|
267
|
+
<a id="info-f1b0b0"></a>• [`blindfold_secret_info`](#info-f1b0b0) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-f1b0b0) below.
|
|
268
268
|
|
|
269
|
-
<a id="info-71ce91"></a>• [`clear_secret_info`](#info-71ce91) - Optional Block<br>
|
|
269
|
+
<a id="info-71ce91"></a>• [`clear_secret_info`](#info-71ce91) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-71ce91) below.
|
|
270
270
|
|
|
271
271
|
#### Webhook HTTP Config Basic Auth Password Blindfold Secret Info
|
|
272
272
|
|
|
@@ -290,17 +290,17 @@ A [`client_cert_obj`](#webhook-http-config-client-cert-obj) block (within [`webh
|
|
|
290
290
|
|
|
291
291
|
An [`use_tls`](#webhook-http-config-use-tls) block (within [`webhook.http_config`](#webhook-http-config)) supports the following:
|
|
292
292
|
|
|
293
|
-
<a id="webhook-http-config-use-tls-disable-sni"></a>• [`disable_sni`](#webhook-http-config-use-tls-disable-sni) - Optional Block<br>
|
|
293
|
+
<a id="webhook-http-config-use-tls-disable-sni"></a>• [`disable_sni`](#webhook-http-config-use-tls-disable-sni) - Optional Block<br>Can be used for messages where no values are needed
|
|
294
294
|
|
|
295
|
-
<a id="webhook-http-config-use-tls-max-version"></a>• [`max_version`](#webhook-http-config-use-tls-max-version) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3]
|
|
295
|
+
<a id="webhook-http-config-use-tls-max-version"></a>• [`max_version`](#webhook-http-config-use-tls-max-version) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
296
296
|
|
|
297
|
-
<a id="webhook-http-config-use-tls-min-version"></a>• [`min_version`](#webhook-http-config-use-tls-min-version) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3]
|
|
297
|
+
<a id="webhook-http-config-use-tls-min-version"></a>• [`min_version`](#webhook-http-config-use-tls-min-version) - Optional String Defaults to `TLS_AUTO`<br>Possible values are `TLS_AUTO`, `TLSv1_0`, `TLSv1_1`, `TLSv1_2`, `TLSv1_3`<br>[Enum: TLS_AUTO|TLSv1_0|TLSv1_1|TLSv1_2|TLSv1_3] TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version
|
|
298
298
|
|
|
299
|
-
<a id="webhook-http-config-use-tls-sni"></a>• [`sni`](#webhook-http-config-use-tls-sni) - Optional String<br>SNI
|
|
299
|
+
<a id="webhook-http-config-use-tls-sni"></a>• [`sni`](#webhook-http-config-use-tls-sni) - Optional String<br>SNI value to be used
|
|
300
300
|
|
|
301
301
|
<a id="verification-b3e5f0"></a>• [`use_server_verification`](#verification-b3e5f0) - Optional Block<br>TLS Validation Context for Servers. Upstream TLS Validation Context<br>See [Use Server Verification](#verification-b3e5f0) below.
|
|
302
302
|
|
|
303
|
-
<a id="trusted-ca-138b8e"></a>• [`volterra_trusted_ca`](#trusted-ca-138b8e) - Optional Block<br>
|
|
303
|
+
<a id="trusted-ca-138b8e"></a>• [`volterra_trusted_ca`](#trusted-ca-138b8e) - Optional Block<br>Can be used for messages where no values are needed
|
|
304
304
|
|
|
305
305
|
#### Webhook HTTP Config Use TLS Use Server Verification
|
|
306
306
|
|
|
@@ -318,27 +318,27 @@ An [`use_tls`](#webhook-http-config-use-tls) block (within [`webhook.http_config
|
|
|
318
318
|
|
|
319
319
|
An [`url`](#webhook-url) block (within [`webhook`](#webhook)) supports the following:
|
|
320
320
|
|
|
321
|
-
<a id="webhook-url-blindfold-secret-info"></a>• [`blindfold_secret_info`](#webhook-url-blindfold-secret-info) - Optional Block<br>
|
|
321
|
+
<a id="webhook-url-blindfold-secret-info"></a>• [`blindfold_secret_info`](#webhook-url-blindfold-secret-info) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#webhook-url-blindfold-secret-info) below.
|
|
322
322
|
|
|
323
|
-
<a id="webhook-url-clear-secret-info"></a>• [`clear_secret_info`](#webhook-url-clear-secret-info) - Optional Block<br>
|
|
323
|
+
<a id="webhook-url-clear-secret-info"></a>• [`clear_secret_info`](#webhook-url-clear-secret-info) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#webhook-url-clear-secret-info) below.
|
|
324
324
|
|
|
325
325
|
#### Webhook URL Blindfold Secret Info
|
|
326
326
|
|
|
327
327
|
A [`blindfold_secret_info`](#webhook-url-blindfold-secret-info) block (within [`webhook.url`](#webhook-url)) supports the following:
|
|
328
328
|
|
|
329
|
-
<a id="provider-f9e163"></a>• [`decryption_provider`](#provider-f9e163) - Optional String<br>
|
|
329
|
+
<a id="provider-f9e163"></a>• [`decryption_provider`](#provider-f9e163) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
330
330
|
|
|
331
|
-
<a id="location-3da6df"></a>• [`location`](#location-3da6df) - Optional String<br>Location
|
|
331
|
+
<a id="location-3da6df"></a>• [`location`](#location-3da6df) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
332
332
|
|
|
333
|
-
<a id="provider-dc4a55"></a>• [`store_provider`](#provider-dc4a55) - Optional String<br>
|
|
333
|
+
<a id="provider-dc4a55"></a>• [`store_provider`](#provider-dc4a55) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
334
334
|
|
|
335
335
|
#### Webhook URL Clear Secret Info
|
|
336
336
|
|
|
337
337
|
A [`clear_secret_info`](#webhook-url-clear-secret-info) block (within [`webhook.url`](#webhook-url)) supports the following:
|
|
338
338
|
|
|
339
|
-
<a id="ref-16bc23"></a>• [`provider_ref`](#ref-16bc23) - Optional String<br>
|
|
339
|
+
<a id="ref-16bc23"></a>• [`provider_ref`](#ref-16bc23) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
340
340
|
|
|
341
|
-
<a id="webhook-url-clear-secret-info-url"></a>• [`url`](#webhook-url-clear-secret-info-url) - Optional String<br>URL
|
|
341
|
+
<a id="webhook-url-clear-secret-info-url"></a>• [`url`](#webhook-url-clear-secret-info-url) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
342
342
|
|
|
343
343
|
---
|
|
344
344
|
|
|
@@ -32,7 +32,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
# API Crawler
|
|
35
|
+
# API Crawler Configuration .
|
|
36
36
|
domains {
|
|
37
37
|
# Configure domains settings
|
|
38
38
|
}
|
|
@@ -40,7 +40,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
40
40
|
simple_login {
|
|
41
41
|
# Configure simple_login settings
|
|
42
42
|
}
|
|
43
|
-
#
|
|
43
|
+
# SecretType is used in an object to indicate a sensitive/c...
|
|
44
44
|
password {
|
|
45
45
|
# Configure password settings
|
|
46
46
|
}
|
|
@@ -66,7 +66,7 @@ resource "f5xc_api_crawler" "example" {
|
|
|
66
66
|
|
|
67
67
|
### Spec Argument Reference
|
|
68
68
|
|
|
69
|
-
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>API Crawler
|
|
69
|
+
<a id="domains"></a>• [`domains`](#domains) - Optional Block<br>API Crawler Configuration<br>See [Domains](#domains) below for details.
|
|
70
70
|
|
|
71
71
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
82
82
|
|
|
83
83
|
A [`domains`](#domains) block supports the following:
|
|
84
84
|
|
|
85
|
-
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>
|
|
85
|
+
<a id="domains-domain"></a>• [`domain`](#domains-domain) - Optional String<br>Select the domain to execute API Crawling with given credentials
|
|
86
86
|
|
|
87
87
|
<a id="domains-simple-login"></a>• [`simple_login`](#domains-simple-login) - Optional Block<br>Simple Login<br>See [Simple Login](#domains-simple-login) below.
|
|
88
88
|
|
|
@@ -90,35 +90,35 @@ A [`domains`](#domains) block supports the following:
|
|
|
90
90
|
|
|
91
91
|
A [`simple_login`](#domains-simple-login) block (within [`domains`](#domains)) supports the following:
|
|
92
92
|
|
|
93
|
-
<a id="domains-simple-login-password"></a>• [`password`](#domains-simple-login-password) - Optional Block<br>
|
|
93
|
+
<a id="domains-simple-login-password"></a>• [`password`](#domains-simple-login-password) - Optional Block<br>SecretType is used in an object to indicate a sensitive/confidential field<br>See [Password](#domains-simple-login-password) below.
|
|
94
94
|
|
|
95
|
-
<a id="domains-simple-login-user"></a>• [`user`](#domains-simple-login-user) - Optional String<br>
|
|
95
|
+
<a id="domains-simple-login-user"></a>• [`user`](#domains-simple-login-user) - Optional String<br>Enter the username to assign credentials for the selected domain to crawl
|
|
96
96
|
|
|
97
97
|
#### Domains Simple Login Password
|
|
98
98
|
|
|
99
99
|
A [`password`](#domains-simple-login-password) block (within [`domains.simple_login`](#domains-simple-login)) supports the following:
|
|
100
100
|
|
|
101
|
-
<a id="info-e14daf"></a>• [`blindfold_secret_info`](#info-e14daf) - Optional Block<br>
|
|
101
|
+
<a id="info-e14daf"></a>• [`blindfold_secret_info`](#info-e14daf) - Optional Block<br>BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management<br>See [Blindfold Secret Info](#info-e14daf) below.
|
|
102
102
|
|
|
103
|
-
<a id="info-ec3463"></a>• [`clear_secret_info`](#info-ec3463) - Optional Block<br>
|
|
103
|
+
<a id="info-ec3463"></a>• [`clear_secret_info`](#info-ec3463) - Optional Block<br>ClearSecretInfoType specifies information about the Secret that is not encrypted<br>See [Clear Secret Info](#info-ec3463) below.
|
|
104
104
|
|
|
105
105
|
#### Domains Simple Login Password Blindfold Secret Info
|
|
106
106
|
|
|
107
107
|
A [`blindfold_secret_info`](#info-e14daf) block (within [`domains.simple_login.password`](#domains-simple-login-password)) supports the following:
|
|
108
108
|
|
|
109
|
-
<a id="provider-bdecf7"></a>• [`decryption_provider`](#provider-bdecf7) - Optional String<br>
|
|
109
|
+
<a id="provider-bdecf7"></a>• [`decryption_provider`](#provider-bdecf7) - Optional String<br>Name of the Secret Management Access object that contains information about the backend Secret Management service
|
|
110
110
|
|
|
111
|
-
<a id="location-cdab6e"></a>• [`location`](#location-cdab6e) - Optional String<br>Location
|
|
111
|
+
<a id="location-cdab6e"></a>• [`location`](#location-cdab6e) - Optional String<br>Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location
|
|
112
112
|
|
|
113
|
-
<a id="provider-8d2611"></a>• [`store_provider`](#provider-8d2611) - Optional String<br>
|
|
113
|
+
<a id="provider-8d2611"></a>• [`store_provider`](#provider-8d2611) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
114
114
|
|
|
115
115
|
#### Domains Simple Login Password Clear Secret Info
|
|
116
116
|
|
|
117
117
|
A [`clear_secret_info`](#info-ec3463) block (within [`domains.simple_login.password`](#domains-simple-login-password)) supports the following:
|
|
118
118
|
|
|
119
|
-
<a id="ref-32ac85"></a>• [`provider_ref`](#ref-32ac85) - Optional String<br>
|
|
119
|
+
<a id="ref-32ac85"></a>• [`provider_ref`](#ref-32ac85) - Optional String<br>Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///
|
|
120
120
|
|
|
121
|
-
<a id="url-e5dfac"></a>• [`url`](#url-e5dfac) - Optional String<br>URL
|
|
121
|
+
<a id="url-e5dfac"></a>• [`url`](#url-e5dfac) - Optional String<br>URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding
|
|
122
122
|
|
|
123
123
|
#### Timeouts
|
|
124
124
|
|
|
@@ -59,17 +59,17 @@ resource "f5xc_api_definition" "example" {
|
|
|
59
59
|
|
|
60
60
|
### Spec Argument Reference
|
|
61
61
|
|
|
62
|
-
<a id="api-inventory-exclusion-list"></a>• [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) - Optional Block<br>
|
|
62
|
+
<a id="api-inventory-exclusion-list"></a>• [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) - Optional Block<br>List of API Endpoints excluded from the API Inventory<br>See [API Inventory Exclusion List](#api-inventory-exclusion-list) below for details.
|
|
63
63
|
|
|
64
|
-
<a id="api-inventory-inclusion-list"></a>• [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) - Optional Block<br>
|
|
64
|
+
<a id="api-inventory-inclusion-list"></a>• [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) - Optional Block<br>List of API Endpoints included in the API Inventory. Typically, discovered API endpoints are added to the API Inventory using this list<br>See [API Inventory Inclusion List](#api-inventory-inclusion-list) below for details.
|
|
65
65
|
|
|
66
66
|
-> **One of the following:**
|
|
67
|
-
• <a id="mixed-schema-origin"></a>[`mixed_schema_origin`](#mixed-schema-origin) - Optional Block<br>
|
|
68
|
-
<br><br>• <a id="strict-schema-origin"></a>[`strict_schema_origin`](#strict-schema-origin) - Optional Block<br>
|
|
67
|
+
• <a id="mixed-schema-origin"></a>[`mixed_schema_origin`](#mixed-schema-origin) - Optional Block<br>Can be used for messages where no values are needed
|
|
68
|
+
<br><br>• <a id="strict-schema-origin"></a>[`strict_schema_origin`](#strict-schema-origin) - Optional Block<br>Can be used for messages where no values are needed
|
|
69
69
|
|
|
70
70
|
<a id="non-api-endpoints"></a>• [`non_api_endpoints`](#non-api-endpoints) - Optional Block<br>API Discovery Exclusion List. List of Non-API Endpoints<br>See [Non API Endpoints](#non-api-endpoints) below for details.
|
|
71
71
|
|
|
72
|
-
<a id="swagger-specs"></a>• [`swagger_specs`](#swagger-specs) - Optional List<br>
|
|
72
|
+
<a id="swagger-specs"></a>• [`swagger_specs`](#swagger-specs) - Optional List<br>Define your application API by single or multiple OpenAPI files. 1. Upload your OpenAPI files via Web App & API Protection-> Files-> Swagger Files. 2. Select from the list of uploaded files
|
|
73
73
|
|
|
74
74
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
75
75
|
|
|
@@ -85,25 +85,25 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
85
85
|
|
|
86
86
|
An [`api_inventory_exclusion_list`](#api-inventory-exclusion-list) block supports the following:
|
|
87
87
|
|
|
88
|
-
<a id="api-inventory-exclusion-list-method"></a>• [`method`](#api-inventory-exclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
88
|
+
<a id="api-inventory-exclusion-list-method"></a>• [`method`](#api-inventory-exclusion-list-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
|
|
89
89
|
|
|
90
|
-
<a id="api-inventory-exclusion-list-path"></a>• [`path`](#api-inventory-exclusion-list-path) - Optional String<br>
|
|
90
|
+
<a id="api-inventory-exclusion-list-path"></a>• [`path`](#api-inventory-exclusion-list-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
91
91
|
|
|
92
92
|
#### API Inventory Inclusion List
|
|
93
93
|
|
|
94
94
|
An [`api_inventory_inclusion_list`](#api-inventory-inclusion-list) block supports the following:
|
|
95
95
|
|
|
96
|
-
<a id="api-inventory-inclusion-list-method"></a>• [`method`](#api-inventory-inclusion-list-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
96
|
+
<a id="api-inventory-inclusion-list-method"></a>• [`method`](#api-inventory-inclusion-list-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
|
|
97
97
|
|
|
98
|
-
<a id="api-inventory-inclusion-list-path"></a>• [`path`](#api-inventory-inclusion-list-path) - Optional String<br>
|
|
98
|
+
<a id="api-inventory-inclusion-list-path"></a>• [`path`](#api-inventory-inclusion-list-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
99
99
|
|
|
100
100
|
#### Non API Endpoints
|
|
101
101
|
|
|
102
102
|
A [`non_api_endpoints`](#non-api-endpoints) block supports the following:
|
|
103
103
|
|
|
104
|
-
<a id="non-api-endpoints-method"></a>• [`method`](#non-api-endpoints-method) - Optional String Defaults to `ANY`<br>See [HTTP Methods](#common-http-methods)<br>
|
|
104
|
+
<a id="non-api-endpoints-method"></a>• [`method`](#non-api-endpoints-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
|
|
105
105
|
|
|
106
|
-
<a id="non-api-endpoints-path"></a>• [`path`](#non-api-endpoints-path) - Optional String<br>
|
|
106
|
+
<a id="non-api-endpoints-path"></a>• [`path`](#non-api-endpoints-path) - Optional String<br>Endpoint path, as specified in OpenAPI, including parameters. The path should comply with RFC 3986 and may have parameters according to OpenAPI specification
|
|
107
107
|
|
|
108
108
|
#### Timeouts
|
|
109
109
|
|
|
@@ -32,7 +32,7 @@ resource "f5xc_api_discovery" "example" {
|
|
|
32
32
|
}
|
|
33
33
|
|
|
34
34
|
# Resource-specific configuration
|
|
35
|
-
#
|
|
35
|
+
# Select your custom authentication types to be detected in...
|
|
36
36
|
custom_auth_types {
|
|
37
37
|
# Configure custom_auth_types settings
|
|
38
38
|
}
|
|
@@ -58,7 +58,7 @@ resource "f5xc_api_discovery" "example" {
|
|
|
58
58
|
|
|
59
59
|
### Spec Argument Reference
|
|
60
60
|
|
|
61
|
-
<a id="custom-auth-types"></a>• [`custom_auth_types`](#custom-auth-types) - Optional Block<br>
|
|
61
|
+
<a id="custom-auth-types"></a>• [`custom_auth_types`](#custom-auth-types) - Optional Block<br>Select your custom authentication types to be detected in the API discovery<br>See [Custom Auth Types](#custom-auth-types) below for details.
|
|
62
62
|
|
|
63
63
|
<a id="timeouts"></a>• [`timeouts`](#timeouts) - Optional Block<br>See [Timeouts](#timeouts) below for details.
|
|
64
64
|
|
|
@@ -74,9 +74,9 @@ In addition to all arguments above, the following attributes are exported:
|
|
|
74
74
|
|
|
75
75
|
A [`custom_auth_types`](#custom-auth-types) block supports the following:
|
|
76
76
|
|
|
77
|
-
<a id="custom-auth-types-parameter-name"></a>• [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>
|
|
77
|
+
<a id="custom-auth-types-parameter-name"></a>• [`parameter_name`](#custom-auth-types-parameter-name) - Optional String<br>The authentication parameter name
|
|
78
78
|
|
|
79
|
-
<a id="custom-auth-types-parameter-type"></a>• [`parameter_type`](#custom-auth-types-parameter-type) - Optional String Defaults to `QUERY_PARAMETER`<br>Possible values are `QUERY_PARAMETER`, `HEADER`, `COOKIE`<br>[Enum: QUERY_PARAMETER|HEADER|COOKIE]
|
|
79
|
+
<a id="custom-auth-types-parameter-type"></a>• [`parameter_type`](#custom-auth-types-parameter-type) - Optional String Defaults to `QUERY_PARAMETER`<br>Possible values are `QUERY_PARAMETER`, `HEADER`, `COOKIE`<br>[Enum: QUERY_PARAMETER|HEADER|COOKIE] Enumeration for authentication parameter types
|
|
80
80
|
|
|
81
81
|
#### Timeouts
|
|
82
82
|
|