fastly 13.1.0 → 14.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.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +25 -0
  3. data/Gemfile.lock +4 -4
  4. data/README.md +16 -4
  5. data/docs/AttackReport.md +19 -0
  6. data/docs/AttackSignal.md +12 -0
  7. data/docs/AttackSource.md +13 -0
  8. data/docs/Backend.md +4 -4
  9. data/docs/BackendApi.md +10 -10
  10. data/docs/BackendResponse.md +4 -4
  11. data/docs/DdosProtectionApi.md +40 -0
  12. data/docs/DdosProtectionAttributeStats.md +1 -1
  13. data/docs/DdosProtectionInvalidRequest.md +13 -0
  14. data/docs/{LogTimeseriesResultDimensions.md → DdosProtectionNotAuthorized.md} +3 -2
  15. data/docs/DdosProtectionRule.md +1 -1
  16. data/docs/DdosProtectionRuleAllOf.md +1 -1
  17. data/docs/DdosProtectionRulePatch.md +10 -0
  18. data/docs/HistoricalApi.md +2 -0
  19. data/docs/KvStoreApi.md +2 -0
  20. data/docs/ListAttackReport.md +11 -0
  21. data/docs/{DdosProtectionTrafficAttribute.md → ListAttackReportMeta.md} +2 -1
  22. data/docs/{DdosProtectionAction.md → ListSignalReport.md} +2 -1
  23. data/docs/LogExplorerApi.md +1 -1
  24. data/docs/NgwafReportsApi.md +99 -0
  25. data/docs/ObservabilityTimeseriesApi.md +67 -0
  26. data/docs/PoolApi.md +4 -4
  27. data/docs/PoolResponse.md +1 -1
  28. data/docs/PoolResponseCommon.md +1 -1
  29. data/docs/PoolResponsePost.md +1 -1
  30. data/docs/SignalReport.md +13 -0
  31. data/docs/TimeseriesGetResponse.md +11 -0
  32. data/docs/TimeseriesMeta.md +13 -0
  33. data/docs/TimeseriesResult.md +11 -0
  34. data/docs/TlsSubscriptionsApi.md +0 -2
  35. data/docs/TopWorkspace.md +12 -0
  36. data/lib/fastly/api/backend_api.rb +16 -16
  37. data/lib/fastly/api/ddos_protection_api.rb +70 -0
  38. data/lib/fastly/api/historical_api.rb +3 -0
  39. data/lib/fastly/api/kv_store_api.rb +3 -0
  40. data/lib/fastly/api/ngwaf_reports_api.rb +161 -0
  41. data/lib/fastly/api/{observability_timeseries_for_logs_api.rb → observability_timeseries_api.rb} +38 -43
  42. data/lib/fastly/api/pool_api.rb +4 -4
  43. data/lib/fastly/api/tls_subscriptions_api.rb +0 -3
  44. data/lib/fastly/configuration.rb +19 -1
  45. data/lib/fastly/models/attack_report.rb +359 -0
  46. data/lib/fastly/models/attack_signal.rb +252 -0
  47. data/lib/fastly/models/attack_source.rb +267 -0
  48. data/lib/fastly/models/backend.rb +7 -1
  49. data/lib/fastly/models/backend_response.rb +7 -1
  50. data/lib/fastly/models/ddos_protection_attribute_stats.rb +2 -1
  51. data/lib/fastly/models/ddos_protection_invalid_request.rb +309 -0
  52. data/lib/fastly/models/{log_timeseries_filter_field_item.rb → ddos_protection_not_authorized.rb} +24 -36
  53. data/lib/fastly/models/ddos_protection_rule.rb +2 -1
  54. data/lib/fastly/models/ddos_protection_rule_all_of.rb +2 -1
  55. data/lib/fastly/models/ddos_protection_rule_patch.rb +219 -0
  56. data/lib/fastly/models/{log_timeseries_get_response.rb → list_attack_report.rb} +5 -5
  57. data/lib/fastly/models/list_attack_report_meta.rb +218 -0
  58. data/lib/fastly/models/{log_timeseries_result_dimensions.rb → list_signal_report.rb} +12 -10
  59. data/lib/fastly/models/pool_response.rb +1 -1
  60. data/lib/fastly/models/pool_response_common.rb +1 -1
  61. data/lib/fastly/models/pool_response_post.rb +1 -1
  62. data/lib/fastly/models/signal_report.rb +249 -0
  63. data/lib/fastly/models/{log_timeseries_get_response_meta_filters.rb → timeseries_get_response.rb} +20 -13
  64. data/lib/fastly/models/{log_timeseries_get_response_meta.rb → timeseries_meta.rb} +23 -32
  65. data/lib/fastly/models/{log_timeseries_result.rb → timeseries_result.rb} +9 -5
  66. data/lib/fastly/models/top_workspace.rb +238 -0
  67. data/lib/fastly/version.rb +1 -1
  68. data/lib/fastly.rb +16 -10
  69. data/sig.json +1 -1
  70. metadata +34 -22
  71. data/docs/LogTimeseriesFilterFieldItem.md +0 -12
  72. data/docs/LogTimeseriesGetResponse.md +0 -11
  73. data/docs/LogTimeseriesGetResponseMeta.md +0 -14
  74. data/docs/LogTimeseriesGetResponseMetaFilters.md +0 -10
  75. data/docs/LogTimeseriesResult.md +0 -11
  76. data/docs/LogTimeseriesValueField.md +0 -59
  77. data/docs/ObservabilityTimeseriesForLogsApi.md +0 -67
  78. data/lib/fastly/models/ddos_protection_action.rb +0 -37
  79. data/lib/fastly/models/ddos_protection_traffic_attribute.rb +0 -40
  80. data/lib/fastly/models/log_timeseries_value_field.rb +0 -108
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e761f5592503e975bdadc246696819f3a280b3ed2c84630f8a56d40d8025a842
4
- data.tar.gz: 4e72cf3b4dde5e55de18c655c5718ce077e01e2ff8f3715c5505f5fe9cd61d7d
3
+ metadata.gz: c523850059723241296307b84e92c95ed1c2ae29a1b589ec912cf3fd9121ca96
4
+ data.tar.gz: 28c010d89c8172abbb4990ee91b99cf05bce9b55e989f7e2ba4de113407abc87
5
5
  SHA512:
