fastly 18.0.0 → 18.1.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 +41 -11
- data/Gemfile.lock +4 -4
- data/README.md +4 -1
- data/docs/Backend.md +5 -0
- data/docs/BackendApi.md +20 -0
- data/docs/BackendResponse.md +5 -0
- data/docs/BotManagementApi.md +44 -2
- data/docs/BotManagementCategoryBots.md +10 -0
- data/docs/BotManagementCategoryBotsAction.md +10 -0
- data/docs/DdosProtectionRule.md +1 -0
- data/docs/DdosProtectionRuleAllOf.md +1 -0
- data/docs/DdosProtectionRuleWithStats.md +1 -0
- data/docs/HistoricalApi.md +10 -10
- data/docs/RealtimeEntryAggregated.md +2 -0
- data/docs/RealtimeEntryDatacenter.md +2 -0
- data/docs/RealtimeMeasurements.md +2 -0
- data/docs/Results.md +2 -0
- data/lib/fastly/api/backend_api.rb +38 -0
- data/lib/fastly/api/bot_management_api.rb +86 -4
- data/lib/fastly/api/bot_requests_metrics_api.rb +1 -1
- data/lib/fastly/api/domain_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/historical_api.rb +15 -15
- data/lib/fastly/api/metrics_platform_api.rb +2 -2
- data/lib/fastly/api/origin_inspector_historical_api.rb +1 -1
- data/lib/fastly/configuration.rb +6 -0
- data/lib/fastly/models/backend.rb +90 -1
- data/lib/fastly/models/backend_response.rb +90 -1
- data/lib/fastly/models/bot_management_category_bots.rb +222 -0
- data/lib/fastly/models/bot_management_category_bots_action.rb +257 -0
- data/lib/fastly/models/ddos_protection_rule.rb +12 -1
- data/lib/fastly/models/ddos_protection_rule_all_of.rb +12 -1
- data/lib/fastly/models/ddos_protection_rule_with_stats.rb +12 -1
- data/lib/fastly/models/pop.rb +6 -6
- data/lib/fastly/models/realtime_entry_aggregated.rb +24 -4
- data/lib/fastly/models/realtime_entry_datacenter.rb +24 -4
- data/lib/fastly/models/realtime_measurements.rb +24 -4
- data/lib/fastly/models/results.rb +21 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +2 -0
- data/sig.json +1 -1
- metadata +2502 -2498
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d8ff4b388cd79b648ba5fd43e8fb91641a456515a35f30431dbf540a11c4edea
|
|
4
|
+
data.tar.gz: d84012d404960aaab70e8e8a743d04451502f6412c907bf3880ecc2f8d880616
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a7254d5f28079c3726fc7da2707f81abc0fb776b080711ec69bf5e8faea9f85307b1c129583f7830d8b0b9bbe0fee59977126b233290e61d52fb02c086ce825e
|
|
7
|
+
data.tar.gz: 142cff30795d570033d0abf9607cc24fb49eedfb65b4713c1b6271a0f6693a5221ac38fee336f813558f3ec1e304c7b25b51861688990ed9f47180c48ccdfaf5
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [v18.1.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v18.1.0) (2026-11-18)
|
|
4
|
+
|
|
5
|
+
**Bug fixes:**
|
|
6
|
+
|
|
7
|
+
- fix(historical): Add the missing `anzac` value to the `region` filter.
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
**Enhancements:**
|
|
11
|
+
|
|
12
|
+
- feat(backend): Add the `iam_external_id`, `iam_product`, `iam_region`, `iam_role`, and `iam_vendor` fields, which configure IAM authentication to a storage vendor.
|
|
13
|
+
- feat(historical, realtime): Add new IAM metrics: `origin_fetch_iam_success_count` and `origin_fetch_iam_failure_count`.
|
|
14
|
+
- feat(historical): Add the `saudi_arabia` value to the `region` filter.
|
|
15
|
+
- feat(domain-inspector-historical, origin-inspector-historical, metrics-platform, bot-requests-metrics): Add the `saudi_arabia` value to the `region` filter.
|
|
16
|
+
- feat(pop): Add the `KSA-Central` region, the `saudi_arabia` stats region, and the `Saudi Arabia` billing region.
|
|
17
|
+
|
|
18
|
+
- feat(bot-management): Add the `bot-management-update-category-bots` operation (`PATCH /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots`), which sets every bot in a category to `inherit`.
|
|
19
|
+
|
|
20
|
+
- feat(ddos-protection): Add a path attribute
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
**Documentation:**
|
|
24
|
+
|
|
25
|
+
- doc(bot-management): Clarify that setting a category action keeps the actions set on individual bots, and only applies to bots set to `inherit`.
|
|
26
|
+
|
|
27
|
+
|
|
3
28
|
## [v18.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v18.0.0) (2026-10-21)
|
|
4
29
|
|
|
5
30
|
**Breaking Changes:**
|
|
@@ -11,11 +36,6 @@
|
|
|
11
36
|
- changed(products[ddos_protection]): Added `client_challenge` to the allowed `mode` values for `enable-product-ddos-protection` and `set-product-ddos-protection-configuration`.
|
|
12
37
|
|
|
13
38
|
|
|
14
|
-
**Bug fixes:**
|
|
15
|
-
|
|
16
|
-
- fix(logging_datadog): Correct `request_time_ms` in the default Datadog log format to report elapsed time in milliseconds as a number, rather than microseconds as a string.
|
|
17
|
-
|
|
18
|
-
|
|
19
39
|
**Enhancements:**
|
|
20
40
|
|
|
21
41
|
- feat(metrics-platform): Add the `get-platform-metrics-entity-historical` (`/metrics/v2/platform/entities/{entity_id}/{granularity}`) and `get-platform-metrics-aggregate-historical` (`/metrics/v2/platform/aggregate/{granularity}`) operations, with pagination, metric sets, and flexible grouping.
|
|
@@ -40,12 +60,6 @@
|
|
|
40
60
|
- feat(ai-runtime-control-usage-metrics): Add usage metrics API for AI Runtime Control, including a CSV export endpoint.
|
|
41
61
|
- feat(ai-runtime-control-sessions): Add session logs API for AI Runtime Control.
|
|
42
62
|
|
|
43
|
-
- feat(historical, realtime): Add new metric `bot_edge_requests_headless_count`, the number of edge requests where a headless bot was detected.
|
|
44
|
-
- feat(historical, realtime, domain_inspector_historical, domain_inspector_realtime): Add new metric `status_499`, the number of responses sent with status code 499 (Client Disconnected).
|
|
45
|
-
- feat(historical, realtime): Add new metrics `imgopto_input_image_bytes` and `imgopto_output_image_bytes`, describing the total image bytes before and after transformation by the Fastly Image Optimizer.
|
|
46
|
-
- feat(historical, realtime): Add new metric `arc_requests`, the number of requests received by AI Runtime Control.
|
|
47
|
-
- feat(historical, realtime): Add new DDoS protection challenge metrics: `ddos_challenge_complete_tokens_checked`, `ddos_challenge_complete_tokens_passed`, `ddos_challenge_complete_tokens_failed`, `ddos_challenge_starts`, `ddos_challenge_complete_tokens_issued`, `ddos_challenges_issued`, `ddos_challenges_succeeded`, `ddos_challenges_failed`, `ddos_challenges_pats_issued`, and `ddos_challenges_pats_succeeded`.
|
|
48
|
-
|
|
49
63
|
- feat(bot-management): Add the Bot Management API for configuring ContentGuard, covering workspace protection mode, category actions, per-bot action overrides, and a workspace-wide bot listing.
|
|
50
64
|
|
|
51
65
|
- feat(events): Add 37 `ngwaf.*` values to `event_type`, covering Next-Gen WAF workspaces, rules, lists, custom signals, redactions, virtual patches, thresholds, workspace alerts, header links, rate limited sources, custom dashboards, request reports, and agent keys.
|
|
@@ -60,6 +74,22 @@
|
|
|
60
74
|
- doc(events): Mark the `security.*` Next-Gen WAF `event_type` values as deprecated. They are no longer recorded, and are superseded by their `ngwaf.*` equivalents.
|
|
61
75
|
|
|
62
76
|
|
|
77
|
+
## [v17.2.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v17.2.0) (2026-09-27)
|
|
78
|
+
|
|
79
|
+
**Bug fixes:**
|
|
80
|
+
|
|
81
|
+
- fix(logging_datadog): Correct `request_time_ms` in the default Datadog log format to report elapsed time in milliseconds as a number, rather than microseconds as a string.
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
**Enhancements:**
|
|
85
|
+
|
|
86
|
+
- feat(historical, realtime): Add new metric `bot_edge_requests_headless_count`, the number of edge requests where a headless bot was detected.
|
|
87
|
+
- feat(historical, realtime, domain_inspector_historical, domain_inspector_realtime): Add new metric `status_499`, the number of responses sent with status code 499 (Client Disconnected).
|
|
88
|
+
- feat(historical, realtime): Add new metrics `imgopto_input_image_bytes` and `imgopto_output_image_bytes`, describing the total image bytes before and after transformation by the Fastly Image Optimizer.
|
|
89
|
+
- feat(historical, realtime): Add new metric `arc_requests`, the number of requests received by AI Runtime Control.
|
|
90
|
+
- feat(historical, realtime): Add new DDoS protection challenge metrics: `ddos_challenge_complete_tokens_checked`, `ddos_challenge_complete_tokens_passed`, `ddos_challenge_complete_tokens_failed`, `ddos_challenge_starts`, `ddos_challenge_complete_tokens_issued`, `ddos_challenges_issued`, `ddos_challenges_succeeded`, `ddos_challenges_failed`, `ddos_challenges_pats_issued`, and `ddos_challenges_pats_succeeded`.
|
|
91
|
+
|
|
92
|
+
|
|
63
93
|
## [v17.1.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v17.1.0) (2026-08-18)
|
|
64
94
|
|
|
65
95
|
**Enhancements:**
|
data/Gemfile.lock
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
fastly (18.
|
|
4
|
+
fastly (18.1.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
8
8
|
remote: https://rubygems.org/
|
|
9
9
|
specs:
|
|
10
|
-
ethon (0.
|
|
10
|
+
ethon (0.19.2)
|
|
11
11
|
ffi (>= 1.15.0)
|
|
12
12
|
logger
|
|
13
13
|
ffi (1.17.4)
|
|
@@ -15,8 +15,8 @@ GEM
|
|
|
15
15
|
ffi (1.17.4-x86_64-linux-gnu)
|
|
16
16
|
logger (1.7.0)
|
|
17
17
|
rake (13.0.6)
|
|
18
|
-
typhoeus (1.
|
|
19
|
-
ethon (>= 0.
|
|
18
|
+
typhoeus (1.7.1)
|
|
19
|
+
ethon (>= 0.19.1, < 0.20.0)
|
|
20
20
|
|
|
21
21
|
PLATFORMS
|
|
22
22
|
arm64-darwin-21
|
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', '~> 18.
|
|
11
|
+
gem 'fastly', '~> 18.1.0'
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
Then run `bundle install`.
|
|
@@ -153,6 +153,7 @@ Class | Method | Description
|
|
|
153
153
|
[*Fastly::BotManagementApi*](docs/BotManagementApi.md) | [**bot_management_list_workspaces**](docs/BotManagementApi.md#bot_management_list_workspaces) | List workspaces
|
|
154
154
|
[*Fastly::BotManagementApi*](docs/BotManagementApi.md) | [**bot_management_update_bot**](docs/BotManagementApi.md#bot_management_update_bot) | Set a bot action
|
|
155
155
|
[*Fastly::BotManagementApi*](docs/BotManagementApi.md) | [**bot_management_update_category**](docs/BotManagementApi.md#bot_management_update_category) | Set a category action
|
|
156
|
+
[*Fastly::BotManagementApi*](docs/BotManagementApi.md) | [**bot_management_update_category_bots**](docs/BotManagementApi.md#bot_management_update_category_bots) | Set the action for all bots in a category
|
|
156
157
|
[*Fastly::BotManagementApi*](docs/BotManagementApi.md) | [**bot_management_update_workspace**](docs/BotManagementApi.md#bot_management_update_workspace) | Update a workspace
|
|
157
158
|
[*Fastly::BotRequestsMetricsApi*](docs/BotRequestsMetricsApi.md) | [**get_bot_request_metrics_service_historical**](docs/BotRequestsMetricsApi.md#get_bot_request_metrics_service_historical) | Get per-service historical time series metrics for bot requests broken down by bot-type.
|
|
158
159
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
|
|
@@ -780,6 +781,8 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
|
780
781
|
- [`/iam/v1/organizations/{organization_id}/invitations/{invitation_id}/notifications`](https://www.fastly.com/documentation/reference/api/) (POST)
|
|
781
782
|
- [`/iam/v1/organizations/{organization_id}/invitations/{invitation_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
|
|
782
783
|
- [`/iam/v1/organizations/{organization_id}/invitations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
784
|
+
- [`/iam/v1/organizations/{organization_id}/memberships/{membership_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
|
785
|
+
- [`/iam/v1/organizations/{organization_id}/memberships`](https://www.fastly.com/documentation/reference/api/) (GET)
|
|
783
786
|
- [`/iam/v1/organizations/{organization_id}/options`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
|
|
784
787
|
- [`/iam/v1/organizations/{organization_id}`](https://www.fastly.com/documentation/reference/api/) (GET, PATCH)
|
|
785
788
|
- [`/model/{modelId}/invoke-with-response-stream`](https://www.fastly.com/documentation/reference/api/ai-runtime-control/gateway) (POST)
|
data/docs/Backend.md
CHANGED
|
@@ -14,6 +14,11 @@
|
|
|
14
14
|
| **fetch_timeout** | **Integer** | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`. | [optional] |
|
|
15
15
|
| **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] |
|
|
16
16
|
| **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
17
|
+
| **iam_external_id** | **String** | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set. | [optional] |
|
|
18
|
+
| **iam_product** | **String** | If the backend is using IAM authentication, the IAM signature will use this as the product element. | [optional] |
|
|
19
|
+
| **iam_region** | **String** | If the backend is using IAM authentication, this region will be used for signing and access. | [optional] |
|
|
20
|
+
| **iam_role** | **String** | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor. | [optional] |
|
|
21
|
+
| **iam_vendor** | **String** | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value. | [optional] |
|
|
17
22
|
| **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
18
23
|
| **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
19
24
|
| **keepalive_time** | **Integer** | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can. | [optional] |
|
data/docs/BackendApi.md
CHANGED
|
@@ -45,6 +45,11 @@ opts = {
|
|
|
45
45
|
fetch_timeout: 56, # Integer | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
46
46
|
healthcheck: 'healthcheck_example', # String | The name of the healthcheck to use with this backend.
|
|
47
47
|
hostname: 'hostname_example', # String | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
48
|
+
iam_external_id: 'iam_external_id_example', # String | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
49
|
+
iam_product: 'iam_product_example', # String | If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
50
|
+
iam_region: 'iam_region_example', # String | If the backend is using IAM authentication, this region will be used for signing and access.
|
|
51
|
+
iam_role: 'iam_role_example', # String | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
52
|
+
iam_vendor: 'aws', # String | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
48
53
|
ipv4: 'ipv4_example', # String | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
49
54
|
ipv6: 'ipv6_example', # String | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
50
55
|
keepalive_time: 56, # Integer | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -101,6 +106,11 @@ end
|
|
|
101
106
|
| **fetch_timeout** | **Integer** | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`. | [optional] |
|
|
102
107
|
| **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] |
|
|
103
108
|
| **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
109
|
+
| **iam_external_id** | **String** | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set. | [optional] |
|
|
110
|
+
| **iam_product** | **String** | If the backend is using IAM authentication, the IAM signature will use this as the product element. | [optional] |
|
|
111
|
+
| **iam_region** | **String** | If the backend is using IAM authentication, this region will be used for signing and access. | [optional] |
|
|
112
|
+
| **iam_role** | **String** | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor. | [optional] |
|
|
113
|
+
| **iam_vendor** | **String** | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value. | [optional] |
|
|
104
114
|
| **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
105
115
|
| **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
106
116
|
| **keepalive_time** | **Integer** | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can. | [optional] |
|
|
@@ -284,6 +294,11 @@ opts = {
|
|
|
284
294
|
fetch_timeout: 56, # Integer | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
285
295
|
healthcheck: 'healthcheck_example', # String | The name of the healthcheck to use with this backend.
|
|
286
296
|
hostname: 'hostname_example', # String | The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
297
|
+
iam_external_id: 'iam_external_id_example', # String | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
298
|
+
iam_product: 'iam_product_example', # String | If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
299
|
+
iam_region: 'iam_region_example', # String | If the backend is using IAM authentication, this region will be used for signing and access.
|
|
300
|
+
iam_role: 'iam_role_example', # String | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
301
|
+
iam_vendor: 'aws', # String | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
287
302
|
ipv4: 'ipv4_example', # String | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
288
303
|
ipv6: 'ipv6_example', # String | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
289
304
|
keepalive_time: 56, # Integer | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -341,6 +356,11 @@ end
|
|
|
341
356
|
| **fetch_timeout** | **Integer** | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`. | [optional] |
|
|
342
357
|
| **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] |
|
|
343
358
|
| **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
359
|
+
| **iam_external_id** | **String** | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set. | [optional] |
|
|
360
|
+
| **iam_product** | **String** | If the backend is using IAM authentication, the IAM signature will use this as the product element. | [optional] |
|
|
361
|
+
| **iam_region** | **String** | If the backend is using IAM authentication, this region will be used for signing and access. | [optional] |
|
|
362
|
+
| **iam_role** | **String** | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor. | [optional] |
|
|
363
|
+
| **iam_vendor** | **String** | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value. | [optional] |
|
|
344
364
|
| **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
345
365
|
| **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
346
366
|
| **keepalive_time** | **Integer** | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can. | [optional] |
|
data/docs/BackendResponse.md
CHANGED
|
@@ -14,6 +14,11 @@
|
|
|
14
14
|
| **fetch_timeout** | **Integer** | Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`. | [optional] |
|
|
15
15
|
| **healthcheck** | **String** | The name of the healthcheck to use with this backend. | [optional] |
|
|
16
16
|
| **hostname** | **String** | The hostname of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
17
|
+
| **iam_external_id** | **String** | If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set. | [optional] |
|
|
18
|
+
| **iam_product** | **String** | If the backend is using IAM authentication, the IAM signature will use this as the product element. | [optional] |
|
|
19
|
+
| **iam_region** | **String** | If the backend is using IAM authentication, this region will be used for signing and access. | [optional] |
|
|
20
|
+
| **iam_role** | **String** | If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor. | [optional] |
|
|
21
|
+
| **iam_vendor** | **String** | A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value. | [optional] |
|
|
17
22
|
| **ipv4** | **String** | IPv4 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
18
23
|
| **ipv6** | **String** | IPv6 address of the backend. May be used as an alternative to `address` to set the backend location. | [optional] |
|
|
19
24
|
| **keepalive_time** | **Integer** | How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can. | [optional] |
|
data/docs/BotManagementApi.md
CHANGED
|
@@ -22,6 +22,7 @@ Method | HTTP request | Description
|
|
|
22
22
|
[**bot_management_list_workspaces**](BotManagementApi.md#bot_management_list_workspaces) | **GET** /bot-management/v1/workspaces | List workspaces
|
|
23
23
|
[**bot_management_update_bot**](BotManagementApi.md#bot_management_update_bot) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots/{bot_id} | Set a bot action
|
|
24
24
|
[**bot_management_update_category**](BotManagementApi.md#bot_management_update_category) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id} | Set a category action
|
|
25
|
+
[**bot_management_update_category_bots**](BotManagementApi.md#bot_management_update_category_bots) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots | Set the action for all bots in a category
|
|
25
26
|
[**bot_management_update_workspace**](BotManagementApi.md#bot_management_update_workspace) | **PATCH** /bot-management/v1/workspaces/{workspace_id} | Update a workspace
|
|
26
27
|
|
|
27
28
|
|
|
@@ -189,7 +190,7 @@ end
|
|
|
189
190
|
bot_management_list_categories(opts): <BotManagementCategoriesResponse> # List categories
|
|
190
191
|
```
|
|
191
192
|
|
|
192
|
-
List all bot categories in a workspace's policy. Each category has an action that applies to every bot in the category
|
|
193
|
+
List all bot categories in a workspace's policy. Each category has an action that applies to every bot in the category that is set to `inherit`. To list the bots themselves, use [list all bots in a workspace](#bot-management-list-bots) or [list bots in a category](#bot-management-list-category-bots).
|
|
193
194
|
|
|
194
195
|
### Examples
|
|
195
196
|
|
|
@@ -357,7 +358,7 @@ end
|
|
|
357
358
|
bot_management_update_category(opts): <BotManagementCategoryResponse> # Set a category action
|
|
358
359
|
```
|
|
359
360
|
|
|
360
|
-
Set the action for a bot category.
|
|
361
|
+
Set the default action for a bot category. Bots set to `inherit` follow this action. Bots with their own action keep it. To remove every bot's own action in the category, use [set the action for all bots in a category](#bot-management-update-category-bots).
|
|
361
362
|
|
|
362
363
|
### Examples
|
|
363
364
|
|
|
@@ -390,6 +391,47 @@ end
|
|
|
390
391
|
|
|
391
392
|
[**BotManagementCategoryResponse**](BotManagementCategoryResponse.md)
|
|
392
393
|
|
|
394
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
395
|
+
[[Back to README]](../../README.md)
|
|
396
|
+
## `bot_management_update_category_bots()`
|
|
397
|
+
|
|
398
|
+
```ruby
|
|
399
|
+
bot_management_update_category_bots(opts): <BotManagementBotsResponse> # Set the action for all bots in a category
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
Set the action for every bot in a category. Setting `inherit` removes each bot's own action, so every bot follows the category's action. The category's own action is unchanged. The update applies to every bot in the category or to none, and repeating it gives the same result. The response lists every bot in the category, including bots that already inherited, and is not paginated.
|
|
403
|
+
|
|
404
|
+
### Examples
|
|
405
|
+
|
|
406
|
+
```ruby
|
|
407
|
+
api_instance = Fastly::BotManagementApi.new
|
|
408
|
+
opts = {
|
|
409
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
410
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
411
|
+
bot_management_category_bots: Fastly::BotManagementCategoryBots.new({action: Fastly::BotManagementCategoryBotsAction.new({type: 'inherit'})}), # BotManagementCategoryBots |
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
begin
|
|
415
|
+
# Set the action for all bots in a category
|
|
416
|
+
result = api_instance.bot_management_update_category_bots(opts)
|
|
417
|
+
p result
|
|
418
|
+
rescue Fastly::ApiError => e
|
|
419
|
+
puts "Error when calling BotManagementApi->bot_management_update_category_bots: #{e}"
|
|
420
|
+
end
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Options
|
|
424
|
+
|
|
425
|
+
| Name | Type | Description | Notes |
|
|
426
|
+
| ---- | ---- | ----------- | ----- |
|
|
427
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
428
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
429
|
+
| **bot_management_category_bots** | [**BotManagementCategoryBots**](BotManagementCategoryBots.md) | | |
|
|
430
|
+
|
|
431
|
+
### Return type
|
|
432
|
+
|
|
433
|
+
[**BotManagementBotsResponse**](BotManagementBotsResponse.md)
|
|
434
|
+
|
|
393
435
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
394
436
|
[[Back to README]](../../README.md)
|
|
395
437
|
## `bot_management_update_workspace()`
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryBots
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementCategoryBotsAction**](BotManagementCategoryBotsAction.md) | | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryBotsAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of action to apply. Only `inherit` is supported. | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
data/docs/DdosProtectionRule.md
CHANGED
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| **host** | **String** | Host attribute. | [optional] |
|
|
17
17
|
| **asn** | **String** | ASN attribute. | [optional] |
|
|
18
18
|
| **source_ip_prefix** | **String** | Source IP prefix attribute. | [optional] |
|
|
19
|
+
| **path** | **String** | URL path attribute. | [optional] |
|
|
19
20
|
| **additional_attributes** | **Array<String>** | Attribute category for additional, unlisted attributes used in a rule. | [optional] |
|
|
20
21
|
|
|
21
22
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **host** | **String** | Host attribute. | [optional] |
|
|
15
15
|
| **asn** | **String** | ASN attribute. | [optional] |
|
|
16
16
|
| **source_ip_prefix** | **String** | Source IP prefix attribute. | [optional] |
|
|
17
|
+
| **path** | **String** | URL path attribute. | [optional] |
|
|
17
18
|
| **additional_attributes** | **Array<String>** | Attribute category for additional, unlisted attributes used in a rule. | [optional] |
|
|
18
19
|
|
|
19
20
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| **host** | **String** | Host attribute. | [optional] |
|
|
17
17
|
| **asn** | **String** | ASN attribute. | [optional] |
|
|
18
18
|
| **source_ip_prefix** | **String** | Source IP prefix attribute. | [optional] |
|
|
19
|
+
| **path** | **String** | URL path attribute. | [optional] |
|
|
19
20
|
| **additional_attributes** | **Array<String>** | Attribute category for additional, unlisted attributes used in a rule. | [optional] |
|
|
20
21
|
| **traffic_stats** | [**DdosProtectionTrafficStats**](DdosProtectionTrafficStats.md) | | [optional] |
|
|
21
22
|
|
data/docs/HistoricalApi.md
CHANGED
|
@@ -40,7 +40,7 @@ opts = {
|
|
|
40
40
|
from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
|
|
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
|
-
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.
|
|
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. * `saudi_arabia` - Saudi Arabia.
|
|
44
44
|
datacenter: 'IAD,CHI', # String | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/).
|
|
45
45
|
services: 'services_example', # String | Limit the query to only the specified, comma-separated list of services.
|
|
46
46
|
}
|
|
@@ -61,7 +61,7 @@ end
|
|
|
61
61
|
| **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`. | [optional] |
|
|
62
62
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
63
63
|
| **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 'day'] |
|
|
64
|
-
| **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
|
+
| **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. * `saudi_arabia` - Saudi Arabia. | [optional] |
|
|
65
65
|
| **datacenter** | **String** | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/). | [optional] |
|
|
66
66
|
| **services** | **String** | Limit the query to only the specified, comma-separated list of services. | [optional] |
|
|
67
67
|
|
|
@@ -87,7 +87,7 @@ opts = {
|
|
|
87
87
|
from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
|
|
88
88
|
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`.
|
|
89
89
|
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
|
|
90
|
-
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.
|
|
90
|
+
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. * `saudi_arabia` - Saudi Arabia.
|
|
91
91
|
}
|
|
92
92
|
|
|
93
93
|
begin
|
|
@@ -106,7 +106,7 @@ end
|
|
|
106
106
|
| **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`. | [optional] |
|
|
107
107
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
108
108
|
| **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 'day'] |
|
|
109
|
-
| **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] |
|
|
109
|
+
| **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. * `saudi_arabia` - Saudi Arabia. | [optional] |
|
|
110
110
|
|
|
111
111
|
### Return type
|
|
112
112
|
|
|
@@ -131,7 +131,7 @@ opts = {
|
|
|
131
131
|
from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
|
|
132
132
|
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`.
|
|
133
133
|
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
|
|
134
|
-
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.
|
|
134
|
+
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. * `saudi_arabia` - Saudi Arabia.
|
|
135
135
|
datacenter: 'IAD,CHI', # String | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/).
|
|
136
136
|
}
|
|
137
137
|
|
|
@@ -152,7 +152,7 @@ end
|
|
|
152
152
|
| **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`. | [optional] |
|
|
153
153
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
154
154
|
| **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 'day'] |
|
|
155
|
-
| **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] |
|
|
155
|
+
| **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. * `saudi_arabia` - Saudi Arabia. | [optional] |
|
|
156
156
|
| **datacenter** | **String** | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/). | [optional] |
|
|
157
157
|
|
|
158
158
|
### Return type
|
|
@@ -178,7 +178,7 @@ opts = {
|
|
|
178
178
|
from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
|
|
179
179
|
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`.
|
|
180
180
|
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
|
|
181
|
-
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.
|
|
181
|
+
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. * `saudi_arabia` - Saudi Arabia.
|
|
182
182
|
datacenter: 'IAD,CHI', # String | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/).
|
|
183
183
|
}
|
|
184
184
|
|
|
@@ -199,7 +199,7 @@ end
|
|
|
199
199
|
| **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`. | [optional] |
|
|
200
200
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
201
201
|
| **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 'day'] |
|
|
202
|
-
| **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] |
|
|
202
|
+
| **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. * `saudi_arabia` - Saudi Arabia. | [optional] |
|
|
203
203
|
| **datacenter** | **String** | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/). | [optional] |
|
|
204
204
|
|
|
205
205
|
### Return type
|
|
@@ -226,7 +226,7 @@ opts = {
|
|
|
226
226
|
from: '2020-04-09T18:14:30Z', # String | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
|
|
227
227
|
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`.
|
|
228
228
|
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
|
|
229
|
-
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.
|
|
229
|
+
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. * `saudi_arabia` - Saudi Arabia.
|
|
230
230
|
datacenter: 'IAD,CHI', # String | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/).
|
|
231
231
|
}
|
|
232
232
|
|
|
@@ -248,7 +248,7 @@ end
|
|
|
248
248
|
| **from** | **String** | Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`. | [optional] |
|
|
249
249
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
250
250
|
| **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 'day'] |
|
|
251
|
-
| **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] |
|
|
251
|
+
| **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. * `saudi_arabia` - Saudi Arabia. | [optional] |
|
|
252
252
|
| **datacenter** | **String** | Limit query to one or more Fastly POPs. For multiple POPs use a comma-seperated list of POPs. These must be all uppercase and be valid codes. A full list of POPs can be obtained from the [POPs endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/). | [optional] |
|
|
253
253
|
|
|
254
254
|
### Return type
|
|
@@ -373,6 +373,8 @@
|
|
|
373
373
|
| **netprotect_firewall_dropped_packets** | **Integer** | Number of packets dropped by network protection firewall. | [optional] |
|
|
374
374
|
| **api_enforcement_allowed_requests_count** | **Integer** | Number of requests allowed after evaluation by the API Enforcement engine. | [optional] |
|
|
375
375
|
| **api_enforcement_flagged_requests_count** | **Integer** | Number of requests flagged after evaluation by the API Enforcement engine. | [optional] |
|
|
376
|
+
| **origin_fetch_iam_success_count** | **Integer** | Count of successful IAM authenticated backend requests. | [optional] |
|
|
377
|
+
| **origin_fetch_iam_failure_count** | **Integer** | Count of failed IAM authenticated backend requests. | [optional] |
|
|
376
378
|
|
|
377
379
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
378
380
|
|
|
@@ -373,6 +373,8 @@
|
|
|
373
373
|
| **netprotect_firewall_dropped_packets** | **Integer** | Number of packets dropped by network protection firewall. | [optional] |
|
|
374
374
|
| **api_enforcement_allowed_requests_count** | **Integer** | Number of requests allowed after evaluation by the API Enforcement engine. | [optional] |
|
|
375
375
|
| **api_enforcement_flagged_requests_count** | **Integer** | Number of requests flagged after evaluation by the API Enforcement engine. | [optional] |
|
|
376
|
+
| **origin_fetch_iam_success_count** | **Integer** | Count of successful IAM authenticated backend requests. | [optional] |
|
|
377
|
+
| **origin_fetch_iam_failure_count** | **Integer** | Count of failed IAM authenticated backend requests. | [optional] |
|
|
376
378
|
|
|
377
379
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
378
380
|
|
|
@@ -373,6 +373,8 @@
|
|
|
373
373
|
| **netprotect_firewall_dropped_packets** | **Integer** | Number of packets dropped by network protection firewall. | [optional] |
|
|
374
374
|
| **api_enforcement_allowed_requests_count** | **Integer** | Number of requests allowed after evaluation by the API Enforcement engine. | [optional] |
|
|
375
375
|
| **api_enforcement_flagged_requests_count** | **Integer** | Number of requests flagged after evaluation by the API Enforcement engine. | [optional] |
|
|
376
|
+
| **origin_fetch_iam_success_count** | **Integer** | Count of successful IAM authenticated backend requests. | [optional] |
|
|
377
|
+
| **origin_fetch_iam_failure_count** | **Integer** | Count of failed IAM authenticated backend requests. | [optional] |
|
|
376
378
|
|
|
377
379
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
378
380
|
|
data/docs/Results.md
CHANGED
|
@@ -380,6 +380,8 @@
|
|
|
380
380
|
| **netprotect_firewall_dropped_packets** | **Integer** | Number of packets dropped by network protection firewall. | [optional] |
|
|
381
381
|
| **api_enforcement_allowed_requests_count** | **Integer** | Number of requests allowed after evaluation by the API Enforcement engine. | [optional] |
|
|
382
382
|
| **api_enforcement_flagged_requests_count** | **Integer** | Number of requests flagged after evaluation by the API Enforcement engine. | [optional] |
|
|
383
|
+
| **origin_fetch_iam_success_count** | **Integer** | Count of successful IAM authenticated backend requests. | [optional] |
|
|
384
|
+
| **origin_fetch_iam_failure_count** | **Integer** | Count of failed IAM authenticated backend requests. | [optional] |
|
|
383
385
|
| **service_id** | **String** | | [optional][readonly] |
|
|
384
386
|
| **start_time** | **Integer** | Timestamp for the start of the time period being reported | [optional] |
|
|
385
387
|
|
|
@@ -31,6 +31,11 @@ module Fastly
|
|
|
31
31
|
# @option opts [Integer] :fetch_timeout Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
32
32
|
# @option opts [String] :healthcheck The name of the healthcheck to use with this backend.
|
|
33
33
|
# @option opts [String] :hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
34
|
+
# @option opts [String] :iam_external_id If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
35
|
+
# @option opts [String] :iam_product If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
36
|
+
# @option opts [String] :iam_region If the backend is using IAM authentication, this region will be used for signing and access.
|
|
37
|
+
# @option opts [String] :iam_role If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
38
|
+
# @option opts [String] :iam_vendor A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
34
39
|
# @option opts [String] :ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
35
40
|
# @option opts [String] :ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
36
41
|
# @option opts [Integer] :keepalive_time How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -80,6 +85,11 @@ module Fastly
|
|
|
80
85
|
# @option opts [Integer] :fetch_timeout Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
81
86
|
# @option opts [String] :healthcheck The name of the healthcheck to use with this backend.
|
|
82
87
|
# @option opts [String] :hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
88
|
+
# @option opts [String] :iam_external_id If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
89
|
+
# @option opts [String] :iam_product If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
90
|
+
# @option opts [String] :iam_region If the backend is using IAM authentication, this region will be used for signing and access.
|
|
91
|
+
# @option opts [String] :iam_role If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
92
|
+
# @option opts [String] :iam_vendor A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
83
93
|
# @option opts [String] :ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
84
94
|
# @option opts [String] :ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
85
95
|
# @option opts [Integer] :keepalive_time How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -125,6 +135,10 @@ module Fastly
|
|
|
125
135
|
if @api_client.config.client_side_validation && version_id.nil?
|
|
126
136
|
fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.create_backend"
|
|
127
137
|
end
|
|
138
|
+
allowable_values = ["aws"]
|
|
139
|
+
if @api_client.config.client_side_validation && opts[:'iam_vendor'] && !allowable_values.include?(opts[:'iam_vendor'])
|
|
140
|
+
fail ArgumentError, "invalid value for \"iam_vendor\", must be one of #{allowable_values}"
|
|
141
|
+
end
|
|
128
142
|
pattern = Regexp.new(/^[A-Za-z0-9]+$/)
|
|
129
143
|
if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
|
|
130
144
|
fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.create_backend, must conform to the pattern #{pattern}."
|
|
@@ -158,6 +172,11 @@ module Fastly
|
|
|
158
172
|
form_params['fetch_timeout'] = opts[:'fetch_timeout'] if !opts[:'fetch_timeout'].nil?
|
|
159
173
|
form_params['healthcheck'] = opts[:'healthcheck'] if !opts[:'healthcheck'].nil?
|
|
160
174
|
form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
|
|
175
|
+
form_params['iam_external_id'] = opts[:'iam_external_id'] if !opts[:'iam_external_id'].nil?
|
|
176
|
+
form_params['iam_product'] = opts[:'iam_product'] if !opts[:'iam_product'].nil?
|
|
177
|
+
form_params['iam_region'] = opts[:'iam_region'] if !opts[:'iam_region'].nil?
|
|
178
|
+
form_params['iam_role'] = opts[:'iam_role'] if !opts[:'iam_role'].nil?
|
|
179
|
+
form_params['iam_vendor'] = opts[:'iam_vendor'] if !opts[:'iam_vendor'].nil?
|
|
161
180
|
form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
|
|
162
181
|
form_params['ipv6'] = opts[:'ipv6'] if !opts[:'ipv6'].nil?
|
|
163
182
|
form_params['keepalive_time'] = opts[:'keepalive_time'] if !opts[:'keepalive_time'].nil?
|
|
@@ -453,6 +472,11 @@ module Fastly
|
|
|
453
472
|
# @option opts [Integer] :fetch_timeout Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
454
473
|
# @option opts [String] :healthcheck The name of the healthcheck to use with this backend.
|
|
455
474
|
# @option opts [String] :hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
475
|
+
# @option opts [String] :iam_external_id If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
476
|
+
# @option opts [String] :iam_product If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
477
|
+
# @option opts [String] :iam_region If the backend is using IAM authentication, this region will be used for signing and access.
|
|
478
|
+
# @option opts [String] :iam_role If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
479
|
+
# @option opts [String] :iam_vendor A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
456
480
|
# @option opts [String] :ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
457
481
|
# @option opts [String] :ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
458
482
|
# @option opts [Integer] :keepalive_time How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -503,6 +527,11 @@ module Fastly
|
|
|
503
527
|
# @option opts [Integer] :fetch_timeout Maximum duration in milliseconds to wait for the entire response to be received after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthetic `503` response will be presented instead. May be set at runtime using `bereq.fetch_timeout`.
|
|
504
528
|
# @option opts [String] :healthcheck The name of the healthcheck to use with this backend.
|
|
505
529
|
# @option opts [String] :hostname The hostname of the backend. May be used as an alternative to `address` to set the backend location.
|
|
530
|
+
# @option opts [String] :iam_external_id If the backend is using IAM authentication and the IAM system policy requires a matching external identifier, it should match this value. Your Fastly customer ID will be used if this attribute is not set.
|
|
531
|
+
# @option opts [String] :iam_product If the backend is using IAM authentication, the IAM signature will use this as the product element.
|
|
532
|
+
# @option opts [String] :iam_region If the backend is using IAM authentication, this region will be used for signing and access.
|
|
533
|
+
# @option opts [String] :iam_role If the backend is using IAM authentication, the fully qualified role string supplied by the storage vendor.
|
|
534
|
+
# @option opts [String] :iam_vendor A label that identifies the storage vendor. Providing a value in this field enables IAM usage, and all other IAM fields depend on its value.
|
|
506
535
|
# @option opts [String] :ipv4 IPv4 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
507
536
|
# @option opts [String] :ipv6 IPv6 address of the backend. May be used as an alternative to `address` to set the backend location.
|
|
508
537
|
# @option opts [Integer] :keepalive_time How long (in seconds) to keep a persistent connection to the backend between requests. By default, Fastly keeps connections open as long as it can.
|
|
@@ -553,6 +582,10 @@ module Fastly
|
|
|
553
582
|
if @api_client.config.client_side_validation && backend_name.nil?
|
|
554
583
|
fail ArgumentError, "Missing the required parameter 'backend_name' when calling BackendApi.update_backend"
|
|
555
584
|
end
|
|
585
|
+
allowable_values = ["aws"]
|
|
586
|
+
if @api_client.config.client_side_validation && opts[:'iam_vendor'] && !allowable_values.include?(opts[:'iam_vendor'])
|
|
587
|
+
fail ArgumentError, "invalid value for \"iam_vendor\", must be one of #{allowable_values}"
|
|
588
|
+
end
|
|
556
589
|
pattern = Regexp.new(/^[A-Za-z0-9]+$/)
|
|
557
590
|
if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
|
|
558
591
|
fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.update_backend, must conform to the pattern #{pattern}."
|
|
@@ -586,6 +619,11 @@ module Fastly
|
|
|
586
619
|
form_params['fetch_timeout'] = opts[:'fetch_timeout'] if !opts[:'fetch_timeout'].nil?
|
|
587
620
|
form_params['healthcheck'] = opts[:'healthcheck'] if !opts[:'healthcheck'].nil?
|
|
588
621
|
form_params['hostname'] = opts[:'hostname'] if !opts[:'hostname'].nil?
|
|
622
|
+
form_params['iam_external_id'] = opts[:'iam_external_id'] if !opts[:'iam_external_id'].nil?
|
|
623
|
+
form_params['iam_product'] = opts[:'iam_product'] if !opts[:'iam_product'].nil?
|
|
624
|
+
form_params['iam_region'] = opts[:'iam_region'] if !opts[:'iam_region'].nil?
|
|
625
|
+
form_params['iam_role'] = opts[:'iam_role'] if !opts[:'iam_role'].nil?
|
|
626
|
+
form_params['iam_vendor'] = opts[:'iam_vendor'] if !opts[:'iam_vendor'].nil?
|
|
589
627
|
form_params['ipv4'] = opts[:'ipv4'] if !opts[:'ipv4'].nil?
|
|
590
628
|
form_params['ipv6'] = opts[:'ipv6'] if !opts[:'ipv6'].nil?
|
|
591
629
|
form_params['keepalive_time'] = opts[:'keepalive_time'] if !opts[:'keepalive_time'].nil?
|