fastly 16.1.0 → 17.0.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +58 -0
- data/Gemfile.lock +1 -1
- data/README.md +101 -58
- data/docs/Action.md +11 -0
- data/docs/ActionType.md +9 -0
- data/docs/AgentKey.md +14 -0
- data/docs/AgentKeyMeta.md +10 -0
- data/docs/Backend.md +3 -1
- data/docs/BackendApi.md +12 -4
- data/docs/BackendResponse.md +3 -1
- data/docs/BotManagementRequestUpdateConfiguration.md +10 -0
- data/docs/BotManagementResponseConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigurationConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigure.md +13 -0
- data/docs/ClientSideProtectionApi.md +821 -0
- data/docs/ConditionOperator.md +9 -0
- data/docs/ConditionType.md +9 -0
- data/docs/DdosProtectionApi.md +4 -4
- data/docs/Directive.md +11 -0
- data/docs/DmDomainsApi.md +2 -2
- data/docs/DmRoutingConfigsApi.md +912 -0
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/DomainResearchApi.md +2 -2
- data/docs/DraftDiff.md +12 -0
- data/docs/DraftUpdate.md +10 -0
- data/docs/EventsResponse.md +1 -1
- data/docs/HeaderEvent.md +14 -0
- data/docs/InitialVersion.md +12 -0
- data/docs/InitialVersionPath.md +11 -0
- data/docs/InlineResponse20010.md +2 -2
- data/docs/InlineResponse20011.md +2 -2
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +2 -2
- data/docs/InlineResponse20014.md +2 -1
- data/docs/InlineResponse20015.md +10 -0
- data/docs/InlineResponse20016.md +10 -0
- data/docs/InlineResponse20017.md +11 -0
- data/docs/InlineResponse20018.md +11 -0
- data/docs/InlineResponse20019.md +11 -0
- data/docs/InlineResponse20020.md +11 -0
- data/docs/InlineResponse20021.md +11 -0
- data/docs/InlineResponse20022.md +10 -0
- data/docs/InlineResponse2005.md +2 -2
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +2 -1
- data/docs/InlineResponse2009.md +2 -1
- data/docs/InvitationsResponse.md +1 -1
- data/docs/KvStoreApi.md +2 -2
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/KvStoreResponseBodyEnable.md +12 -0
- data/docs/KvStoreResponseCustomer.md +10 -0
- data/docs/KvStoreResponseLinks.md +10 -0
- data/docs/KvStoreResponseLinksLinks.md +10 -0
- data/docs/KvStoreResponseProduct.md +10 -0
- data/docs/KvStoreResponseProductProduct.md +11 -0
- data/docs/LoggingAzureblobApi.md +4 -4
- data/docs/LoggingAzureblobResponse.md +1 -1
- data/docs/LoggingCloudfilesApi.md +4 -4
- data/docs/LoggingCloudfilesResponse.md +1 -1
- data/docs/LoggingDigitaloceanApi.md +4 -4
- data/docs/LoggingDigitaloceanResponse.md +1 -1
- data/docs/LoggingFtpApi.md +4 -4
- data/docs/LoggingFtpResponse.md +1 -1
- data/docs/LoggingGcsApi.md +4 -4
- data/docs/LoggingGcsResponse.md +1 -1
- data/docs/LoggingGenericCommon.md +1 -1
- data/docs/LoggingGenericCommonResponse.md +1 -1
- data/docs/LoggingGenericCommonResponseAllOf.md +1 -1
- data/docs/LoggingHttpsAdditional.md +1 -1
- data/docs/LoggingHttpsApi.md +4 -4
- data/docs/LoggingHttpsResponse.md +1 -1
- data/docs/LoggingOpenstackApi.md +4 -4
- data/docs/LoggingOpenstackResponse.md +1 -1
- data/docs/LoggingS3Api.md +4 -4
- data/docs/LoggingS3Response.md +1 -1
- data/docs/LoggingSftpApi.md +4 -4
- data/docs/LoggingSftpResponse.md +1 -1
- data/docs/LoggingSumologicAdditional.md +1 -1
- data/docs/LoggingSumologicApi.md +4 -4
- data/docs/LoggingSumologicResponse.md +1 -1
- data/docs/LoggingSyslogAdditional.md +1 -1
- data/docs/LoggingSyslogApi.md +4 -4
- data/docs/LoggingSyslogResponse.md +1 -1
- data/docs/MutualAuthenticationsResponse.md +1 -1
- data/docs/NgwafAgentKeysApi.md +55 -0
- data/docs/NgwafSimulateApi.md +61 -0
- data/docs/Notification.md +11 -0
- data/docs/NotificationConfig.md +10 -0
- data/docs/Page.md +17 -0
- data/docs/PageCreate.md +14 -0
- data/docs/PageUpdate.md +14 -0
- data/docs/Pagination.md +1 -1
- data/docs/PaginationMeta.md +4 -4
- data/docs/PaginationMeta1.md +13 -0
- data/docs/PathChange.md +15 -0
- data/docs/PathCreate.md +10 -0
- data/docs/PathResponse.md +14 -0
- data/docs/PathResponseAllOf.md +12 -0
- data/docs/PathUpdate.md +10 -0
- data/docs/PathWithRules.md +11 -0
- data/docs/PathsResponse.md +11 -0
- data/docs/Policy.md +17 -0
- data/docs/PolicyCreate.md +13 -0
- data/docs/PolicyUpdate.md +13 -0
- data/docs/Position.md +11 -0
- data/docs/ProductBotManagementApi.md +78 -0
- data/docs/ProductKvStoreApi.md +115 -0
- data/docs/RealtimeEntry.md +1 -1
- data/docs/RealtimeEntryAggregated.md +34 -3
- data/docs/RealtimeEntryDatacenter.md +345 -0
- data/docs/RealtimeMeasurements.md +34 -3
- data/docs/Report.md +15 -0
- data/docs/RequestBodyForCreate.md +1 -0
- data/docs/RequestBodyForUpdate.md +1 -0
- data/docs/Results.md +34 -3
- data/docs/RoutingConfig.md +11 -0
- data/docs/RoutingConfigCondition.md +13 -0
- data/docs/RoutingConfigResponse.md +16 -0
- data/docs/RoutingConfigResponseAllOf.md +14 -0
- data/docs/RoutingConfigState.md +9 -0
- data/docs/RoutingConfigVersionResponse.md +13 -0
- data/docs/RoutingConfigsResponse.md +11 -0
- data/docs/RuleChange.md +12 -0
- data/docs/RuleCreate.md +12 -0
- data/docs/RuleResponse.md +15 -0
- data/docs/RuleResponseAllOf.md +13 -0
- data/docs/RuleUpdate.md +12 -0
- data/docs/RulesResponse.md +11 -0
- data/docs/Script.md +20 -0
- data/docs/ScriptUpdate.md +12 -0
- data/docs/SecretStoreApi.md +2 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/SecurityHeader.md +12 -0
- data/docs/ServiceAuthorizationsApi.md +2 -2
- data/docs/ServiceAuthorizationsResponse.md +1 -1
- data/docs/SuccessfulResponseAsObject.md +1 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +1 -0
- data/docs/TlsActivationsResponse.md +1 -1
- data/docs/TlsBulkCertificatesResponse.md +1 -1
- data/docs/TlsCertificatesResponse.md +1 -1
- data/docs/TlsConfigurationsResponse.md +1 -1
- data/docs/TlsDomainsResponse.md +1 -1
- data/docs/TlsPrivateKeysResponse.md +1 -1
- data/docs/TlsSubscriptionsResponse.md +1 -1
- data/docs/VersionsResponse.md +11 -0
- data/docs/WafSimulateRequest.md +11 -0
- data/docs/WafSimulateResponse.md +11 -0
- data/docs/WafSimulateSignal.md +16 -0
- data/docs/Website.md +14 -0
- data/docs/WebsiteCreate.md +10 -0
- data/docs/WebsiteUpdate.md +10 -0
- data/lib/fastly/api/backend_api.rb +16 -4
- data/lib/fastly/api/client_side_protection_api.rb +1465 -0
- data/lib/fastly/api/ddos_protection_api.rb +6 -6
- data/lib/fastly/api/dm_domains_api.rb +3 -3
- data/lib/fastly/api/dm_routing_configs_api.rb +1596 -0
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/domain_research_api.rb +3 -3
- data/lib/fastly/api/kv_store_api.rb +3 -3
- data/lib/fastly/api/kv_store_item_api.rb +3 -3
- data/lib/fastly/api/logging_azureblob_api.rb +6 -6
- data/lib/fastly/api/logging_cloudfiles_api.rb +6 -6
- data/lib/fastly/api/logging_digitalocean_api.rb +6 -6
- data/lib/fastly/api/logging_ftp_api.rb +6 -6
- data/lib/fastly/api/logging_gcs_api.rb +6 -6
- data/lib/fastly/api/logging_https_api.rb +4 -4
- data/lib/fastly/api/logging_openstack_api.rb +6 -6
- data/lib/fastly/api/logging_s3_api.rb +6 -6
- data/lib/fastly/api/logging_sftp_api.rb +6 -6
- data/lib/fastly/api/logging_sumologic_api.rb +4 -4
- data/lib/fastly/api/logging_syslog_api.rb +4 -4
- data/lib/fastly/api/ngwaf_agent_keys_api.rb +83 -0
- data/lib/fastly/api/ngwaf_simulate_api.rb +95 -0
- data/lib/fastly/api/product_bot_management_api.rb +133 -0
- data/lib/fastly/api/product_kv_store_api.rb +186 -0
- data/lib/fastly/api/secret_store_api.rb +3 -3
- data/lib/fastly/api/secret_store_item_api.rb +3 -3
- data/lib/fastly/api/service_authorizations_api.rb +3 -3
- data/lib/fastly/configuration.rb +294 -0
- data/lib/fastly/models/action.rb +237 -0
- data/lib/fastly/models/action_type.rb +34 -0
- data/lib/fastly/models/agent_key.rb +283 -0
- data/lib/fastly/models/agent_key_meta.rb +223 -0
- data/lib/fastly/models/backend.rb +24 -2
- data/lib/fastly/models/backend_response.rb +24 -2
- data/lib/fastly/models/bot_management_request_update_configuration.rb +256 -0
- data/lib/fastly/models/bot_management_response_configuration.rb +216 -0
- data/lib/fastly/models/bot_management_response_configuration_configuration.rb +217 -0
- data/lib/fastly/models/bot_management_response_configure.rb +253 -0
- data/lib/fastly/models/condition_operator.rb +37 -0
- data/lib/fastly/models/condition_type.rb +34 -0
- data/lib/fastly/models/directive.rb +229 -0
- data/lib/fastly/models/draft_diff.rb +244 -0
- data/lib/fastly/models/draft_update.rb +218 -0
- data/lib/fastly/models/events_response.rb +1 -1
- data/lib/fastly/models/header_event.rb +252 -0
- data/lib/fastly/models/initial_version.rb +242 -0
- data/lib/fastly/models/initial_version_path.rb +254 -0
- data/lib/fastly/models/inline_response20010.rb +2 -2
- data/lib/fastly/models/inline_response20011.rb +2 -2
- data/lib/fastly/models/inline_response20012.rb +1 -1
- data/lib/fastly/models/inline_response20013.rb +11 -1
- data/lib/fastly/models/inline_response20014.rb +15 -4
- data/lib/fastly/models/inline_response20015.rb +217 -0
- data/lib/fastly/models/inline_response20016.rb +218 -0
- data/lib/fastly/models/inline_response20017.rb +227 -0
- data/lib/fastly/models/inline_response20018.rb +227 -0
- data/lib/fastly/models/inline_response20019.rb +228 -0
- data/lib/fastly/models/inline_response20020.rb +227 -0
- data/lib/fastly/models/inline_response20021.rb +227 -0
- data/lib/fastly/models/inline_response20022.rb +218 -0
- data/lib/fastly/models/inline_response2005.rb +2 -2
- data/lib/fastly/models/inline_response2006.rb +2 -12
- data/lib/fastly/models/inline_response2007.rb +2 -4
- data/lib/fastly/models/inline_response2008.rb +18 -8
- data/lib/fastly/models/inline_response2009.rb +17 -8
- data/lib/fastly/models/invitations_response.rb +1 -1
- data/lib/fastly/models/kv_store_response_body_enable.rb +243 -0
- data/lib/fastly/models/kv_store_response_customer.rb +216 -0
- data/lib/fastly/models/kv_store_response_links.rb +216 -0
- data/lib/fastly/models/kv_store_response_links_links.rb +217 -0
- data/lib/fastly/models/kv_store_response_product.rb +216 -0
- data/lib/fastly/models/kv_store_response_product_product.rb +227 -0
- data/lib/fastly/models/logging_azureblob_response.rb +3 -3
- data/lib/fastly/models/logging_cloudfiles_response.rb +3 -3
- data/lib/fastly/models/logging_digitalocean_response.rb +3 -3
- data/lib/fastly/models/logging_ftp_response.rb +3 -3
- data/lib/fastly/models/logging_gcs_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response_all_of.rb +3 -3
- data/lib/fastly/models/logging_https_additional.rb +1 -1
- data/lib/fastly/models/logging_https_response.rb +1 -1
- data/lib/fastly/models/logging_message_type.rb +1 -1
- data/lib/fastly/models/logging_openstack_response.rb +3 -3
- data/lib/fastly/models/logging_s3_response.rb +3 -3
- data/lib/fastly/models/logging_sftp_response.rb +3 -3
- data/lib/fastly/models/logging_sumologic_additional.rb +1 -1
- data/lib/fastly/models/logging_sumologic_response.rb +1 -1
- data/lib/fastly/models/logging_syslog_additional.rb +1 -1
- data/lib/fastly/models/logging_syslog_response.rb +1 -1
- data/lib/fastly/models/mutual_authentications_response.rb +1 -1
- data/lib/fastly/models/notification.rb +270 -0
- data/lib/fastly/models/notification_config.rb +218 -0
- data/lib/fastly/models/page.rb +289 -0
- data/lib/fastly/models/page_create.rb +266 -0
- data/lib/fastly/models/page_update.rb +256 -0
- data/lib/fastly/models/pagination.rb +1 -1
- data/lib/fastly/models/pagination_meta.rb +30 -55
- data/lib/fastly/models/pagination_meta1.rb +273 -0
- data/lib/fastly/models/path_change.rb +274 -0
- data/lib/fastly/models/path_create.rb +242 -0
- data/lib/fastly/models/path_response.rb +285 -0
- data/lib/fastly/models/path_response_all_of.rb +254 -0
- data/lib/fastly/models/path_update.rb +233 -0
- data/lib/fastly/models/path_with_rules.rb +228 -0
- data/lib/fastly/models/paths_response.rb +228 -0
- data/lib/fastly/models/policy.rb +315 -0
- data/lib/fastly/models/policy_create.rb +289 -0
- data/lib/fastly/models/policy_update.rb +279 -0
- data/lib/fastly/models/position.rb +228 -0
- data/lib/fastly/models/realtime_entry.rb +2 -5
- data/lib/fastly/models/realtime_entry_aggregated.rb +344 -34
- data/lib/fastly/models/realtime_entry_datacenter.rb +3577 -0
- data/lib/fastly/models/realtime_measurements.rb +344 -34
- data/lib/fastly/models/report.rb +261 -0
- data/lib/fastly/models/request_body_for_create.rb +12 -1
- data/lib/fastly/models/request_body_for_update.rb +12 -1
- data/lib/fastly/models/results.rb +341 -31
- data/lib/fastly/models/routing_config.rb +251 -0
- data/lib/fastly/models/routing_config_condition.rb +261 -0
- data/lib/fastly/models/routing_config_response.rb +305 -0
- data/lib/fastly/models/routing_config_response_all_of.rb +274 -0
- data/lib/fastly/models/routing_config_state.rb +36 -0
- data/lib/fastly/models/routing_config_version_response.rb +250 -0
- data/lib/fastly/models/routing_configs_response.rb +228 -0
- data/lib/fastly/models/rule_change.rb +236 -0
- data/lib/fastly/models/rule_create.rb +267 -0
- data/lib/fastly/models/rule_response.rb +279 -0
- data/lib/fastly/models/rule_response_all_of.rb +248 -0
- data/lib/fastly/models/rule_update.rb +252 -0
- data/lib/fastly/models/rules_response.rb +228 -0
- data/lib/fastly/models/script.rb +350 -0
- data/lib/fastly/models/script_update.rb +271 -0
- data/lib/fastly/models/security_header.rb +234 -0
- data/lib/fastly/models/service_authorizations_response.rb +1 -1
- data/lib/fastly/models/successful_response_as_object.rb +12 -1
- data/lib/fastly/models/successful_response_as_object_all_of.rb +12 -1
- data/lib/fastly/models/tls_activations_response.rb +1 -1
- data/lib/fastly/models/tls_bulk_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_configurations_response.rb +1 -1
- data/lib/fastly/models/tls_domains_response.rb +1 -1
- data/lib/fastly/models/tls_private_keys_response.rb +1 -1
- data/lib/fastly/models/tls_subscriptions_response.rb +1 -1
- data/lib/fastly/models/versions_response.rb +228 -0
- data/lib/fastly/models/waf_simulate_request.rb +233 -0
- data/lib/fastly/models/waf_simulate_response.rb +240 -0
- data/lib/fastly/models/waf_simulate_signal.rb +344 -0
- data/lib/fastly/models/website.rb +257 -0
- data/lib/fastly/models/website_create.rb +222 -0
- data/lib/fastly/models/website_update.rb +217 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +77 -0
- data/sig.json +1 -1
- metadata +156 -2
data/docs/LoggingFtpApi.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: '
|
|
44
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
45
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
46
46
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
47
47
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -77,7 +77,7 @@ end
|
|
|
77
77
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
78
78
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
79
79
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
80
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
80
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
81
81
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
82
82
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
83
83
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -240,7 +240,7 @@ opts = {
|
|
|
240
240
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
241
241
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
242
242
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
243
|
-
message_type: '
|
|
243
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
244
244
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
245
245
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
246
246
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -277,7 +277,7 @@ end
|
|
|
277
277
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
278
278
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
279
279
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
280
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
280
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
281
281
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
282
282
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
283
283
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
data/docs/LoggingFtpResponse.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
13
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
14
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
15
15
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
16
16
|
| **period** | **String** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to '3600'] |
|
data/docs/LoggingGcsApi.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: '
|
|
44
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
45
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
46
46
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
47
47
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -76,7 +76,7 @@ end
|
|
|
76
76
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
77
77
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
78
78
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
79
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
79
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
80
80
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
81
81
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
82
82
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -238,7 +238,7 @@ opts = {
|
|
|
238
238
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
239
239
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
240
240
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
241
|
-
message_type: '
|
|
241
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
242
242
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
243
243
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
244
244
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -274,7 +274,7 @@ end
|
|
|
274
274
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
275
275
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
276
276
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
277
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
277
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
278
278
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
279
279
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
280
280
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
data/docs/LoggingGcsResponse.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
13
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
14
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
15
15
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
16
16
|
| **period** | **String** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to '3600'] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
7
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
8
8
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
9
9
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
10
10
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
7
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
8
8
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
9
9
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
10
10
|
| **period** | **String** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to '3600'] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
7
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
8
8
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
9
9
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
10
10
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **request_max_bytes** | **Integer** | The maximum number of bytes sent in one request. Defaults `0` (100MB). | [optional][default to 0] |
|
|
10
10
|
| **content_type** | **String** | Content type of the header sent with the request. | [optional][default to 'null'] |
|
|
11
11
|
| **header_name** | **String** | Name of the custom header sent with the request. | [optional][default to 'null'] |
|
|
12
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
12
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
13
13
|
| **header_value** | **String** | Value of the custom header sent with the request. | [optional][default to 'null'] |
|
|
14
14
|
| **method** | **String** | HTTP method used for request. | [optional][default to 'POST'] |
|
|
15
15
|
| **json_format** | **String** | Enforces valid JSON formatting for log entries. | [optional] |
|
data/docs/LoggingHttpsApi.md
CHANGED
|
@@ -50,7 +50,7 @@ opts = {
|
|
|
50
50
|
url: 'url_example', # String | The URL to send logs to. Must use HTTPS. Required.
|
|
51
51
|
content_type: 'content_type_example', # String | Content type of the header sent with the request.
|
|
52
52
|
header_name: 'header_name_example', # String | Name of the custom header sent with the request.
|
|
53
|
-
message_type: Fastly::LoggingMessageType::
|
|
53
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
54
54
|
header_value: 'header_value_example', # String | Value of the custom header sent with the request.
|
|
55
55
|
method: 'POST', # String | HTTP method used for request.
|
|
56
56
|
json_format: '0', # String | Enforces valid JSON formatting for log entries.
|
|
@@ -87,7 +87,7 @@ end
|
|
|
87
87
|
| **url** | **String** | The URL to send logs to. Must use HTTPS. Required. | [optional] |
|
|
88
88
|
| **content_type** | **String** | Content type of the header sent with the request. | [optional][default to 'null'] |
|
|
89
89
|
| **header_name** | **String** | Name of the custom header sent with the request. | [optional][default to 'null'] |
|
|
90
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
90
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
91
91
|
| **header_value** | **String** | Value of the custom header sent with the request. | [optional][default to 'null'] |
|
|
92
92
|
| **method** | **String** | HTTP method used for request. | [optional][default to 'POST'] |
|
|
93
93
|
| **json_format** | **String** | Enforces valid JSON formatting for log entries. | [optional] |
|
|
@@ -251,7 +251,7 @@ opts = {
|
|
|
251
251
|
url: 'url_example', # String | The URL to send logs to. Must use HTTPS. Required.
|
|
252
252
|
content_type: 'content_type_example', # String | Content type of the header sent with the request.
|
|
253
253
|
header_name: 'header_name_example', # String | Name of the custom header sent with the request.
|
|
254
|
-
message_type: Fastly::LoggingMessageType::
|
|
254
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
255
255
|
header_value: 'header_value_example', # String | Value of the custom header sent with the request.
|
|
256
256
|
method: 'POST', # String | HTTP method used for request.
|
|
257
257
|
json_format: '0', # String | Enforces valid JSON formatting for log entries.
|
|
@@ -289,7 +289,7 @@ end
|
|
|
289
289
|
| **url** | **String** | The URL to send logs to. Must use HTTPS. Required. | [optional] |
|
|
290
290
|
| **content_type** | **String** | Content type of the header sent with the request. | [optional][default to 'null'] |
|
|
291
291
|
| **header_name** | **String** | Name of the custom header sent with the request. | [optional][default to 'null'] |
|
|
292
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
292
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
293
293
|
| **header_value** | **String** | Value of the custom header sent with the request. | [optional][default to 'null'] |
|
|
294
294
|
| **method** | **String** | HTTP method used for request. | [optional][default to 'POST'] |
|
|
295
295
|
| **json_format** | **String** | Enforces valid JSON formatting for log entries. | [optional] |
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
| **url** | **String** | The URL to send logs to. Must use HTTPS. Required. | [optional] |
|
|
20
20
|
| **content_type** | **String** | Content type of the header sent with the request. | [optional][default to 'null'] |
|
|
21
21
|
| **header_name** | **String** | Name of the custom header sent with the request. | [optional][default to 'null'] |
|
|
22
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
22
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
23
23
|
| **header_value** | **String** | Value of the custom header sent with the request. | [optional][default to 'null'] |
|
|
24
24
|
| **method** | **String** | HTTP method used for request. | [optional][default to 'POST'] |
|
|
25
25
|
| **json_format** | **String** | Enforces valid JSON formatting for log entries. | [optional] |
|
data/docs/LoggingOpenstackApi.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: '
|
|
44
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
45
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
46
46
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
47
47
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -75,7 +75,7 @@ end
|
|
|
75
75
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
76
76
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
77
77
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
78
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
78
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
79
79
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
80
80
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
81
81
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -236,7 +236,7 @@ opts = {
|
|
|
236
236
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
237
237
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
238
238
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
239
|
-
message_type: '
|
|
239
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
240
240
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
241
241
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
242
242
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -271,7 +271,7 @@ end
|
|
|
271
271
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
272
272
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
273
273
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
274
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
274
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
275
275
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
276
276
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
277
277
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
13
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
14
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
15
15
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
16
16
|
| **period** | **String** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to '3600'] |
|
data/docs/LoggingS3Api.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: '
|
|
44
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
45
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
46
46
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
47
47
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -81,7 +81,7 @@ end
|
|
|
81
81
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
82
82
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
83
83
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
84
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
84
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
85
85
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
86
86
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
87
87
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -248,7 +248,7 @@ opts = {
|
|
|
248
248
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
249
249
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
250
250
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
251
|
-
message_type: '
|
|
251
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
252
252
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
253
253
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
254
254
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -289,7 +289,7 @@ end
|
|
|
289
289
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
290
290
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
291
291
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
292
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
292
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
293
293
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
294
294
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
295
295
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
data/docs/LoggingS3Response.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
13
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
14
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
15
15
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
16
16
|
| **period** | **String** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to '3600'] |
|
data/docs/LoggingSftpApi.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: '
|
|
44
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
45
45
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
46
46
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
47
47
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -77,7 +77,7 @@ end
|
|
|
77
77
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
78
78
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
79
79
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
80
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
80
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
81
81
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
82
82
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
83
83
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
|
@@ -240,7 +240,7 @@ opts = {
|
|
|
240
240
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
241
241
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
242
242
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
243
|
-
message_type: '
|
|
243
|
+
message_type: 'blank', # String | How the message should be formatted.
|
|
244
244
|
timestamp_format: 'timestamp_format_example', # String | A timestamp format
|
|
245
245
|
compression_codec: 'zstd', # String | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.
|
|
246
246
|
period: 56, # Integer | How frequently log files are finalized so they can be available for reading (in seconds).
|
|
@@ -277,7 +277,7 @@ end
|
|
|
277
277
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
278
278
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
279
279
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
280
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
280
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
281
281
|
| **timestamp_format** | **String** | A timestamp format | [optional] |
|
|
282
282
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
283
283
|
| **period** | **Integer** | How frequently log files are finalized so they can be available for reading (in seconds). | [optional][default to 3600] |
|
data/docs/LoggingSftpResponse.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | **String** | How the message should be formatted. | [optional][default to '
|
|
13
|
+
| **message_type** | **String** | How the message should be formatted. | [optional][default to 'blank'] |
|
|
14
14
|
| **timestamp_format** | **String** | A timestamp format | [optional][readonly] |
|
|
15
15
|
| **compression_codec** | **String** | The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. | [optional] |
|
|
16
16
|
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
7
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
8
8
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
data/docs/LoggingSumologicApi.md
CHANGED
|
@@ -41,7 +41,7 @@ opts = {
|
|
|
41
41
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
42
42
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
43
43
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
44
|
-
message_type: Fastly::LoggingMessageType::
|
|
44
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
45
45
|
url: 'url_example', # String | The URL to post logs to.
|
|
46
46
|
}
|
|
47
47
|
|
|
@@ -66,7 +66,7 @@ end
|
|
|
66
66
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
67
67
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
68
68
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
69
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
69
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
70
70
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
|
71
71
|
|
|
72
72
|
### Return type
|
|
@@ -218,7 +218,7 @@ opts = {
|
|
|
218
218
|
format: 'format_example', # String | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
|
|
219
219
|
log_processing_region: 'none', # String | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
|
|
220
220
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
221
|
-
message_type: Fastly::LoggingMessageType::
|
|
221
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
222
222
|
url: 'url_example', # String | The URL to post logs to.
|
|
223
223
|
}
|
|
224
224
|
|
|
@@ -244,7 +244,7 @@ end
|
|
|
244
244
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
245
245
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
246
246
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
247
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
247
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
248
248
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
|
249
249
|
|
|
250
250
|
### Return type
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/). | [optional][default to '%h %l %u %t \"%r\" %>s %b'] |
|
|
11
11
|
| **log_processing_region** | **String** | The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global. | [optional][default to 'none'] |
|
|
12
12
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
13
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
13
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
14
14
|
| **url** | **String** | The URL to post logs to. | [optional] |
|
|
15
15
|
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
16
16
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
7
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
8
8
|
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
|
|
9
9
|
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
|
|
10
10
|
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to 'null'] |
|
data/docs/LoggingSyslogApi.md
CHANGED
|
@@ -47,7 +47,7 @@ opts = {
|
|
|
47
47
|
tls_hostname: 'tls_hostname_example', # String | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.
|
|
48
48
|
address: 'address_example', # String | A hostname or IPv4 address.
|
|
49
49
|
port: 56, # Integer | The port number.
|
|
50
|
-
message_type: Fastly::LoggingMessageType::
|
|
50
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
51
51
|
hostname: 'hostname_example', # String | The hostname used for the syslog endpoint.
|
|
52
52
|
ipv4: 'ipv4_example', # String | The IPv4 address used for the syslog endpoint.
|
|
53
53
|
token: 'token_example', # String | Whether to prepend each message with a specific token.
|
|
@@ -81,7 +81,7 @@ end
|
|
|
81
81
|
| **tls_hostname** | **String** | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. | [optional][default to 'null'] |
|
|
82
82
|
| **address** | **String** | A hostname or IPv4 address. | [optional] |
|
|
83
83
|
| **port** | **Integer** | The port number. | [optional][default to 514] |
|
|
84
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
84
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
85
85
|
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
|
|
86
86
|
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
|
|
87
87
|
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to 'null'] |
|
|
@@ -242,7 +242,7 @@ opts = {
|
|
|
242
242
|
tls_hostname: 'tls_hostname_example', # String | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.
|
|
243
243
|
address: 'address_example', # String | A hostname or IPv4 address.
|
|
244
244
|
port: 56, # Integer | The port number.
|
|
245
|
-
message_type: Fastly::LoggingMessageType::
|
|
245
|
+
message_type: Fastly::LoggingMessageType::BLANK, # LoggingMessageType |
|
|
246
246
|
hostname: 'hostname_example', # String | The hostname used for the syslog endpoint.
|
|
247
247
|
ipv4: 'ipv4_example', # String | The IPv4 address used for the syslog endpoint.
|
|
248
248
|
token: 'token_example', # String | Whether to prepend each message with a specific token.
|
|
@@ -277,7 +277,7 @@ end
|
|
|
277
277
|
| **tls_hostname** | **String** | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. | [optional][default to 'null'] |
|
|
278
278
|
| **address** | **String** | A hostname or IPv4 address. | [optional] |
|
|
279
279
|
| **port** | **Integer** | The port number. | [optional][default to 514] |
|
|
280
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
280
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
281
281
|
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
|
|
282
282
|
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
|
|
283
283
|
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to 'null'] |
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
| **tls_hostname** | **String** | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. | [optional][default to 'null'] |
|
|
17
17
|
| **address** | **String** | A hostname or IPv4 address. | [optional] |
|
|
18
18
|
| **port** | **Integer** | The port number. | [optional][default to 514] |
|
|
19
|
-
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to '
|
|
19
|
+
| **message_type** | [**LoggingMessageType**](LoggingMessageType.md) | | [optional][default to 'blank'] |
|
|
20
20
|
| **hostname** | **String** | The hostname used for the syslog endpoint. | [optional] |
|
|
21
21
|
| **ipv4** | **String** | The IPv4 address used for the syslog endpoint. | [optional] |
|
|
22
22
|
| **token** | **String** | Whether to prepend each message with a specific token. | [optional][default to 'null'] |
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
|
8
|
-
| **meta** | [**
|
|
8
|
+
| **meta** | [**PaginationMeta1**](PaginationMeta1.md) | | [optional] |
|
|
9
9
|
| **data** | [**Array<MutualAuthenticationResponseData>**](MutualAuthenticationResponseData.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Fastly::NgwafAgentKeysApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::NgwafAgentKeysApi.new
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Methods
|
|
10
|
+
|
|
11
|
+
> [!NOTE]
|
|
12
|
+
> All URIs are relative to `https://api.fastly.com`
|
|
13
|
+
|
|
14
|
+
Method | HTTP request | Description
|
|
15
|
+
------ | ------------ | -----------
|
|
16
|
+
[**ngwaf_list_agent_keys**](NgwafAgentKeysApi.md#ngwaf_list_agent_keys) | **GET** /ngwaf/v1/workspaces/{workspace_id}/agent-keys | List agent keys for a workspace
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## `ngwaf_list_agent_keys()`
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
ngwaf_list_agent_keys(opts): <InlineResponse20019> # List agent keys for a workspace
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
List agent keys for a workspace.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
api_instance = Fastly::NgwafAgentKeysApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the workspace.
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# List agent keys for a workspace
|
|
37
|
+
result = api_instance.ngwaf_list_agent_keys(opts)
|
|
38
|
+
p result
|
|
39
|
+
rescue Fastly::ApiError => e
|
|
40
|
+
puts "Error when calling NgwafAgentKeysApi->ngwaf_list_agent_keys: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Options
|
|
45
|
+
|
|
46
|
+
| Name | Type | Description | Notes |
|
|
47
|
+
| ---- | ---- | ----------- | ----- |
|
|
48
|
+
| **workspace_id** | **String** | The ID of the workspace. | |
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
[**InlineResponse20019**](InlineResponse20019.md)
|
|
53
|
+
|
|
54
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
55
|
+
[[Back to README]](../../README.md)
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Fastly::NgwafSimulateApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::NgwafSimulateApi.new
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Methods
|
|
10
|
+
|
|
11
|
+
> [!NOTE]
|
|
12
|
+
> All URIs are relative to `https://api.fastly.com`
|
|
13
|
+
|
|
14
|
+
Method | HTTP request | Description
|
|
15
|
+
------ | ------------ | -----------
|
|
16
|
+
[**ngwaf_simulate_waf_request**](NgwafSimulateApi.md#ngwaf_simulate_waf_request) | **POST** /ngwaf/v1/workspaces/{workspace_id}/simulate | Simulate a WAF request
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## `ngwaf_simulate_waf_request()`
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
ngwaf_simulate_waf_request(opts): <WafSimulateResponse> # Simulate a WAF request
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Simulates a request through the workspace's WAF configuration and returns the WAF response code and any signals that would be detected. The operation is stateless — no simulation data is persisted.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
api_instance = Fastly::NgwafSimulateApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the workspace.
|
|
33
|
+
waf_simulate_request: Fastly::WafSimulateRequest.new({request: 'POST /login HTTP/1.1
|
|
34
|
+
Host: example.com
|
|
35
|
+
Content-Type: application/x-www-form-urlencoded
|
|
36
|
+
|
|
37
|
+
username=admin&password=1' OR '1'='1'}), # WafSimulateRequest |
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
# Simulate a WAF request
|
|
42
|
+
result = api_instance.ngwaf_simulate_waf_request(opts)
|
|
43
|
+
p result
|
|
44
|
+
rescue Fastly::ApiError => e
|
|
45
|
+
puts "Error when calling NgwafSimulateApi->ngwaf_simulate_waf_request: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Options
|
|
50
|
+
|
|
51
|
+
| Name | Type | Description | Notes |
|
|
52
|
+
| ---- | ---- | ----------- | ----- |
|
|
53
|
+
| **workspace_id** | **String** | The ID of the workspace. | |
|
|
54
|
+
| **waf_simulate_request** | [**WafSimulateRequest**](WafSimulateRequest.md) | | |
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
[**WafSimulateResponse**](WafSimulateResponse.md)
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
61
|
+
[[Back to README]](../../README.md)
|