6
- metadata.gz: e9d103273612644442760c1be0bb174741377b81b9440bec4b4a0a996317e56947ebf7c8731c3d62c2e78050c7a8e14973374608de292ba49dba4ff99b40ee25
7
- data.tar.gz: bd2347c56d50c5b3fc7d0eca58e53875a7d475403f04018f627b42c0ec67d77d2a19482bbde9f511a51c1caf3645574e2c5c21331ba17d4940dfcb229e8a4b31
6
+ metadata.gz: 529046d3c876411e0eceaabddb4a82959155baab02aeab4cb331e40fafa49003e92ffa0e55731509b6109e6f387e95535a4e76a552da97ca9d8e5a8a911d7a83
7
+ data.tar.gz: bd4cfc5e243a4542889783a811518db92c90960ad51a5d401952dec20a381c82cbba2d7369d246cbd6df391870de2e69465aab1ab709d7eb3592326468557678
data/CHANGELOG.md CHANGED
@@ -1,5 +1,30 @@
1
1
  # Changelog
2
2
 
3
+ ## [v14.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v14.0.0) (2025-08-28)
4
+
5
+ **Breaking Changes:**
6
+
7
+ - removed(ddos_protection): Remove enum configs `ddos_protection_action` and ``ddos_protection_traffic_attribute`.
8
+ - changed(backend): Added default values to `tcp_keepalive_interval`, `tcp_keepalive_probes`, and `tcp_keepalive_time` properties.
9
+ - removed(tls_subscriptions): Remove `force` parameter from TLS subscriptions.
10
+
11
+
12
+ **Enhancements:**
13
+
14
+ - feat(ngwaf_reports): Add Get attacks report endpoint.
15
+ - feat(kv_store): Add `name` parameter to the List KV stores endpoint.
16
+ - feat(historical): Add `services` parameter to the Historical Stats API endpoint.
17
+ - feat(ddos_protection): Add PATCH endpoint in the Fastly DDoS Protection Events API allowing customers to update the DDoS rules action to `log`, `block`, `default`, or `off`.
18
+ - feat(observability_timeseries): Add Observability Timeseries API for data visualized in the Sustainability dashboard.
19
+
20
+
21
+ **Documentation:**
22
+
23
+ - doc(backend, pool): Describe difference in behavior of `between_bytes_timeout` between
24
+ Deliver and Compute services.
25
+ - doc(ddos_protection): Update GET API docs describing that they can be accessed by any user role as long as the service belongs to the customer.
26
+
27
+
3
28
  ## [v13.1.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v13.1.0) (2025-07-07)
4
29
 
5
30
  **Bug fixes:**
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- fastly (13.1.0)
4
+ fastly (14.0.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -10,7 +10,7 @@ GEM
10
10
  ast (2.4.2)
11
11
  byebug (11.1.3)
12
12
  coderay (1.1.3)
13
- ethon (0.16.0)
13
+ ethon (0.15.0)
14
14
  ffi (>= 1.15.0)
15
15
  ffi (1.17.2-arm64-darwin)
16
16
  ffi (1.17.2-x86_64-linux-gnu)
@@ -39,8 +39,8 @@ GEM
39
39
  unicode-display_width (>= 1.4.0, < 1.6)
40
40
  ruby-progressbar (1.11.0)
41
41
  stringio (3.0.1)
42
- typhoeus (1.4.1)
43
- ethon (>= 0.9.0)
42
+ typhoeus (1.5.0)
43
+ ethon (>= 0.9.0, < 0.16.0)
44
44
  unicode-display_width (1.5.0)
45
45
 
46
46
  PLATFORMS
data/README.md CHANGED
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
8
8
  To install via RubyGems, add the following to your project's `Gemfile`:
9
9
 
10
10
  ```ruby
