fastly 8.10.0 → 9.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -1
- data/Gemfile.lock +1 -1
- data/README.md +15 -4
- data/docs/AccessKey.md +12 -0
- data/docs/AccessKeyResponse.md +15 -0
- data/docs/AclsInComputeApi.md +2 -2
- data/docs/BillingUsageMetricsApi.md +13 -19
- data/docs/ComputeAclUpdate.md +10 -0
- data/docs/DimensionAttributesCountryStats.md +12 -0
- data/docs/DimensionAttributesRate.md +10 -0
- data/docs/DimensionBrowser.md +10 -0
- data/docs/DimensionContentType.md +10 -0
- data/docs/DimensionCountry.md +10 -0
- data/docs/DimensionDevice.md +10 -0
- data/docs/DimensionOs.md +10 -0
- data/docs/DimensionResponse.md +10 -0
- data/docs/DimensionStatusCode.md +10 -0
- data/docs/DimensionUrl.md +10 -0
- data/docs/EnabledProductsApi.md +5 -5
- data/docs/FilterFieldItem.md +12 -0
- data/docs/GetLogInsightsResponse.md +11 -0
- data/docs/GetLogRecordsResponse.md +11 -0
- data/docs/GetLogRecordsResponseMeta.md +10 -0
- data/docs/GetLogRecordsResponseMetaFilters.md +16 -0
- data/docs/InsightsApi.md +69 -0
- data/docs/KvStoreItemApi.md +2 -0
- data/docs/LogExplorerApi.md +65 -0
- data/docs/LogInsights.md +12 -0
- data/docs/LogInsightsDimensionAttributes.md +49 -0
- data/docs/LogInsightsDimensions.md +61 -0
- data/docs/LogInsightsMeta.md +10 -0
- data/docs/LogInsightsMetaFilter.md +14 -0
- data/docs/LogInsightsValues.md +65 -0
- data/docs/LogPropertyServiceId.md +9 -0
- data/docs/LogRecord.md +37 -0
- data/docs/LoggingGrafanacloudlogsAdditional.md +14 -0
- data/docs/LoggingGrafanacloudlogsApi.md +259 -0
- data/docs/LoggingGrafanacloudlogsResponse.md +23 -0
- data/docs/ObjectStorageAccessKeysApi.md +163 -0
- data/docs/RealtimeEntryAggregated.md +3 -7
- data/docs/RealtimeMeasurements.md +3 -7
- data/docs/Results.md +3 -7
- data/docs/SetConfiguration.md +1 -0
- data/docs/Usagemetric.md +18 -0
- data/docs/Usagemetrics.md +10 -0
- data/docs/ValueField.md +59 -0
- data/docs/Values503Responses.md +12 -0
- data/docs/ValuesBandwidth.md +11 -0
- data/docs/ValuesBrowser.md +11 -0
- data/docs/ValuesCacheHitRatio.md +10 -0
- data/docs/ValuesCountryStats.md +12 -0
- data/docs/ValuesDuration.md +12 -0
- data/docs/ValuesMisses.md +10 -0
- data/docs/ValuesRate.md +10 -0
- data/docs/ValuesRequests.md +10 -0
- data/docs/ValuesStatusCodes.md +12 -0
- data/lib/fastly/api/acls_in_compute_api.rb +3 -3
- data/lib/fastly/api/billing_usage_metrics_api.rb +30 -57
- data/lib/fastly/api/enabled_products_api.rb +10 -10
- data/lib/fastly/api/insights_api.rb +125 -0
- data/lib/fastly/api/kv_store_item_api.rb +3 -0
- data/lib/fastly/api/log_explorer_api.rb +109 -0
- data/lib/fastly/api/logging_grafanacloudlogs_api.rb +471 -0
- data/lib/fastly/api/object_storage_access_keys_api.rb +263 -0
- data/lib/fastly/configuration.rb +67 -1
- data/lib/fastly/models/access_key.rb +248 -0
- data/lib/fastly/models/access_key_response.rb +269 -0
- data/lib/fastly/models/compute_acl_list_entries.rb +1 -1
- data/lib/fastly/models/compute_acl_lookup.rb +1 -1
- data/lib/fastly/models/compute_acl_update.rb +219 -0
- data/lib/fastly/models/compute_acl_update_entry.rb +1 -1
- data/lib/fastly/models/dimension_attributes_country_stats.rb +237 -0
- data/lib/fastly/models/dimension_attributes_rate.rb +217 -0
- data/lib/fastly/models/dimension_browser.rb +217 -0
- data/lib/fastly/models/dimension_content_type.rb +217 -0
- data/lib/fastly/models/dimension_country.rb +217 -0
- data/lib/fastly/models/dimension_device.rb +217 -0
- data/lib/fastly/models/dimension_os.rb +217 -0
- data/lib/fastly/models/dimension_response.rb +217 -0
- data/lib/fastly/models/dimension_status_code.rb +217 -0
- data/lib/fastly/models/dimension_url.rb +217 -0
- data/lib/fastly/models/filter_field_item.rb +271 -0
- data/lib/fastly/models/get_log_insights_response.rb +227 -0
- data/lib/fastly/models/get_log_records_response.rb +227 -0
- data/lib/fastly/models/get_log_records_response_meta.rb +216 -0
- data/lib/fastly/models/get_log_records_response_meta_filters.rb +307 -0
- data/lib/fastly/models/log_insights.rb +234 -0
- data/lib/fastly/models/log_insights_dimension_attributes.rb +103 -0
- data/lib/fastly/models/log_insights_dimensions.rb +109 -0
- data/lib/fastly/models/log_insights_meta.rb +217 -0
- data/lib/fastly/models/log_insights_meta_filter.rb +284 -0
- data/lib/fastly/models/log_insights_values.rb +111 -0
- data/lib/fastly/models/log_property_service_id.rb +208 -0
- data/lib/fastly/models/log_record.rb +486 -0
- data/lib/fastly/models/logging_grafanacloudlogs_additional.rb +257 -0
- data/lib/fastly/models/logging_grafanacloudlogs_response.rb +408 -0
- data/lib/fastly/models/realtime_entry_aggregated.rb +34 -74
- data/lib/fastly/models/realtime_measurements.rb +34 -74
- data/lib/fastly/models/results.rb +31 -71
- data/lib/fastly/models/set_configuration.rb +14 -4
- data/lib/fastly/models/usagemetric.rb +297 -0
- data/lib/fastly/models/usagemetrics.rb +218 -0
- data/lib/fastly/models/value_field.rb +108 -0
- data/lib/fastly/models/values503_responses.rb +237 -0
- data/lib/fastly/models/values_bandwidth.rb +227 -0
- data/lib/fastly/models/values_browser.rb +227 -0
- data/lib/fastly/models/values_cache_hit_ratio.rb +217 -0
- data/lib/fastly/models/values_country_stats.rb +237 -0
- data/lib/fastly/models/values_duration.rb +237 -0
- data/lib/fastly/models/values_misses.rb +217 -0
- data/lib/fastly/models/values_rate.rb +217 -0
- data/lib/fastly/models/values_requests.rb +217 -0
- data/lib/fastly/models/values_status_codes.rb +237 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +45 -0
- data/sig.json +1 -1
- metadata +92 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ed09d7b4542e087118b59eb762e4c87fbf27799503159a6c71ee5b19435d682c
|
4
|
+
data.tar.gz: 2114a4000cbe40b7b780d0bc77866e89d52618f3d742f454f09a4e8e6fe81c1e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c25c020275e5b4beba44d319bfab079e8cce8c95bc891b1a41fd6417ffc9f302d5801869fb89d0d014c11be348c43437a024c05f2789112fbd02c70ac0d5614a
|
7
|
+
data.tar.gz: 6ed64854389baa22d09bad7a68dfde19a40d3372f100b0096dde062e29059c94cce6585a9b6a6e301525fa2b0fdfff47c00670b250c13f7760da93f2c7b08c44
|
data/CHANGELOG.md
CHANGED
@@ -1,9 +1,35 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## [
|
3
|
+
## [v9.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v9.0.0) (2024-12-05)
|
4
|
+
|
5
|
+
**Breaking Changes:**
|
6
|
+
|
7
|
+
- fix(udm-domains): Use v1 versioned HTTP endpoints for UDM domains
|
8
|
+
- fix(historical): Remove references to VCL on Compute metrics
|
9
|
+
- fix(realtime): Remove references to VCL on Compute metrics
|
10
|
+
- feat(billing-usage-metrics): Updated to v3 of the API
|
11
|
+
|
12
|
+
**Bug fixes:**
|
13
|
+
|
14
|
+
- fix(acls-in-compute): Corrected shape of `compute-acl-update` model.
|
15
|
+
|
16
|
+
**Enhancements:**
|
17
|
+
|
18
|
+
- feat(object-storage-access-keys): Added Object Storage Access Keys API
|
19
|
+
- feat(logging-grafanacloudlogs): Added Grafana Cloud Logs Loggin API
|
20
|
+
- feat(log-explorer): Added Log Explorer API
|
21
|
+
- feat(insights): Added Insights API
|
22
|
+
- feat(kv-store-item): Added `consistency` parameter to `get-keys` operation.
|
23
|
+
- feat(enabled-products): Added `mode` property to `set-configuration`.
|
4
24
|
|
5
25
|
**Documentation:**
|
6
26
|
|
27
|
+
- doc(observability-custom-dashboards): Fix bad link in custom dashboard documentation
|
28
|
+
- doc(observability-custom-dashboards): Reformat some enums to fix docs rendering
|
29
|
+
- doc(acls-in-compute): Corrections to descriptions of `compute-acl-lookup`, `compute-acl-list-entries`,
|
30
|
+
`compute-acl-update-entry`, and `compute-acl-update` structures
|
31
|
+
- doc(enabled-products): Added support for product ID `log_explorer_insights`.
|
32
|
+
- doc(enabled-products): Added support for product ID `ddos_protection`.
|
7
33
|
- doc(backend): Correct spelling in `connect_timeout` and `first_byte_timeout` field descriptions.
|
8
34
|
|
9
35
|
## [v8.9.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.9.0) (2024-09-13)
|
data/Gemfile.lock
CHANGED
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', '~>
|
11
|
+
gem 'fastly', '~> 9.0.0'
|
12
12
|
```
|
13
13
|
|
14
14
|
Then run `bundle install`.
|
@@ -112,7 +112,7 @@ Class | Method | Description
|
|
112
112
|
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_month_to_date_invoice**](docs/BillingInvoicesApi.md#get_month_to_date_invoice) | Get month-to-date invoice.
|
113
113
|
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
|
114
114
|
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_service_level_usage**](docs/BillingUsageMetricsApi.md#get_service_level_usage) | Retrieve service-level usage metrics for a product.
|
115
|
-
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**
|
115
|
+
[*Fastly::BillingUsageMetricsApi*](docs/BillingUsageMetricsApi.md) | [**get_usage_metrics**](docs/BillingUsageMetricsApi.md#get_usage_metrics) | Get monthly usage metrics
|
116
116
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
|
117
117
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
|
118
118
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | Get a cache settings object
|
@@ -250,6 +250,7 @@ Class | Method | Description
|
|
250
250
|
[*Fastly::IamUserGroupsApi*](docs/IamUserGroupsApi.md) | [**update_a_user_group**](docs/IamUserGroupsApi.md#update_a_user_group) | Update a user group
|
251
251
|
[*Fastly::ImageOptimizerDefaultSettingsApi*](docs/ImageOptimizerDefaultSettingsApi.md) | [**get_default_settings**](docs/ImageOptimizerDefaultSettingsApi.md#get_default_settings) | Get current Image Optimizer Default Settings
|
252
252
|
[*Fastly::ImageOptimizerDefaultSettingsApi*](docs/ImageOptimizerDefaultSettingsApi.md) | [**update_default_settings**](docs/ImageOptimizerDefaultSettingsApi.md#update_default_settings) | Update Image Optimizer Default Settings
|
253
|
+
[*Fastly::InsightsApi*](docs/InsightsApi.md) | [**get_log_insights**](docs/InsightsApi.md#get_log_insights) | Retrieve log insights
|
253
254
|
[*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**create_invitation**](docs/InvitationsApi.md#create_invitation) | Create an invitation
|
254
255
|
[*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**delete_invitation**](docs/InvitationsApi.md#delete_invitation) | Delete an invitation
|
255
256
|
[*Fastly::InvitationsApi*](docs/InvitationsApi.md) | [**list_invitations**](docs/InvitationsApi.md#list_invitations) | List invitations
|
@@ -289,6 +290,7 @@ Class | Method | Description
|
|
289
290
|
[*Fastly::LegacyWafTagApi*](docs/LegacyWafTagApi.md) | [**list_legacy_waf_tags**](docs/LegacyWafTagApi.md#list_legacy_waf_tags) | List WAF tags
|
290
291
|
[*Fastly::LegacyWafUpdateStatusApi*](docs/LegacyWafUpdateStatusApi.md) | [**get_waf_update_status**](docs/LegacyWafUpdateStatusApi.md#get_waf_update_status) | Get the status of a WAF update
|
291
292
|
[*Fastly::LegacyWafUpdateStatusApi*](docs/LegacyWafUpdateStatusApi.md) | [**list_waf_update_statuses**](docs/LegacyWafUpdateStatusApi.md#list_waf_update_statuses) | List update statuses
|
293
|
+
[*Fastly::LogExplorerApi*](docs/LogExplorerApi.md) | [**get_log_records**](docs/LogExplorerApi.md#get_log_records) | Retrieve log records
|
292
294
|
[*Fastly::LoggingAzureblobApi*](docs/LoggingAzureblobApi.md) | [**create_log_azure**](docs/LoggingAzureblobApi.md#create_log_azure) | Create an Azure Blob Storage log endpoint
|
293
295
|
[*Fastly::LoggingAzureblobApi*](docs/LoggingAzureblobApi.md) | [**delete_log_azure**](docs/LoggingAzureblobApi.md#delete_log_azure) | Delete the Azure Blob Storage log endpoint
|
294
296
|
[*Fastly::LoggingAzureblobApi*](docs/LoggingAzureblobApi.md) | [**get_log_azure**](docs/LoggingAzureblobApi.md#get_log_azure) | Get an Azure Blob Storage log endpoint
|
@@ -329,6 +331,11 @@ Class | Method | Description
|
|
329
331
|
[*Fastly::LoggingGcsApi*](docs/LoggingGcsApi.md) | [**get_log_gcs**](docs/LoggingGcsApi.md#get_log_gcs) | Get a GCS log endpoint
|
330
332
|
[*Fastly::LoggingGcsApi*](docs/LoggingGcsApi.md) | [**list_log_gcs**](docs/LoggingGcsApi.md#list_log_gcs) | List GCS log endpoints
|
331
333
|
[*Fastly::LoggingGcsApi*](docs/LoggingGcsApi.md) | [**update_log_gcs**](docs/LoggingGcsApi.md#update_log_gcs) | Update a GCS log endpoint
|
334
|
+
[*Fastly::LoggingGrafanacloudlogsApi*](docs/LoggingGrafanacloudlogsApi.md) | [**create_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#create_log_grafanacloudlogs) | Create a Grafana Cloud Logs log endpoint
|
335
|
+
[*Fastly::LoggingGrafanacloudlogsApi*](docs/LoggingGrafanacloudlogsApi.md) | [**delete_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#delete_log_grafanacloudlogs) | Delete the Grafana Cloud Logs log endpoint
|
336
|
+
[*Fastly::LoggingGrafanacloudlogsApi*](docs/LoggingGrafanacloudlogsApi.md) | [**get_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#get_log_grafanacloudlogs) | Get a Grafana Cloud Logs log endpoint
|
337
|
+
[*Fastly::LoggingGrafanacloudlogsApi*](docs/LoggingGrafanacloudlogsApi.md) | [**list_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#list_log_grafanacloudlogs) | List Grafana Cloud Logs log endpoints
|
338
|
+
[*Fastly::LoggingGrafanacloudlogsApi*](docs/LoggingGrafanacloudlogsApi.md) | [**update_log_grafanacloudlogs**](docs/LoggingGrafanacloudlogsApi.md#update_log_grafanacloudlogs) | Update a Grafana Cloud Logs log endpoint
|
332
339
|
[*Fastly::LoggingHerokuApi*](docs/LoggingHerokuApi.md) | [**create_log_heroku**](docs/LoggingHerokuApi.md#create_log_heroku) | Create a Heroku log endpoint
|
333
340
|
[*Fastly::LoggingHerokuApi*](docs/LoggingHerokuApi.md) | [**delete_log_heroku**](docs/LoggingHerokuApi.md#delete_log_heroku) | Delete the Heroku log endpoint
|
334
341
|
[*Fastly::LoggingHerokuApi*](docs/LoggingHerokuApi.md) | [**get_log_heroku**](docs/LoggingHerokuApi.md#get_log_heroku) | Get a Heroku log endpoint
|
@@ -429,6 +436,10 @@ Class | Method | Description
|
|
429
436
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**get_mutual_authentication**](docs/MutualAuthenticationApi.md#get_mutual_authentication) | Get a Mutual Authentication
|
430
437
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**list_mutual_authentications**](docs/MutualAuthenticationApi.md#list_mutual_authentications) | List Mutual Authentications
|
431
438
|
[*Fastly::MutualAuthenticationApi*](docs/MutualAuthenticationApi.md) | [**patch_mutual_authentication**](docs/MutualAuthenticationApi.md#patch_mutual_authentication) | Update a Mutual Authentication
|
439
|
+
[*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**create_access_key**](docs/ObjectStorageAccessKeysApi.md#create_access_key) | Create an access key
|
440
|
+
[*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**delete_access_key**](docs/ObjectStorageAccessKeysApi.md#delete_access_key) | Delete an access key
|
441
|
+
[*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**get_access_key**](docs/ObjectStorageAccessKeysApi.md#get_access_key) | Get an access key
|
442
|
+
[*Fastly::ObjectStorageAccessKeysApi*](docs/ObjectStorageAccessKeysApi.md) | [**list_access_keys**](docs/ObjectStorageAccessKeysApi.md#list_access_keys) | List access keys
|
432
443
|
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**create_dashboard**](docs/ObservabilityCustomDashboardsApi.md#create_dashboard) | Create a new dashboard
|
433
444
|
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**delete_dashboard**](docs/ObservabilityCustomDashboardsApi.md#delete_dashboard) | Delete an existing dashboard
|
434
445
|
[*Fastly::ObservabilityCustomDashboardsApi*](docs/ObservabilityCustomDashboardsApi.md) | [**get_dashboard**](docs/ObservabilityCustomDashboardsApi.md#get_dashboard) | Retrieve a dashboard by ID
|
@@ -637,8 +648,8 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
637
648
|
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
|
638
649
|
- [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
639
650
|
- [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
640
|
-
- [`/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
641
|
-
- [`/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
651
|
+
- [`/domains/v1/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
652
|
+
- [`/domains/v1`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
642
653
|
- [`/notifications/integration-types`](https://developer.fastly.com/reference/api/observability/notification) (GET)
|
643
654
|
- [`/notifications/integrations/{integration_id}/rotateSigningKey`](https://developer.fastly.com/reference/api/observability/notification) (POST)
|
644
655
|
- [`/notifications/integrations/{integration_id}/signingKey`](https://developer.fastly.com/reference/api/observability/notification) (GET)
|
data/docs/AccessKey.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::AccessKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | A description of the access key. | |
|
8
|
+
| **permission** | **String** | The permissions granted to an access key. | |
|
9
|
+
| **buckets** | **Array<String>** | | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Fastly::AccessKeyResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **access_key** | **String** | Generated access key. | [optional] |
|
8
|
+
| **secret_key** | **String** | Generated secret key. | [optional] |
|
9
|
+
| **description** | **String** | Description for the access key. | [optional] |
|
10
|
+
| **permission** | **String** | Permissions granted to an access key. | [optional] |
|
11
|
+
| **buckets** | **Array<String>** | | [optional] |
|
12
|
+
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
13
|
+
|
14
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
15
|
+
|
data/docs/AclsInComputeApi.md
CHANGED
@@ -258,7 +258,7 @@ Update an ACL.
|
|
258
258
|
api_instance = Fastly::AclsInComputeApi.new
|
259
259
|
opts = {
|
260
260
|
acl_id: 'acl_id_example', # String |
|
261
|
-
|
261
|
+
compute_acl_update: Fastly::ComputeAclUpdate.new, # ComputeAclUpdate |
|
262
262
|
}
|
263
263
|
|
264
264
|
begin
|
@@ -274,7 +274,7 @@ end
|
|
274
274
|
| Name | Type | Description | Notes |
|
275
275
|
| ---- | ---- | ----------- | ----- |
|
276
276
|
| **acl_id** | **String** | | |
|
277
|
-
| **
|
277
|
+
| **compute_acl_update** | [**ComputeAclUpdate**](ComputeAclUpdate.md) | | [optional] |
|
278
278
|
|
279
279
|
### Return type
|
280
280
|
|
@@ -13,8 +13,8 @@ api_instance = Fastly::BillingUsageMetricsApi.new
|
|
13
13
|
|
14
14
|
Method | HTTP request | Description
|
15
15
|
------ | ------------ | -----------
|
16
|
-
[**get_service_level_usage**](BillingUsageMetricsApi.md#get_service_level_usage) | **GET** /billing/
|
17
|
-
[**
|
16
|
+
[**get_service_level_usage**](BillingUsageMetricsApi.md#get_service_level_usage) | **GET** /billing/v3/service-usage-metrics | Retrieve service-level usage metrics for a product.
|
17
|
+
[**get_usage_metrics**](BillingUsageMetricsApi.md#get_usage_metrics) | **GET** /billing/v3/usage-metrics | Get monthly usage metrics
|
18
18
|
|
19
19
|
|
20
20
|
## `get_service_level_usage()`
|
@@ -30,12 +30,8 @@ Returns product usage, broken down by service.
|
|
30
30
|
```ruby
|
31
31
|
api_instance = Fastly::BillingUsageMetricsApi.new
|
32
32
|
opts = {
|
33
|
-
customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
|
34
33
|
product_id: 'product_id_example', # String | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests.
|
35
34
|
usage_type_name: 'usage_type_name_example', # String | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests.
|
36
|
-
time_granularity: 'time_granularity_example', # String |
|
37
|
-
start_date: '2023-01-01', # String |
|
38
|
-
end_date: '2023-01-31', # String |
|
39
35
|
start_month: '2023-01', # String |
|
40
36
|
end_month: '2023-03', # String |
|
41
37
|
limit: 'limit_example', # String | Number of results per page. The maximum is 100.
|
@@ -55,12 +51,8 @@ end
|
|
55
51
|
|
56
52
|
| Name | Type | Description | Notes |
|
57
53
|
| ---- | ---- | ----------- | ----- |
|
58
|
-
| **customer_id** | **String** | Alphanumeric string identifying the customer. | |
|
59
54
|
| **product_id** | **String** | The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. | |
|
60
55
|
| **usage_type_name** | **String** | The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. | |
|
61
|
-
| **time_granularity** | **String** | | |
|
62
|
-
| **start_date** | **String** | | [optional] |
|
63
|
-
| **end_date** | **String** | | [optional] |
|
64
56
|
| **start_month** | **String** | | [optional] |
|
65
57
|
| **end_month** | **String** | | [optional] |
|
66
58
|
| **limit** | **String** | Number of results per page. The maximum is 100. | [optional][default to '5'] |
|
@@ -72,28 +64,29 @@ end
|
|
72
64
|
|
73
65
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
74
66
|
[[Back to README]](../../README.md)
|
75
|
-
## `
|
67
|
+
## `get_usage_metrics()`
|
76
68
|
|
77
69
|
```ruby
|
78
|
-
|
70
|
+
get_usage_metrics(opts): <Usagemetric> # Get monthly usage metrics
|
79
71
|
```
|
80
72
|
|
81
|
-
Returns
|
73
|
+
Returns monthly usage metrics for customer by product.
|
82
74
|
|
83
75
|
### Examples
|
84
76
|
|
85
77
|
```ruby
|
86
78
|
api_instance = Fastly::BillingUsageMetricsApi.new
|
87
79
|
opts = {
|
88
|
-
|
80
|
+
start_month: '2023-01', # String |
|
81
|
+
end_month: '2023-03', # String |
|
89
82
|
}
|
90
83
|
|
91
84
|
begin
|
92
|
-
#
|
93
|
-
result = api_instance.
|
85
|
+
# Get monthly usage metrics
|
86
|
+
result = api_instance.get_usage_metrics(opts)
|
94
87
|
p result
|
95
88
|
rescue Fastly::ApiError => e
|
96
|
-
puts "Error when calling BillingUsageMetricsApi->
|
89
|
+
puts "Error when calling BillingUsageMetricsApi->get_usage_metrics: #{e}"
|
97
90
|
end
|
98
91
|
```
|
99
92
|
|
@@ -101,11 +94,12 @@ end
|
|
101
94
|
|
102
95
|
| Name | Type | Description | Notes |
|
103
96
|
| ---- | ---- | ----------- | ----- |
|
104
|
-
| **
|
97
|
+
| **start_month** | **String** | | [optional] |
|
98
|
+
| **end_month** | **String** | | [optional] |
|
105
99
|
|
106
100
|
### Return type
|
107
101
|
|
108
|
-
[**
|
102
|
+
[**Usagemetric**](Usagemetric.md)
|
109
103
|
|
110
104
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
111
105
|
[[Back to README]](../../README.md)
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::ComputeAclUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **entries** | [**Array<ComputeAclUpdateEntry>**](ComputeAclUpdateEntry.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::DimensionAttributesCountryStats
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **country_chr** | **Float** | The cache hit ratio for the country. | [optional] |
|
8
|
+
| **country_error_rate** | **Float** | The error rate for the country. | [optional] |
|
9
|
+
| **country_request_rate** | **Float** | This country's percentage of the total requests. | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionAttributesRate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **rate** | **Float** | The rate at which the value in the current dimension occurs. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionBrowser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **browser** | **String** | The client's browser for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionContentType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **content_type** | **String** | The content type of the response for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionCountry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **country** | **String** | The client's country for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionDevice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **device** | **String** | The client's device type for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/DimensionOs.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionOs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **os** | **String** | The client's operating system for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **response** | **String** | The HTTP reason phrase for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionStatusCode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status_code** | **String** | The HTTP response code for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::DimensionUrl
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **url** | **String** | The URL path for this dimension. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/EnabledProductsApi.md
CHANGED
@@ -26,7 +26,7 @@ Method | HTTP request | Description
|
|
26
26
|
disable_product(opts) # Disable a product
|
27
27
|
```
|
28
28
|
|
29
|
-
Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `
|
29
|
+
Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
|
30
30
|
|
31
31
|
### Examples
|
32
32
|
|
@@ -64,7 +64,7 @@ nil (empty response body)
|
|
64
64
|
enable_product(opts): <EnabledProductResponse> # Enable a product
|
65
65
|
```
|
66
66
|
|
67
|
-
Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `
|
67
|
+
Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
|
68
68
|
|
69
69
|
### Examples
|
70
70
|
|
@@ -105,7 +105,7 @@ end
|
|
105
105
|
get_enabled_product(opts): <EnabledProductResponse> # Get enabled product
|
106
106
|
```
|
107
107
|
|
108
|
-
Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `
|
108
|
+
Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, `ngwaf`, `ddos_protection`, and `log_explorer_insights`.
|
109
109
|
|
110
110
|
### Examples
|
111
111
|
|
@@ -144,7 +144,7 @@ end
|
|
144
144
|
get_product_configuration(opts): <ConfiguredProductResponse> # Get configuration for a product
|
145
145
|
```
|
146
146
|
|
147
|
-
Get configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
|
147
|
+
Get configuration for an enabled product on a service. Supported product IDs: `ngwaf` and `ddos_protection`.
|
148
148
|
|
149
149
|
### Examples
|
150
150
|
|
@@ -183,7 +183,7 @@ end
|
|
183
183
|
set_product_configuration(opts): <ConfiguredProductResponse> # Update configuration for a product
|
184
184
|
```
|
185
185
|
|
186
|
-
Update configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
|
186
|
+
Update configuration for an enabled product on a service. Supported product IDs: `ngwaf` and `ddos_protection`.
|
187
187
|
|
188
188
|
### Examples
|
189
189
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::FilterFieldItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **field** | **String** | The log field to which this filter should be applied. | [optional] |
|
8
|
+
| **operator** | **String** | The comparison operator used for this filter. | [optional] |
|
9
|
+
| **value** | [**ValueField**](ValueField.md) | | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::GetLogInsightsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<LogInsights>**](LogInsights.md) | | [optional] |
|
8
|
+
| **meta** | [**LogInsightsMeta**](LogInsightsMeta.md) | | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::GetLogRecordsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<LogRecord>**](LogRecord.md) | | [optional] |
|
8
|
+
| **meta** | [**GetLogRecordsResponseMeta**](GetLogRecordsResponseMeta.md) | | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::GetLogRecordsResponseMeta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **filters** | [**GetLogRecordsResponseMetaFilters**](GetLogRecordsResponseMetaFilters.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# Fastly::GetLogRecordsResponseMetaFilters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **service_id** | **String** | Specifies the ID of the service for which data should be returned. | [optional] |
|
8
|
+
| **start** | **String** | Start time for the query as supplied in the request. | [optional] |
|
9
|
+
| **_end** | **String** | End time for the query as supplied in the request. | [optional] |
|
10
|
+
| **domain_exact_match** | **Boolean** | Value of the `domain_exact_match` filter as supplied in the request. | [optional] |
|
11
|
+
| **limit** | **Integer** | Number of records per page. | [optional][default to 20] |
|
12
|
+
| **next_cursor** | **String** | A cursor to specify the next page of results, if any. | [optional] |
|
13
|
+
| **filter_fields** | [**Array<FilterFieldItem>**](FilterFieldItem.md) | | [optional] |
|
14
|
+
|
15
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
16
|
+
|
data/docs/InsightsApi.md
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
# Fastly::InsightsApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::InsightsApi.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_log_insights**](InsightsApi.md#get_log_insights) | **GET** /observability/log-insights | Retrieve log insights
|
17
|
+
|
18
|
+
|
19
|
+
## `get_log_insights()`
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
get_log_insights(opts): <GetLogInsightsResponse> # Retrieve log insights
|
23
|
+
```
|
24
|
+
|
25
|
+
Retrieves statistics from sampled log records.
|
26
|
+
|
27
|
+
### Examples
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
api_instance = Fastly::InsightsApi.new
|
31
|
+
opts = {
|
32
|
+
visualization: 'top-url-by-bandwidth', # String |
|
33
|
+
service_id: 'service_id_example', # String |
|
34
|
+
start: 'start_example', # String |
|
35
|
+
_end: '_end_example', # String |
|
36
|
+
pops: 'pops_example', # String |
|
37
|
+
domain: 'domain_example', # String |
|
38
|
+
domain_exact_match: true, # Boolean |
|
39
|
+
limit: 8.14, # Float |
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
# Retrieve log insights
|
44
|
+
result = api_instance.get_log_insights(opts)
|
45
|
+
p result
|
46
|
+
rescue Fastly::ApiError => e
|
47
|
+
puts "Error when calling InsightsApi->get_log_insights: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
### Options
|
52
|
+
|
53
|
+
| Name | Type | Description | Notes |
|
54
|
+
| ---- | ---- | ----------- | ----- |
|
55
|
+
| **visualization** | **String** | | |
|
56
|
+
| **service_id** | **String** | | |
|
57
|
+
| **start** | **String** | | |
|
58
|
+
| **_end** | **String** | | |
|
59
|
+
| **pops** | **String** | | [optional] |
|
60
|
+
| **domain** | **String** | | [optional] |
|
61
|
+
| **domain_exact_match** | **Boolean** | | [optional] |
|
62
|
+
| **limit** | **Float** | | [optional] |
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
[**GetLogInsightsResponse**](GetLogInsightsResponse.md)
|
67
|
+
|
68
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
69
|
+
[[Back to README]](../../README.md)
|
data/docs/KvStoreItemApi.md
CHANGED
@@ -74,6 +74,7 @@ opts = {
|
|
74
74
|
cursor: 'cursor_example', # String |
|
75
75
|
limit: 56, # Integer |
|
76
76
|
prefix: 'prefix_example', # String |
|
77
|
+
consistency: 'consistency_example', # String |
|
77
78
|
}
|
78
79
|
|
79
80
|
begin
|
@@ -93,6 +94,7 @@ end
|
|
93
94
|
| **cursor** | **String** | | [optional] |
|
94
95
|
| **limit** | **Integer** | | [optional][default to 100] |
|
95
96
|
| **prefix** | **String** | | [optional] |
|
97
|
+
| **consistency** | **String** | | [optional] |
|
96
98
|
|
97
99
|
### Return type
|
98
100
|
|