fastly 15.0.0 → 16.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +40 -1
- data/Gemfile.lock +3 -3
- data/README.md +32 -3
- data/docs/ApisecurityOperationsApi.md +465 -0
- data/docs/AutomationTokensApi.md +2 -2
- data/docs/Backend.md +1 -0
- data/docs/BackendApi.md +4 -0
- data/docs/BackendResponse.md +1 -0
- data/docs/DdosProtectionApi.md +4 -4
- data/docs/DdosProtectionEvent.md +2 -0
- data/docs/DdosProtectionEventAllOf.md +2 -0
- data/docs/DdosProtectionRequestEnableMode.md +10 -0
- data/docs/DiscoveredOperationBase.md +12 -0
- data/docs/DiscoveredOperationGet.md +15 -0
- data/docs/DiscoveredOperationGetExtra.md +12 -0
- data/docs/DmDomainsApi.md +2 -2
- data/docs/DomainInspectorHistoricalApi.md +1 -1
- data/docs/DomainInspectorMeasurements.md +63 -0
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/DomainResearchApi.md +103 -0
- data/docs/DomainResearchResponseBodyEnable.md +12 -0
- data/docs/DomainResearchResponseCustomer.md +10 -0
- data/docs/DomainResearchResponseLinks.md +10 -0
- data/docs/DomainResearchResponseLinksLinks.md +10 -0
- data/docs/DomainResearchResponseProduct.md +10 -0
- data/docs/DomainResearchResponseProductProduct.md +11 -0
- data/docs/HistoricalApi.md +8 -0
- data/docs/HistoricalMeta.md +1 -0
- data/docs/IamV1RoleResponse.md +1 -0
- data/docs/InlineResponse2001.md +2 -1
- data/docs/InlineResponse20010.md +2 -1
- data/docs/InlineResponse20011.md +11 -0
- data/docs/InlineResponse20012.md +11 -0
- data/docs/InlineResponse20013.md +11 -0
- data/docs/InlineResponse20014.md +10 -0
- data/docs/InlineResponse2002.md +2 -2
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse2004.md +1 -2
- data/docs/InlineResponse2005.md +2 -1
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +1 -2
- data/docs/InlineResponse2009.md +1 -2
- data/docs/InsightsApi.md +3 -3
- data/docs/KvStoreApi.md +43 -4
- data/docs/KvStoreDetails.md +2 -0
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/{KvStoreRequestCreate.md → KvStoreRequestCreateOrUpdate.md} +1 -1
- data/docs/LogInsights.md +1 -1
- data/docs/Meta.md +11 -0
- data/docs/MetricsPlatformApi.md +75 -0
- data/docs/NgwafRequestEnable.md +1 -0
- data/docs/Offer.md +12 -0
- data/docs/OfferAllOf.md +12 -0
- data/docs/OperationBase.md +14 -0
- data/docs/OperationCreate.md +14 -0
- data/docs/OperationGet.md +18 -0
- data/docs/OperationGetExtra.md +13 -0
- data/docs/OperationUpdate.md +14 -0
- data/docs/OriginInspectorHistoricalApi.md +1 -1
- data/docs/PackageMetadata.md +2 -2
- data/docs/PlatformMetadata.md +14 -0
- data/docs/PlatformMetricsResponse.md +11 -0
- data/docs/PlatformValues.md +25 -0
- data/docs/ProductDdosProtectionApi.md +3 -1
- data/docs/ProductDomainResearchApi.md +115 -0
- data/docs/RealtimeEntryAggregated.md +25 -0
- data/docs/RealtimeMeasurements.md +25 -0
- data/docs/Results.md +25 -0
- data/docs/SecretStoreApi.md +2 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/ServiceAuthorizationsApi.md +2 -2
- data/docs/Status.md +15 -0
- data/docs/StatusAllOf.md +15 -0
- data/docs/Suggestion.md +13 -0
- data/docs/SuggestionAllOf.md +13 -0
- data/docs/TagBase.md +11 -0
- data/docs/TagCreate.md +11 -0
- data/docs/TagGet.md +15 -0
- data/docs/TagGetExtra.md +13 -0
- data/docs/Values.md +63 -0
- data/lib/fastly/api/apisecurity_operations_api.rb +829 -0
- data/lib/fastly/api/automation_tokens_api.rb +3 -3
- data/lib/fastly/api/backend_api.rb +6 -0
- data/lib/fastly/api/ddos_protection_api.rb +6 -6
- data/lib/fastly/api/dm_domains_api.rb +3 -3
- data/lib/fastly/api/domain_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/domain_research_api.rb +163 -0
- data/lib/fastly/api/historical_api.rb +12 -0
- data/lib/fastly/api/kv_store_api.rb +74 -6
- data/lib/fastly/api/kv_store_item_api.rb +3 -3
- data/lib/fastly/api/metrics_platform_api.rb +134 -0
- data/lib/fastly/api/origin_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/product_ddos_protection_api.rb +10 -3
- data/lib/fastly/api/product_domain_research_api.rb +186 -0
- data/lib/fastly/api/secret_store_api.rb +3 -3
- data/lib/fastly/api/secret_store_item_api.rb +3 -3
- data/lib/fastly/api/service_authorizations_api.rb +3 -3
- data/lib/fastly/configuration.rb +108 -0
- data/lib/fastly/models/backend.rb +11 -1
- data/lib/fastly/models/backend_response.rb +11 -1
- data/lib/fastly/models/ddos_protection_event.rb +21 -1
- data/lib/fastly/models/ddos_protection_event_all_of.rb +21 -1
- data/lib/fastly/models/ddos_protection_request_enable_mode.rb +251 -0
- data/lib/fastly/models/discovered_operation_base.rb +271 -0
- data/lib/fastly/models/discovered_operation_get.rb +336 -0
- data/lib/fastly/models/discovered_operation_get_extra.rb +271 -0
- data/lib/fastly/models/domain_inspector_measurements.rb +634 -4
- data/lib/fastly/models/domain_research_response_body_enable.rb +243 -0
- data/lib/fastly/models/domain_research_response_customer.rb +216 -0
- data/lib/fastly/models/domain_research_response_links.rb +216 -0
- data/lib/fastly/models/domain_research_response_links_links.rb +217 -0
- data/lib/fastly/models/domain_research_response_product.rb +216 -0
- data/lib/fastly/models/domain_research_response_product_product.rb +227 -0
- data/lib/fastly/models/historical_meta.rb +13 -4
- data/lib/fastly/models/iam_v1_role_response.rb +10 -1
- data/lib/fastly/models/inline_response2001.rb +12 -3
- data/lib/fastly/models/inline_response20010.rb +13 -4
- data/lib/fastly/models/inline_response20011.rb +227 -0
- data/lib/fastly/models/inline_response20012.rb +227 -0
- data/lib/fastly/models/inline_response20013.rb +227 -0
- data/lib/fastly/models/inline_response20014.rb +218 -0
- data/lib/fastly/models/inline_response2002.rb +14 -13
- data/lib/fastly/models/inline_response2003.rb +14 -23
- data/lib/fastly/models/inline_response2004.rb +5 -15
- data/lib/fastly/models/inline_response2005.rb +18 -8
- data/lib/fastly/models/inline_response2006.rb +11 -1
- data/lib/fastly/models/inline_response2007.rb +4 -2
- data/lib/fastly/models/inline_response2008.rb +8 -18
- data/lib/fastly/models/inline_response2009.rb +8 -17
- data/lib/fastly/models/kv_store_details.rb +24 -4
- data/lib/fastly/models/{kv_store_request_create.rb → kv_store_request_create_or_update.rb} +3 -3
- data/lib/fastly/models/log_insights.rb +4 -2
- data/lib/fastly/models/meta.rb +266 -0
- data/lib/fastly/models/ngwaf_request_enable.rb +14 -4
- data/lib/fastly/models/offer.rb +245 -0
- data/lib/fastly/models/offer_all_of.rb +237 -0
- data/lib/fastly/models/operation_base.rb +308 -0
- data/lib/fastly/models/operation_create.rb +315 -0
- data/lib/fastly/models/operation_get.rb +381 -0
- data/lib/fastly/models/operation_get_extra.rb +257 -0
- data/lib/fastly/models/operation_update.rb +308 -0
- data/lib/fastly/models/package_metadata.rb +2 -2
- data/lib/fastly/models/platform_metadata.rb +258 -0
- data/lib/fastly/models/platform_metrics_response.rb +228 -0
- data/lib/fastly/models/platform_values.rb +368 -0
- data/lib/fastly/models/realtime_entry_aggregated.rb +254 -4
- data/lib/fastly/models/realtime_measurements.rb +254 -4
- data/lib/fastly/models/results.rb +251 -1
- data/lib/fastly/models/status.rb +276 -0
- data/lib/fastly/models/status_all_of.rb +268 -0
- data/lib/fastly/models/suggestion.rb +255 -0
- data/lib/fastly/models/suggestion_all_of.rb +247 -0
- data/lib/fastly/models/tag_base.rb +275 -0
- data/lib/fastly/models/tag_create.rb +282 -0
- data/lib/fastly/models/tag_get.rb +352 -0
- data/lib/fastly/models/tag_get_extra.rb +267 -0
- data/lib/fastly/models/values.rb +634 -4
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +38 -1
- data/sig.json +1 -1
- metadata +78 -4
data/docs/InlineResponse2002.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
7
|
+
| **meta** | [**Meta**](Meta.md) | | [optional] |
|
|
8
|
+
| **data** | [**Array<OperationGet>**](OperationGet.md) | The operations returned by the request. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
11
|
|
data/docs/InlineResponse2003.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
7
|
+
| **meta** | [**Meta**](Meta.md) | | [optional] |
|
|
8
|
+
| **data** | [**Array<TagGet>**](TagGet.md) | The operation tags returned by the request. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
11
|
|
data/docs/InlineResponse2004.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** |
|
|
8
|
-
| **meta** | **Object** | Meta for the pagination. | [optional] |
|
|
7
|
+
| **data** | **Array<String>** | The service IDs of the services the token will have access to. Separate service IDs with a space. | [optional] |
|
|
9
8
|
|
|
10
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
10
|
|
data/docs/InlineResponse2005.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
7
|
+
| **data** | [**Array<DdosProtectionEvent>**](DdosProtectionEvent.md) | | [optional] |
|
|
8
|
+
| **meta** | [**PaginationCursorMeta**](PaginationCursorMeta.md) | | [optional] |
|
|
8
9
|
|
|
9
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
11
|
|
data/docs/InlineResponse2006.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<
|
|
8
|
-
| **meta** | [**PaginationCursorMeta**](PaginationCursorMeta.md) | |
|
|
7
|
+
| **data** | [**Array<DdosProtectionRuleWithStats>**](DdosProtectionRuleWithStats.md) | | |
|
|
8
|
+
| **meta** | [**PaginationCursorMeta**](PaginationCursorMeta.md) | | |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
11
|
|
data/docs/InlineResponse2007.md
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | **Array<
|
|
8
|
-
| **meta** |
|
|
7
|
+
| **data** | [**Array<SuccessfulResponseAsObject>**](SuccessfulResponseAsObject.md) | | [optional] |
|
|
8
|
+
| **meta** | **Object** | Meta for the pagination. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
11
|
|
data/docs/InlineResponse2008.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **meta** | [**PaginationCursorMeta**](PaginationCursorMeta.md) | | [optional] |
|
|
7
|
+
| **expires_at** | **String** | Time-stamp (GMT) when the domain_ownership validation will expire. | [optional][readonly] |
|
|
9
8
|
|
|
10
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
10
|
|
data/docs/InlineResponse2009.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **meta** | [**PaginationCursorMeta**](PaginationCursorMeta.md) | | [optional] |
|
|
7
|
+
| **results** | [**Array<Suggestion>**](Suggestion.md) | | [optional] |
|
|
9
8
|
|
|
10
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
10
|
|
data/docs/InsightsApi.md
CHANGED
|
@@ -30,9 +30,9 @@ Retrieves statistics from sampled log records.
|
|
|
30
30
|
api_instance = Fastly::InsightsApi.new
|
|
31
31
|
opts = {
|
|
32
32
|
visualization: 'top-url-by-bandwidth', # String |
|
|
33
|
-
service_id: '
|
|
34
|
-
start: '
|
|
35
|
-
_end: '
|
|
33
|
+
service_id: '1jlmtMz1ncwA0KC3TBGD0X', # String |
|
|
34
|
+
start: '2024-01-01T14:30:23Z', # String |
|
|
35
|
+
_end: '2024-01-05T14:30:23Z', # String |
|
|
36
36
|
pops: 'pops_example', # String |
|
|
37
37
|
domain: 'domain_example', # String |
|
|
38
38
|
domain_exact_match: true, # Boolean |
|
data/docs/KvStoreApi.md
CHANGED
|
@@ -17,6 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
[**kv_store_delete**](KvStoreApi.md#kv_store_delete) | **DELETE** /resources/stores/kv/{store_id} | Delete a KV store.
|
|
18
18
|
[**kv_store_get**](KvStoreApi.md#kv_store_get) | **GET** /resources/stores/kv/{store_id} | Describe a KV store.
|
|
19
19
|
[**kv_store_list**](KvStoreApi.md#kv_store_list) | **GET** /resources/stores/kv | List all KV stores.
|
|
20
|
+
[**kv_store_put**](KvStoreApi.md#kv_store_put) | **PUT** /resources/stores/kv/{store_id} | Update a KV store.
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
## `kv_store_create()`
|
|
@@ -33,7 +34,7 @@ Create a KV store.
|
|
|
33
34
|
api_instance = Fastly::KvStoreApi.new
|
|
34
35
|
opts = {
|
|
35
36
|
location: 'US', # String |
|
|
36
|
-
|
|
37
|
+
kv_store_request_create_or_update: Fastly::KvStoreRequestCreateOrUpdate.new({name: 'name_example'}), # KvStoreRequestCreateOrUpdate |
|
|
37
38
|
}
|
|
38
39
|
|
|
39
40
|
begin
|
|
@@ -50,7 +51,7 @@ end
|
|
|
50
51
|
| Name | Type | Description | Notes |
|
|
51
52
|
| ---- | ---- | ----------- | ----- |
|
|
52
53
|
| **location** | **String** | | [optional] |
|
|
53
|
-
| **
|
|
54
|
+
| **kv_store_request_create_or_update** | [**KvStoreRequestCreateOrUpdate**](KvStoreRequestCreateOrUpdate.md) | | [optional] |
|
|
54
55
|
|
|
55
56
|
### Return type
|
|
56
57
|
|
|
@@ -134,7 +135,7 @@ end
|
|
|
134
135
|
## `kv_store_list()`
|
|
135
136
|
|
|
136
137
|
```ruby
|
|
137
|
-
kv_store_list(opts): <
|
|
138
|
+
kv_store_list(opts): <InlineResponse20010> # List all KV stores.
|
|
138
139
|
```
|
|
139
140
|
|
|
140
141
|
List all KV stores.
|
|
@@ -168,7 +169,45 @@ end
|
|
|
168
169
|
|
|
169
170
|
### Return type
|
|
170
171
|
|
|
171
|
-
[**
|
|
172
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
|
173
|
+
|
|
174
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
175
|
+
[[Back to README]](../../README.md)
|
|
176
|
+
## `kv_store_put()`
|
|
177
|
+
|
|
178
|
+
```ruby
|
|
179
|
+
kv_store_put(opts) # Update a KV store.
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Update the name of a KV store.
|
|
183
|
+
|
|
184
|
+
### Examples
|
|
185
|
+
|
|
186
|
+
```ruby
|
|
187
|
+
api_instance = Fastly::KvStoreApi.new
|
|
188
|
+
opts = {
|
|
189
|
+
store_id: 'store_id_example', # String |
|
|
190
|
+
kv_store_request_create_or_update: Fastly::KvStoreRequestCreateOrUpdate.new({name: 'name_example'}), # KvStoreRequestCreateOrUpdate |
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
begin
|
|
194
|
+
# Update a KV store.
|
|
195
|
+
api_instance.kv_store_put(opts)
|
|
196
|
+
rescue Fastly::ApiError => e
|
|
197
|
+
puts "Error when calling KvStoreApi->kv_store_put: #{e}"
|
|
198
|
+
end
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Options
|
|
202
|
+
|
|
203
|
+
| Name | Type | Description | Notes |
|
|
204
|
+
| ---- | ---- | ----------- | ----- |
|
|
205
|
+
| **store_id** | **String** | | |
|
|
206
|
+
| **kv_store_request_create_or_update** | [**KvStoreRequestCreateOrUpdate**](KvStoreRequestCreateOrUpdate.md) | | [optional] |
|
|
207
|
+
|
|
208
|
+
### Return type
|
|
209
|
+
|
|
210
|
+
nil (empty response body)
|
|
172
211
|
|
|
173
212
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
174
213
|
[[Back to README]](../../README.md)
|
data/docs/KvStoreDetails.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | ID of the store. | [optional] |
|
|
8
8
|
| **name** | **String** | Name of the store. | [optional] |
|
|
9
|
+
| **created_at** | **String** | Timestamp at which the store was created. | [optional] |
|
|
10
|
+
| **updated_at** | **String** | Timestamp at which the store was last updated. | [optional] |
|
|
9
11
|
|
|
10
12
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
13
|
|
data/docs/KvStoreItemApi.md
CHANGED
|
@@ -103,7 +103,7 @@ end
|
|
|
103
103
|
## `kv_store_list_item_keys()`
|
|
104
104
|
|
|
105
105
|
```ruby
|
|
106
|
-
kv_store_list_item_keys(opts): <
|
|
106
|
+
kv_store_list_item_keys(opts): <InlineResponse20011> # List item keys.
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
Lists the matching item keys (or all item keys, if no prefix is supplied).
|
|
@@ -141,7 +141,7 @@ end
|
|
|
141
141
|
|
|
142
142
|
### Return type
|
|
143
143
|
|
|
144
|
-
[**
|
|
144
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
|
145
145
|
|
|
146
146
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
147
147
|
[[Back to README]](../../README.md)
|
data/docs/LogInsights.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **dimensions** | [**LogInsightsDimensions**](LogInsightsDimensions.md) | | [optional] |
|
|
8
8
|
| **dimension_attributes** | [**LogInsightsDimensionAttributes**](LogInsightsDimensionAttributes.md) | | [optional] |
|
|
9
|
-
| **values** | [**LogInsightsValues
|
|
9
|
+
| **values** | [**Array<LogInsightsValues>**](LogInsightsValues.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
12
|
|
data/docs/Meta.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::Meta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **limit** | **Integer** | The `limit` value used when making the request. | |
|
|
8
|
+
| **total** | **Integer** | The count of requests matching the filter. | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# Fastly::MetricsPlatformApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::MetricsPlatformApi.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_platform_metrics_service_historical**](MetricsPlatformApi.md#get_platform_metrics_service_historical) | **GET** /metrics/platform/services/{service_id}/{granularity} | Get historical time series metrics for a single service
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## `get_platform_metrics_service_historical()`
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
get_platform_metrics_service_historical(opts): <PlatformMetricsResponse> # Get historical time series metrics for a single service
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Fetches historical metrics for a single service for a given granularity.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
api_instance = Fastly::MetricsPlatformApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
33
|
+
granularity: 'minutely', # String | Duration of sample windows.
|
|
34
|
+
from: '2025-06-08T00:00:00.000Z', # String | A valid RFC-8339-formatted date and time indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `granularity` value.
|
|
35
|
+
to: '2025-08-02T00:00:00.000Z', # String | A valid RFC-8339-formatted date and time indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `granularity` value.
|
|
36
|
+
metric: 'ttfb_edge_p95_us,ttfb_edge_p99_us', # String | The metric(s) to retrieve. Multiple values should be comma-separated.
|
|
37
|
+
metric_set: 'ttfb', # String | The metric set(s) to retrieve. Multiple values should be comma-separated.
|
|
38
|
+
group_by: 'datacenter', # String | Field to group_by in the query. For example, `group_by=region` will return entries for grouped by timestamp and region.
|
|
39
|
+
region: 'africa_std', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
40
|
+
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
41
|
+
cursor: 'cursor_example', # String | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
|
|
42
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 10000.
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
begin
|
|
46
|
+
# Get historical time series metrics for a single service
|
|
47
|
+
result = api_instance.get_platform_metrics_service_historical(opts)
|
|
48
|
+
p result
|
|
49
|
+
rescue Fastly::ApiError => e
|
|
50
|
+
puts "Error when calling MetricsPlatformApi->get_platform_metrics_service_historical: #{e}"
|
|
51
|
+
end
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Options
|
|
55
|
+
|
|
56
|
+
| Name | Type | Description | Notes |
|
|
57
|
+
| ---- | ---- | ----------- | ----- |
|
|
58
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
59
|
+
| **granularity** | **String** | Duration of sample windows. | |
|
|
60
|
+
| **from** | **String** | A valid RFC-8339-formatted date and time indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `granularity` value. | [optional] |
|
|
61
|
+
| **to** | **String** | A valid RFC-8339-formatted date and time indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `granularity` value. | [optional] |
|
|
62
|
+
| **metric** | **String** | The metric(s) to retrieve. Multiple values should be comma-separated. | [optional] |
|
|
63
|
+
| **metric_set** | **String** | The metric set(s) to retrieve. Multiple values should be comma-separated. | [optional] |
|
|
64
|
+
| **group_by** | **String** | Field to group_by in the query. For example, `group_by=region` will return entries for grouped by timestamp and region. | [optional] |
|
|
65
|
+
| **region** | **String** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] |
|
|
66
|
+
| **datacenter** | **String** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional] |
|
|
67
|
+
| **cursor** | **String** | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
|
68
|
+
| **limit** | **String** | Number of results per page. The maximum is 10000. | [optional][default to '1000'] |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**PlatformMetricsResponse**](PlatformMetricsResponse.md)
|
|
73
|
+
|
|
74
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
75
|
+
[[Back to README]](../../README.md)
|
data/docs/NgwafRequestEnable.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **workspace_id** | **String** | The workspace to link. | |
|
|
8
|
+
| **traffic_ramp** | **String** | The percentage of traffic to inspect. | [optional] |
|
|
8
9
|
|
|
9
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
11
|
|
data/docs/Offer.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::Offer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **vendor** | **String** | The aftermarket vendor. | [optional] |
|
|
8
|
+
| **price** | **String** | The price for the domain from the aftermarket vendor. | [optional] |
|
|
9
|
+
| **currency** | **String** | The currency for the aftermarket offer. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
data/docs/OfferAllOf.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::OfferAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **vendor** | **String** | The aftermarket vendor. | [optional] |
|
|
8
|
+
| **price** | **String** | The price for the domain from the aftermarket vendor. | [optional] |
|
|
9
|
+
| **currency** | **String** | The currency for the aftermarket offer. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Fastly::OperationBase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | **String** | The HTTP method for the operation. | [optional] |
|
|
8
|
+
| **domain** | **String** | The domain for the operation. | [optional] |
|
|
9
|
+
| **path** | **String** | The path for the operation, which may include path parameters. | [optional] |
|
|
10
|
+
| **description** | **String** | A description of what the operation does. | [optional] |
|
|
11
|
+
| **tag_ids** | **Array<String>** | An array of operation tag IDs associated with this operation. | [optional] |
|
|
12
|
+
|
|
13
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Fastly::OperationCreate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | **String** | The HTTP method for the operation. | [optional] |
|
|
8
|
+
| **domain** | **String** | The domain for the operation. | [optional] |
|
|
9
|
+
| **path** | **String** | The path for the operation, which may include path parameters. | [optional] |
|
|
10
|
+
| **description** | **String** | A description of what the operation does. | [optional] |
|
|
11
|
+
| **tag_ids** | **Array<String>** | An array of operation tag IDs associated with this operation. | [optional] |
|
|
12
|
+
|
|
13
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Fastly::OperationGet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | **String** | The HTTP method for the operation. | |
|
|
8
|
+
| **domain** | **String** | The domain for the operation. | |
|
|
9
|
+
| **path** | **String** | The path for the operation, which may include path parameters. | |
|
|
10
|
+
| **id** | **String** | The unique identifier of the operation. | [readonly] |
|
|
11
|
+
| **updated_at** | **Time** | The timestamp when the operation was last updated. | [readonly] |
|
|
12
|
+
| **description** | **String** | A description of what the operation does. | [optional] |
|
|
13
|
+
| **tag_ids** | **Array<String>** | An array of operation tag IDs associated with this operation. | [optional] |
|
|
14
|
+
| **created_at** | **Time** | The timestamp when the operation was created. | [optional][readonly] |
|
|
15
|
+
| **last_seen_at** | **Time** | The timestamp when the operation was last seen in traffic. | [optional][readonly] |
|
|
16
|
+
|
|
17
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
18
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::OperationGetExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique identifier of the operation. | [readonly] |
|
|
8
|
+
| **updated_at** | **Time** | The timestamp when the operation was last updated. | [readonly] |
|
|
9
|
+
| **created_at** | **Time** | The timestamp when the operation was created. | [optional][readonly] |
|
|
10
|
+
| **last_seen_at** | **Time** | The timestamp when the operation was last seen in traffic. | [optional][readonly] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Fastly::OperationUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **method** | **String** | The HTTP method for the operation. | [optional] |
|
|
8
|
+
| **domain** | **String** | The domain for the operation. | [optional] |
|
|
9
|
+
| **path** | **String** | The path for the operation, which may include path parameters. | [optional] |
|
|
10
|
+
| **description** | **String** | A description of what the operation does. | [optional] |
|
|
11
|
+
| **tag_ids** | **Array<String>** | An array of operation tag IDs associated with this operation. | [optional] |
|
|
12
|
+
|
|
13
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
|
+
|
|
@@ -37,7 +37,7 @@ opts = {
|
|
|
37
37
|
group_by: 'host', # String | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=host` will return one timeseries for every origin host, as a total across all POPs.
|
|
38
38
|
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
|
39
39
|
cursor: 'cursor_example', # String | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
|
|
40
|
-
region: '
|
|
40
|
+
region: 'africa_std', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
41
41
|
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
42
42
|
host: 'origin_1,origin_2', # String | Limit query to one or more specific origin hosts. Values should be comma-separated.
|
|
43
43
|
}
|
data/docs/PackageMetadata.md
CHANGED
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
| **description** | **String** | Description of the Compute package. | [optional] |
|
|
9
9
|
| **authors** | **Array<String>** | A list of package authors' email addresses. | [optional] |
|
|
10
10
|
| **language** | **String** | The language of the Compute package. | [optional] |
|
|
11
|
-
| **size** | **Integer** | Size of the Compute package in bytes. | [optional] |
|
|
12
|
-
| **hashsum** | **String** | Hash of the Compute package. | [optional] |
|
|
11
|
+
| **size** | **Integer** | Size of the Compute package in bytes. This is deprecated along with `hashsum`. | [optional] |
|
|
12
|
+
| **hashsum** | **String** | Hash of the Compute package. This is deprecated in favor of `files_hash`. | [optional] |
|
|
13
13
|
| **files_hash** | **String** | Hash of the files within the Compute package. | [optional] |
|
|
14
14
|
|
|
15
15
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Fastly::PlatformMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **from** | **Time** | An RFC-8339-formatted date and time indicating the inclusive start of the query time range. | [optional] |
|
|
8
|
+
| **to** | **Time** | An RFC-8339-formatted date and time indicating the exclusive end of the query time range. | [optional] |
|
|
9
|
+
| **next_cursor** | **String** | A string that can be used to request the next page of results, if any. | [optional] |
|
|
10
|
+
| **group_by** | **String** | A comma-separated list of fields used to group and order the results. | [optional] |
|
|
11
|
+
| **limit** | **Integer** | The maximum number of results to return. | [optional] |
|
|
12
|
+
|
|
13
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::PlatformMetricsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**PlatformMetadata**](PlatformMetadata.md) | | [optional] |
|
|
8
|
+
| **data** | [**Array<PlatformValues>**](PlatformValues.md) | An array of values representing the metric values at each point in time. Note that this dataset is sparse: only the keys with non-zero values will be included in the record. | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Fastly::PlatformValues
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **timestamp** | **Time** | Timestamp of the metrics data point. | [optional] |
|
|
8
|
+
| **ttfb_origin_p25_us** | **Float** | 25th percentile of time to first byte from origin, in microseconds. | [optional] |
|
|
9
|
+
| **ttfb_origin_p50_us** | **Float** | 50th percentile of time to first byte from origin, in microseconds. | [optional] |
|
|
10
|
+
| **ttfb_origin_p75_us** | **Float** | 75th percentile of time to first byte from origin, in microseconds. | [optional] |
|
|
11
|
+
| **ttfb_origin_p95_us** | **Float** | 95th percentile of time to first byte from origin, in microseconds. | [optional] |
|
|
12
|
+
| **ttfb_origin_p99_us** | **Float** | 99th percentile of time to first byte from origin, in microseconds. | [optional] |
|
|
13
|
+
| **ttfb_shield_p25_us** | **Float** | 25th percentile of time to first byte from shield, in microseconds. | [optional] |
|
|
14
|
+
| **ttfb_shield_p50_us** | **Float** | 50th percentile of time to first byte from shield, in microseconds. | [optional] |
|
|
15
|
+
| **ttfb_shield_p75_us** | **Float** | 75th percentile of time to first byte from shield, in microseconds. | [optional] |
|
|
16
|
+
| **ttfb_shield_p95_us** | **Float** | 95th percentile of time to first byte from shield, in microseconds. | [optional] |
|
|
17
|
+
| **ttfb_shield_p99_us** | **Float** | 99th percentile of time to first byte from shield, in microseconds. | [optional] |
|
|
18
|
+
| **ttfb_edge_p25_us** | **Float** | 25th percentile of time to first byte from edge, in microseconds. | [optional] |
|
|
19
|
+
| **ttfb_edge_p50_us** | **Float** | 50th percentile of time to first byte from edge, in microseconds. | [optional] |
|
|
20
|
+
| **ttfb_edge_p75_us** | **Float** | 75th percentile of time to first byte from edge, in microseconds. | [optional] |
|
|
21
|
+
| **ttfb_edge_p95_us** | **Float** | 95th percentile of time to first byte from edge, in microseconds. | [optional] |
|
|
22
|
+
| **ttfb_edge_p99_us** | **Float** | 99th percentile of time to first byte from edge, in microseconds. | [optional] |
|
|
23
|
+
|
|
24
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
25
|
+
|
|
@@ -63,7 +63,7 @@ nil (empty response body)
|
|
|
63
63
|
enable_product_ddos_protection(opts): <DdosProtectionResponseEnable> # Enable product
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Enable the DDoS Protection product on a service in 'log' mode.
|
|
66
|
+
Enable the DDoS Protection product on a service in default 'log' mode unless otherwise specified in the request body.
|
|
67
67
|
|
|
68
68
|
### Examples
|
|
69
69
|
|
|
@@ -71,6 +71,7 @@ Enable the DDoS Protection product on a service in 'log' mode.
|
|
|
71
71
|
api_instance = Fastly::ProductDdosProtectionApi.new
|
|
72
72
|
opts = {
|
|
73
73
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
74
|
+
ddos_protection_request_enable_mode: Fastly::DdosProtectionRequestEnableMode.new, # DdosProtectionRequestEnableMode |
|
|
74
75
|
}
|
|
75
76
|
|
|
76
77
|
begin
|
|
@@ -87,6 +88,7 @@ end
|
|
|
87
88
|
| Name | Type | Description | Notes |
|
|
88
89
|
| ---- | ---- | ----------- | ----- |
|
|
89
90
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
91
|
+
| **ddos_protection_request_enable_mode** | [**DdosProtectionRequestEnableMode**](DdosProtectionRequestEnableMode.md) | | [optional] |
|
|
90
92
|
|
|
91
93
|
### Return type
|
|
92
94
|
|