11
- gem 'fastly', '~> 13.1.0'
11
+ gem 'fastly', '~> 14.0.0'
12
12
  ```
13
13
 
14
14
  Then run `bundle install`.
@@ -150,6 +150,7 @@ Class | Method | Description
150
150
  [*Fastly::DdosProtectionApi*](docs/DdosProtectionApi.md) | [**ddos_protection_event_list**](docs/DdosProtectionApi.md#ddos_protection_event_list) | Get events
151
151
  [*Fastly::DdosProtectionApi*](docs/DdosProtectionApi.md) | [**ddos_protection_event_rule_list**](docs/DdosProtectionApi.md#ddos_protection_event_rule_list) | Get all rules for an event
152
152
  [*Fastly::DdosProtectionApi*](docs/DdosProtectionApi.md) | [**ddos_protection_rule_get**](docs/DdosProtectionApi.md#ddos_protection_rule_get) | Get a rule by ID
153
+ [*Fastly::DdosProtectionApi*](docs/DdosProtectionApi.md) | [**ddos_protection_rule_patch**](docs/DdosProtectionApi.md#ddos_protection_rule_patch) | Update rule
153
154
  [*Fastly::DdosProtectionApi*](docs/DdosProtectionApi.md) | [**ddos_protection_traffic_stats_rule_get**](docs/DdosProtectionApi.md#ddos_protection_traffic_stats_rule_get) | Get traffic stats for a rule
154
155
  [*Fastly::DictionaryApi*](docs/DictionaryApi.md) | [**create_dictionary**](docs/DictionaryApi.md#create_dictionary) | Create a dictionary
155
156
  [*Fastly::DictionaryApi*](docs/DictionaryApi.md) | [**delete_dictionary**](docs/DictionaryApi.md#delete_dictionary) | Delete a dictionary
@@ -405,6 +406,8 @@ Class | Method | Description
405
406
  [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
406
407
  [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
407
408
  [*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
409
+ [*Fastly::NgwafReportsApi*](docs/NgwafReportsApi.md) | [**get_attacks_report**](docs/NgwafReportsApi.md#get_attacks_report) | Get attacks report
410
+ [*Fastly::NgwafReportsApi*](docs/NgwafReportsApi.md) | [**get_signals_report**](docs/NgwafReportsApi.md#get_signals_report) | Get signals report
408
411
  [*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**create_access_key**](docs/ObjectStorageAccessKeysApi.md#create_access_key) | Create an access key
409
412
  [*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**delete_access_key**](docs/ObjectStorageAccessKeysApi.md#delete_access_key) | Delete an access key
410
413
  [*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**get_access_key**](docs/ObjectStorageAccessKeysApi.md#get_access_key) | Get an access key
@@ -415,7 +418,7 @@ Class | Method | Description
415
418
  [*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
416
419
  [*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**list_dashboards**](docs/ObservabilityCustomDashboardsApi.md#list_dashboards) | List all custom dashboards
417
420
  [*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**update_dashboard**](docs/ObservabilityCustomDashboardsApi.md#update_dashboard) | Update an existing dashboard
418
- [*Fastly::ObservabilityTimeseriesForLogsApi*](docs/ObservabilityTimeseriesForLogsApi.md) | [**log_timeseries_get**](docs/ObservabilityTimeseriesForLogsApi.md#log_timeseries_get) | Retrieve log data as time series
421
+ [*Fastly::ObservabilityTimeseriesApi*](docs/ObservabilityTimeseriesApi.md) | [**timeseries_get**](docs/ObservabilityTimeseriesApi.md#timeseries_get) | Retrieve observability data as a time series
419
422
  [*Fastly::OriginInspectorHistoricalApi*](docs/OriginInspectorHistoricalApi.md) | [**get_origin_inspector_historical**](docs/OriginInspectorHistoricalApi.md#get_origin_inspector_historical) | Get historical origin data for a service
420
423
  [*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**get_origin_inspector_last120_seconds**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last120_seconds) | Get real-time origin data for the last 120 seconds
421
424
  [*Fastly::OriginInspectorRealtimeApi*](docs/OriginInspectorRealtimeApi.md) | [**get_origin_inspector_last_max_entries**](docs/OriginInspectorRealtimeApi.md#get_origin_inspector_last_max_entries) | Get a limited number of real-time origin data entries
@@ -640,10 +643,17 @@ The fastly-ruby API client currently does not support the following endpoints:
640
643
  - [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
641
644
  - [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
642
645
  - [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
646
+ - [`/domain-management/v1/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
647
+ - [`/domain-management/v1/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
643
648
  - [`/domains/v1/tools/status`](https://www.fastly.com/documentation/reference/api/) (GET)
644
649
  - [`/domains/v1/tools/suggest`](https://www.fastly.com/documentation/reference/api/) (GET)
645
- - [`/domains/v1/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
646
- - [`/domains/v1`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
650
+ - [`/ngwaf/v1/lists/{listId}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/lists) (DELETE, GET, PATCH)
651
+ - [`/ngwaf/v1/lists`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/lists) (GET, POST)
652
+ - [`/ngwaf/v1/signals/{signal_id}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/signals) (DELETE, GET, PATCH)
653
+ - [`/ngwaf/v1/signals`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/signals) (GET, POST)
654
+ - [`/ngwaf/v1/timeseries`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/timeseries) (GET)
655
+ - [`/ngwaf/v1/workspaces/{workspaceId}/lists/{listId}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/lists) (DELETE, GET, PATCH)
656
+ - [`/ngwaf/v1/workspaces/{workspaceId}/lists`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/lists) (GET, POST)
647
657
  - [`/ngwaf/v1/workspaces/{workspace_id}/alerts/{alert_id}/signing-key`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/workspace_alerts) (GET, POST)
648
658
  - [`/ngwaf/v1/workspaces/{workspace_id}/alerts/{alert_id}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/workspace_alerts) (DELETE, GET, PATCH)
649
659
  - [`/ngwaf/v1/workspaces/{workspace_id}/alerts`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/workspace_alerts) (GET, POST)
@@ -666,6 +676,8 @@ The fastly-ruby API client currently does not support the following endpoints:
666
676
  - [`/notifications/integrations/{integration_id}`](https://developer.fastly.com/reference/api/observability/notification) (DELETE, GET, PATCH)
667
677
  - [`/notifications/integrations`](https://developer.fastly.com/reference/api/observability/notification) (GET, POST)
668
678
  - [`/notifications/mailinglist-confirmations`](https://developer.fastly.com/reference/api/observability/notification) (POST)
679
+ - [`/observability/timeseries`](https://www.fastly.com/documentation/reference/api/observability/timeseries/logs/) (GET)
680
+ - [`/observability/timeseries`](https://www.fastly.com/documentation/reference/api/observability/timeseries/sustainability/) (GET)
669
681
  - [`/resources/stores/kv/{store_id}/batch`](https://www.fastly.com/documentation/reference/api/services/resources/kv-store-item) (PUT)
670
682
  - [`/security/workspaces/{workspace_id}/events/{event_id}`](https://www.fastly.com/documentation/reference/api/security/events) (GET, PATCH)
671
683
  - [`/security/workspaces/{workspace_id}/events`](https://www.fastly.com/documentation/reference/api/security/events) (GET)
@@ -0,0 +1,19 @@
1
+ # Fastly::AttackReport
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | ID of the workspace. | |
8
+ | **name** | **String** | Name of the workspace. | |
9
+ | **total_count** | **Integer** | Total request count | |
10
+ | **blocked_count** | **Integer** | Blocked request count | |
11
+ | **flagged_count** | **Integer** | Flagged request count | |
12
+ | **attack_count** | **Integer** | Attack request count | |
13
+ | **all_flagged_ip_count** | **Integer** | Count of IPs that have been flagged | |
14
+ | **flagged_ip_count** | **Integer** | Count of currently flagged IPs | |
15
+ | **top_attack_signals** | [**Array&lt;AttackSignal&gt;**](AttackSignal.md) | | |
16
+ | **top_attack_sources** | [**Array&lt;AttackSource&gt;**](AttackSource.md) | | |
17
+
18
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
19
+
@@ -0,0 +1,12 @@
1
+ # Fastly::AttackSignal
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **tag_name** | **String** | Name of the attack signal tag | |
8
+ | **tag_count** | **Integer** | Count of requests with this attack signal | |
9
+ | **total_count** | **Integer** | Total number of attacks considered | |
10
+
11
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
12
+
@@ -0,0 +1,13 @@
1
+ # Fastly::AttackSource
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **country_code** | **String** | Country code of the attack source | |
8
+ | **country_name** | **String** | Name of the country | |
9
+ | **request_count** | **Integer** | Number of requests from this country | |
10
+ | **total_count** | **Integer** | Total number of attacks considered | |
11
+
12
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
+
data/docs/Backend.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **address** | **String** | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. | [optional] |
8
8
  | **auto_loadbalance** | **Boolean** | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don&#39;t have a `request_condition` will be selected based on their `weight`. | [optional] |
9
- | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
9
+ | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
10
10
  | **client_cert** | **String** | Unused. | [optional] |
11
11
  | **comment** | **String** | A freeform descriptive note. | [optional] |
12
12
  | **connect_timeout** | **Integer** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] |
@@ -35,9 +35,9 @@
35
35
  | **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
36
36
  | **ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] |
37
37
  | **tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] |
38
- | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional] |
39
- | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional] |
40
- | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] |
38
+ | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional][default to 10] |
39
+ | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional][default to 3] |
40
+ | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional][default to 300] |
41
41
  | **use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional] |
42
42
  | **weight** | **Integer** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional] |
43
43
 
data/docs/BackendApi.md CHANGED
@@ -37,7 +37,7 @@ opts = {
37
37
  version_id: 56, # Integer | Integer identifying a service version.
38
38
  address: 'address_example', # String | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
39
39
  auto_loadbalance: true, # Boolean | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`.
40
- between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.
40
+ between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`.
41
41
  client_cert: 'client_cert_example', # String | Unused.
42
42
  comment: 'comment_example', # String | A freeform descriptive note.
43
43
  connect_timeout: 56, # Integer | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
@@ -90,7 +90,7 @@ end
90
90
  | **version_id** | **Integer** | Integer identifying a service version. | |
91
91
  | **address** | **String** | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. | [optional] |
92
92
  | **auto_loadbalance** | **Boolean** | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don&#39;t have a `request_condition` will be selected based on their `weight`. | [optional] |
93
- | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
93
+ | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
94
94
  | **client_cert** | **String** | Unused. | [optional] |
95
95
  | **comment** | **String** | A freeform descriptive note. | [optional] |
96
96
  | **connect_timeout** | **Integer** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] |
@@ -119,9 +119,9 @@ end
119
119
  | **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
120
120
  | **ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] |
121
121
  | **tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] |
122
- | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional] |
123
- | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional] |
124
- | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] |
122
+ | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional][default to 10] |
123
+ | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional][default to 3] |
124
+ | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional][default to 300] |
125
125
  | **use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional] |
126
126
  | **weight** | **Integer** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional] |
127
127
 
@@ -270,7 +270,7 @@ opts = {
270
270
  backend_name: 'backend_name_example', # String | The name of the backend.
271
271
  address: 'address_example', # String | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend.
272
272
  auto_loadbalance: true, # Boolean | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a `request_condition` will be selected based on their `weight`.
273
- between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`.
273
+ between_bytes_timeout: 56, # Integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`.
274
274
  client_cert: 'client_cert_example', # String | Unused.
275
275
  comment: 'comment_example', # String | A freeform descriptive note.
276
276
  connect_timeout: 56, # Integer | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`.
@@ -324,7 +324,7 @@ end
324
324
  | **backend_name** | **String** | The name of the backend. | |
325
325
  | **address** | **String** | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. | [optional] |
326
326
  | **auto_loadbalance** | **Boolean** | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don&#39;t have a `request_condition` will be selected based on their `weight`. | [optional] |
327
- | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
327
+ | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
328
328
  | **client_cert** | **String** | Unused. | [optional] |
329
329
  | **comment** | **String** | A freeform descriptive note. | [optional] |
330
330
  | **connect_timeout** | **Integer** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] |
@@ -353,9 +353,9 @@ end
353
353
  | **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
354
354
  | **ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] |
355
355
  | **tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] |
356
- | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional] |
357
- | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional] |
358
- | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] |
356
+ | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional][default to 10] |
357
+ | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional][default to 3] |
358
+ | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional][default to 300] |
359
359
  | **use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional] |
360
360
  | **weight** | **Integer** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional] |
361
361
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **address** | **String** | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. | [optional] |
8
8
  | **auto_loadbalance** | **Boolean** | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don&#39;t have a `request_condition` will be selected based on their `weight`. | [optional] |
9
- | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
9
+ | **between_bytes_timeout** | **Integer** | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, for Delivery services, the response received so far will be considered complete and the fetch will end. For Compute services, timeout expiration is treated as a failure of the backend connection, and an error is generated. May be set at runtime using `bereq.between_bytes_timeout`. | [optional] |
10
10
  | **client_cert** | **String** | Unused. | [optional] |
11
11
  | **comment** | **String** | A freeform descriptive note. | [optional] |
12
12
  | **connect_timeout** | **Integer** | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.connect_timeout`. | [optional] |
@@ -35,9 +35,9 @@
35
35
  | **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
36
36
  | **ssl_sni_hostname** | **String** | Overrides `ssl_hostname`, but only for SNI in the handshake. Does not affect cert validation at all. | [optional] |
37
37
  | **tcp_keepalive_enable** | **Boolean** | Whether to enable TCP keepalives for backend connections. Varnish defaults to using keepalives if this is unspecified. | [optional] |
38
- | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional] |
39
- | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional] |
40
- | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional] |
38
+ | **tcp_keepalive_interval** | **Integer** | Interval in seconds between subsequent keepalive probes. | [optional][default to 10] |
39
+ | **tcp_keepalive_probes** | **Integer** | Number of unacknowledged probes to send before considering the connection dead. | [optional][default to 3] |
40
+ | **tcp_keepalive_time** | **Integer** | Interval in seconds between the last data packet sent and the first keepalive probe. | [optional][default to 300] |
41
41
  | **use_ssl** | **Boolean** | Whether or not to require TLS for connections to this backend. | [optional] |
42
42
  | **weight** | **Integer** | Weight used to load balance this backend against others. May be any positive integer. If `auto_loadbalance` is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have `auto_loadbalance` set to true. | [optional] |
43
43
  | **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
@@ -17,6 +17,7 @@ Method | HTTP request | Description
17
17
  [**ddos_protection_event_list**](DdosProtectionApi.md#ddos_protection_event_list) | **GET** /ddos-protection/v1/events | Get events
18
18
  [**ddos_protection_event_rule_list**](DdosProtectionApi.md#ddos_protection_event_rule_list) | **GET** /ddos-protection/v1/events/{event_id}/rules | Get all rules for an event
19
19
  [**ddos_protection_rule_get**](DdosProtectionApi.md#ddos_protection_rule_get) | **GET** /ddos-protection/v1/rules/{rule_id} | Get a rule by ID
20
+ [**ddos_protection_rule_patch**](DdosProtectionApi.md#ddos_protection_rule_patch) | **PATCH** /ddos-protection/v1/rules/{rule_id} | Update rule
20
21
  [**ddos_protection_traffic_stats_rule_get**](DdosProtectionApi.md#ddos_protection_traffic_stats_rule_get) | **GET** /ddos-protection/v1/events/{event_id}/rules/{rule_id}/traffic-stats | Get traffic stats for a rule
21
22
 
22
23
 
@@ -180,6 +181,45 @@ end
180
181
 
181
182
  [**DdosProtectionRule**](DdosProtectionRule.md)
182
183
 
184
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
185
+ [[Back to README]](../../README.md)
186
+ ## `ddos_protection_rule_patch()`
187
+
188
+ ```ruby
189
+ ddos_protection_rule_patch(opts): <DdosProtectionRule> # Update rule
190
+ ```
191
+
192
+ Update rule.
193
+
194
+ ### Examples
195
+
196
+ ```ruby
197
+ api_instance = Fastly::DdosProtectionApi.new
198
+ opts = {
199
+ rule_id: 'rule_id_example', # String | Unique ID of the rule.
200
+ ddos_protection_rule_patch: Fastly::DdosProtectionRulePatch.new, # DdosProtectionRulePatch |
201
+ }
202
+
203
+ begin
204
+ # Update rule
205
+ result = api_instance.ddos_protection_rule_patch(opts)
206
+ p result
207
+ rescue Fastly::ApiError => e
208
+ puts "Error when calling DdosProtectionApi->ddos_protection_rule_patch: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Options
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **rule_id** | **String** | Unique ID of the rule. | |
217
+ | **ddos_protection_rule_patch** | [**DdosProtectionRulePatch**](DdosProtectionRulePatch.md) | | [optional] |
218
+
219
+ ### Return type
220
+
221
+ [**DdosProtectionRule**](DdosProtectionRule.md)
222
+
183
223
  [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
184
224
  [[Back to README]](../../README.md)
185
225
  ## `ddos_protection_traffic_stats_rule_get()`
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **name** | [**DdosProtectionTrafficAttribute**](DdosProtectionTrafficAttribute.md) | | [optional] |
7
+ | **name** | **String** | Name of an attribute type used in traffic stats. Currently, supported values are source_ip, country_code, host, asn, source_ip_prefix, user_agent, method_path. | [optional] |
8
8
  | **values** | [**Array&lt;DdosProtectionAttributeValue&gt;**](DdosProtectionAttributeValue.md) | Values for traffic attribute. | [optional] |
9
9
 
10
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
@@ -0,0 +1,13 @@
1
+ # Fastly::DdosProtectionInvalidRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **title** | **String** | | |
8
+ | **status** | **Integer** | | |
9
+ | **detail** | **String** | | |
10
+ | **errors** | [**Array&lt;DdosProtectionErrorErrors&gt;**](DdosProtectionErrorErrors.md) | | |
11
+
12
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
13
+
@@ -1,10 +1,11 @@
1
- # Fastly::LogTimeseriesResultDimensions
1
+ # Fastly::DdosProtectionNotAuthorized
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **time** | **String** | | [optional] |
7
+ | **title** | **String** | | [optional] |
8
+ | **status** | **Integer** | | [optional] |
8
9
 
9
10
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
11
 
@@ -8,7 +8,7 @@
8
8
  | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
9
9
  | **id** | **String** | Unique ID of the rule. | [optional] |
10
10
  | **name** | **String** | A human-readable name for the rule. | [optional] |
11
- | **action** | [**DdosProtectionAction**](DdosProtectionAction.md) | | [optional][default to &#39;default&#39;] |
11
+ | **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to &#39;default&#39;] |
12
12
  | **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
13
13
  | **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
14
14
  | **source_ip** | **String** | Source IP address attribute. | [optional] |
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | Unique ID of the rule. | [optional] |
8
8
  | **name** | **String** | A human-readable name for the rule. | [optional] |
9
- | **action** | [**DdosProtectionAction**](DdosProtectionAction.md) | | [optional][default to &#39;default&#39;] |
9
+ | **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to &#39;default&#39;] |
10
10
  | **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
11
11
  | **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
12
12
  | **source_ip** | **String** | Source IP address attribute. | [optional] |
@@ -0,0 +1,10 @@
1
+ # Fastly::DdosProtectionRulePatch
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to &#39;default&#39;] |
8
+
9
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10
+
@@ -41,6 +41,7 @@ opts = {
41
41
  to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
42
42
  by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
43
43
  region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `mexico` - Mexico. * `southamerica_std` - South America.
44
+ services: 'services_example', # String | Limit the query to only the specified, comma-separated list of services.
44
45
  }
45
46
 
46
47
  begin
@@ -60,6 +61,7 @@ end
60
61
  | **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to &#39;now&#39;] |
61
62
  | **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to &#39;day&#39;] |
62
63
  | **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `mexico` - Mexico. * `southamerica_std` - South America. | [optional] |
64
+ | **services** | **String** | Limit the query to only the specified, comma-separated list of services. | [optional] |
63
65
 
64
66
  ### Return type
65
67
 
data/docs/KvStoreApi.md CHANGED
@@ -146,6 +146,7 @@ api_instance = Fastly::KvStoreApi.new
146
146
  opts = {
147
147
  cursor: 'cursor_example', # String |
148
148
  limit: 56, # Integer |
149
+ name: 'name_example', # String | Returns a one-element array containing the details for the named KV store.
149
150
  }
150
151
 
151
152
  begin
@@ -163,6 +164,7 @@ end
163
164
  | ---- | ---- | ----------- | ----- |
164
165
  | **cursor** | **String** | | [optional] |
165
166
  | **limit** | **Integer** | | [optional][default to 1000] |
167
+ | **name** | **String** | Returns a one-element array containing the details for the named KV store. | [optional] |
166
168
 
167
169
  ### Return type
168
170
 
@@ -0,0 +1,11 @@
1
+ # Fastly::ListAttackReport
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;AttackReport&gt;**](AttackReport.md) | | [optional] |
8
+ | **meta** | [**ListAttackReportMeta**](ListAttackReportMeta.md) | | [optional] |
9
+
10
+ [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
11
+
@@ -1,9 +1,10 @@
1
- # Fastly::DdosProtectionTrafficAttribute
1
+ # Fastly::ListAttackReportMeta
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | The count of attack reports matching the filter. | [optional] |
7
8
 
8
9
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
9
10
 
@@ -1,9 +1,10 @@
1
- # Fastly::DdosProtectionAction
1
+ # Fastly::ListSignalReport
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;SignalReport&gt;**](SignalReport.md) | | [optional] |
7
8
 
8
9
  [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
9
10
 
@@ -29,7 +29,7 @@ Retrieves log records.
29
29
  ```ruby
30
30
  api_instance = Fastly::LogExplorerApi.new
31
31
  opts = {
32
- service_id: 'service_id_example', # String |
32
+ service_id: '1jlmtMz1ncwA0KC3TBGD0X', # String |
33
33
  start: 'start_example', # String |
34
34
  _end: '_end_example', # String |
35
35
  limit: 8.14, # Float |
@@ -0,0 +1,99 @@
1
+ # Fastly::NgwafReportsApi
2
+
3
+
4
+ ```ruby
5
+ require 'fastly'
6
+ api_instance = Fastly::NgwafReportsApi.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
+ [**get_attacks_report**](NgwafReportsApi.md#get_attacks_report) | **GET** /ngwaf/v1/reports/attacks | Get attacks report
17
+ [**get_signals_report**](NgwafReportsApi.md#get_signals_report) | **GET** /ngwaf/v1/reports/signals | Get signals report
18
+
19
+
20
+ ## `get_attacks_report()`
21
+
22
+ ```ruby
23
+ get_attacks_report(opts): <ListAttackReport> # Get attacks report
24
+ ```
25
+
26
+ Get attacks report
27
+
28
+ ### Examples
29
+
30
+ ```ruby
31
+ api_instance = Fastly::NgwafReportsApi.new
32
+ opts = {
33
+ from: Time.parse('2019-08-20T18:07:33Z'), # Time | The start of a time range in RFC 3339 format.
34
+ to: Time.parse('2019-08-21T18:07:33Z'), # Time | The end of a time range in RFC 3339 format. Defaults to the current time.
35
+ }
36
+
37
+ begin
38
+ # Get attacks report
39
+ result = api_instance.get_attacks_report(opts)
40
+ p result
41
+ rescue Fastly::ApiError => e
42
+ puts "Error when calling NgwafReportsApi->get_attacks_report: #{e}"
43
+ end
44
+ ```
45
+
46
+ ### Options
47
+
48
+ | Name | Type | Description | Notes |
49
+ | ---- | ---- | ----------- | ----- |
50
+ | **from** | **Time** | The start of a time range in RFC 3339 format. | |
51
+ | **to** | **Time** | The end of a time range in RFC 3339 format. Defaults to the current time. | [optional] |
52
+
53
+ ### Return type
54
+
55
+ [**ListAttackReport**](ListAttackReport.md)
56
+
57
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
58
+ [[Back to README]](../../README.md)
59
+ ## `get_signals_report()`
60
+
61
+ ```ruby
62
+ get_signals_report(opts): <ListSignalReport> # Get signals report
63
+ ```
64
+
65
+ Get signals report
66
+
67
+ ### Examples
68
+
69
+ ```ruby
70
+ api_instance = Fastly::NgwafReportsApi.new
71
+ opts = {
72
+ from: Time.parse('2019-08-20T18:07:33Z'), # Time | The start of a time range in RFC 3339 format.
73
+ to: Time.parse('2019-08-21T18:07:33Z'), # Time | The end of a time range in RFC 3339 format. Defaults to the current time.
74
+ signal_type: 'account', # String | The type of signal
75
+ }
76
+
77
+ begin
78
+ # Get signals report
79
+ result = api_instance.get_signals_report(opts)
80
+ p result
81
+ rescue Fastly::ApiError => e
82
+ puts "Error when calling NgwafReportsApi->get_signals_report: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Options
87
+
88
+ | Name | Type | Description | Notes |
89
+ | ---- | ---- | ----------- | ----- |
90
+ | **from** | **Time** | The start of a time range in RFC 3339 format. | |
91
+ | **to** | **Time** | The end of a time range in RFC 3339 format. Defaults to the current time. | [optional] |
92
+ | **signal_type** | **String** | The type of signal | [optional] |
93
+
94
+ ### Return type
95
+
96
+ [**ListSignalReport**](ListSignalReport.md)
97
+
98
+ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
99
+ [[Back to README]](../../README.md)