fastly 8.5.0 → 8.7.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 +17 -0
- data/Gemfile.lock +1 -1
- data/README.md +15 -2
- data/docs/{RelationshipTlsDnsRecord.md → AsyncResponse.md} +3 -2
- data/docs/Billing.md +1 -2
- data/docs/BillingApi.md +2 -2
- data/docs/BillingBandwidth.md +11 -0
- data/docs/BillingBandwidthTiers.md +14 -0
- data/docs/{RelationshipTlsDnsRecords.md → BillingEstimateInvoiceId.md} +2 -2
- data/docs/BillingEstimateResponse.md +2 -2
- data/docs/{RelationshipTlsDnsRecordDnsRecord.md → BillingInvoiceId.md} +2 -2
- data/docs/BillingInvoicesApi.md +39 -6
- data/docs/BillingRegions.md +13 -0
- data/docs/BillingResponse.md +2 -2
- data/docs/BillingResponseLineItem.md +1 -1
- data/docs/BillingUsageMetricsApi.md +111 -0
- data/docs/CreateDashboardRequest.md +12 -0
- data/docs/Dashboard.md +17 -0
- data/docs/DashboardItem.md +15 -0
- data/docs/DashboardItemPropertyDataSource.md +11 -0
- data/docs/DashboardItemPropertyDataSourcePropertyConfig.md +10 -0
- data/docs/DashboardItemPropertyVisualization.md +11 -0
- data/docs/DashboardItemPropertyVisualizationPropertyConfig.md +12 -0
- data/docs/{LineItemDataReadOnlyInvoiceId.md → DashboardPropertyCreatedBy.md} +1 -1
- data/docs/DashboardPropertyUpdatedBy.md +9 -0
- data/docs/DomainInspectorMeasurements.md +1 -1
- data/docs/{InvoiceResponse.md → EomInvoiceResponse.md} +2 -2
- data/docs/GetServiceLevelUsageResponse.md +10 -0
- data/docs/GetServiceLevelUsageTypesResponse.md +10 -0
- data/docs/IncludedWithTlsConfiguration.md +10 -0
- data/docs/IncludedWithTlsConfigurationItem.md +12 -0
- data/docs/Invoice.md +1 -1
- data/docs/LineItemData.md +1 -1
- data/docs/ListDashboardsResponse.md +11 -0
- data/docs/{ListInvoicesResponse.md → ListEomInvoicesResponse.md} +1 -1
- data/docs/MtdInvoiceResponse.md +15 -0
- data/docs/Mtdinvoice.md +15 -0
- data/docs/Mtdlineitems.md +18 -0
- data/docs/ObservabilityCustomDashboardsApi.md +203 -0
- data/docs/RealtimeEntryAggregated.md +1 -0
- data/docs/RealtimeMeasurements.md +1 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificate.md +10 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificate.md +10 -0
- data/docs/RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificateData.md +11 -0
- data/docs/RelationshipDefaultTlsCertificate.md +10 -0
- data/docs/RelationshipDefaultTlsCertificateDefaultCertificate.md +10 -0
- data/docs/RelationshipDefaultTlsCertificateDefaultCertificateData.md +11 -0
- data/docs/RelationshipTlsDnsRecordsRequest.md +10 -0
- data/docs/RelationshipTlsDnsRecordsRequestDnsRecords.md +10 -0
- data/docs/RelationshipTlsDnsRecordsRequestDnsRecordsData.md +11 -0
- data/docs/RelationshipTlsDnsRecordsResponse.md +10 -0
- data/docs/RelationshipTlsDnsRecordsResponseDnsRecords.md +10 -0
- data/docs/{RelationshipMemberTlsDnsRecord.md → RelationshipTlsDnsRecordsResponseDnsRecordsData.md} +1 -1
- data/docs/Results.md +1 -0
- data/docs/Serviceusagemetric.md +13 -0
- data/docs/Serviceusagemetrics.md +10 -0
- data/docs/ServiceusagemetricsData.md +16 -0
- data/docs/Serviceusagetype.md +11 -0
- data/docs/Serviceusagetypes.md +10 -0
- data/docs/TlsCertificateBlobResponse.md +10 -0
- data/docs/TlsCertificatesApi.md +38 -0
- data/docs/TlsDnsRecord.md +1 -2
- data/docs/UpdateDashboardRequest.md +12 -0
- data/docs/Values.md +1 -1
- data/lib/fastly/api/billing_api.rb +2 -2
- data/lib/fastly/api/billing_invoices_api.rb +64 -8
- data/lib/fastly/api/billing_usage_metrics_api.rb +213 -0
- data/lib/fastly/api/observability_custom_dashboards_api.rb +333 -0
- data/lib/fastly/api/tls_certificates_api.rb +63 -0
- data/lib/fastly/configuration.rb +54 -0
- data/lib/fastly/models/async_response.rb +225 -0
- data/lib/fastly/models/billing.rb +2 -11
- data/lib/fastly/models/billing_bandwidth.rb +227 -0
- data/lib/fastly/models/billing_bandwidth_tiers.rb +252 -0
- data/lib/fastly/models/{relationship_tls_dns_record.rb → billing_estimate_invoice_id.rb} +10 -10
- data/lib/fastly/models/billing_estimate_response.rb +12 -11
- data/lib/fastly/models/billing_invoice_id.rb +216 -0
- data/lib/fastly/models/billing_regions.rb +243 -0
- data/lib/fastly/models/billing_response.rb +12 -11
- data/lib/fastly/models/billing_response_line_item.rb +2 -1
- data/lib/fastly/models/create_dashboard_request.rb +245 -0
- data/lib/fastly/models/dashboard.rb +290 -0
- data/lib/fastly/models/dashboard_item.rb +368 -0
- data/lib/fastly/models/dashboard_item_property_data_source.rb +271 -0
- data/lib/fastly/models/dashboard_item_property_data_source_property_config.rb +244 -0
- data/lib/fastly/models/dashboard_item_property_visualization.rb +271 -0
- data/lib/fastly/models/dashboard_item_property_visualization_property_config.rb +303 -0
- data/lib/fastly/models/{line_item_data_read_only_invoice_id.rb → dashboard_property_created_by.rb} +4 -3
- data/lib/fastly/models/dashboard_property_updated_by.rb +208 -0
- data/lib/fastly/models/domain_inspector_measurements.rb +1 -1
- data/lib/fastly/models/{invoice_response.rb → eom_invoice_response.rb} +4 -4
- data/lib/fastly/models/get_service_level_usage_response.rb +223 -0
- data/lib/fastly/models/get_service_level_usage_types_response.rb +225 -0
- data/lib/fastly/models/included_with_tls_configuration.rb +218 -0
- data/lib/fastly/models/included_with_tls_configuration_item.rb +237 -0
- data/lib/fastly/models/invoice.rb +1 -1
- data/lib/fastly/models/invoicelineitems.rb +5 -5
- data/lib/fastly/models/line_item_data.rb +2 -1
- data/lib/fastly/models/list_dashboards_response.rb +229 -0
- data/lib/fastly/models/{list_invoices_response.rb → list_eom_invoices_response.rb} +3 -3
- data/lib/fastly/models/mtd_invoice_response.rb +275 -0
- data/lib/fastly/models/mtdinvoice.rb +268 -0
- data/lib/fastly/models/mtdlineitems.rb +297 -0
- data/lib/fastly/models/realtime_entry_aggregated.rb +14 -4
- data/lib/fastly/models/realtime_measurements.rb +14 -4
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate_default_ecdsa_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_ecdsa_tls_certificate_default_ecdsa_certificate_data.rb +228 -0
- data/lib/fastly/models/relationship_default_tls_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_tls_certificate_default_certificate.rb +216 -0
- data/lib/fastly/models/relationship_default_tls_certificate_default_certificate_data.rb +228 -0
- data/lib/fastly/models/{relationship_tls_dns_records.rb → relationship_tls_dns_records_request.rb} +4 -4
- data/lib/fastly/models/relationship_tls_dns_records_request_dns_records.rb +218 -0
- data/lib/fastly/models/{relationship_member_tls_dns_record.rb → relationship_tls_dns_records_request_dns_records_data.rb} +3 -3
- data/lib/fastly/models/relationship_tls_dns_records_response.rb +216 -0
- data/lib/fastly/models/relationship_tls_dns_records_response_dns_records.rb +218 -0
- data/lib/fastly/models/relationship_tls_dns_records_response_dns_records_data.rb +227 -0
- data/lib/fastly/models/relationships_for_tls_configuration.rb +1 -1
- data/lib/fastly/models/results.rb +11 -1
- data/lib/fastly/models/serviceusagemetric.rb +246 -0
- data/lib/fastly/models/serviceusagemetrics.rb +216 -0
- data/lib/fastly/models/serviceusagemetrics_data.rb +276 -0
- data/lib/fastly/models/serviceusagetype.rb +227 -0
- data/lib/fastly/models/{relationship_tls_dns_record_dns_record.rb → serviceusagetypes.rb} +4 -4
- data/lib/fastly/models/tls_certificate_blob_response.rb +217 -0
- data/lib/fastly/models/tls_dns_record.rb +48 -12
- data/lib/fastly/models/update_dashboard_request.rb +240 -0
- data/lib/fastly/models/values.rb +1 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +46 -7
- data/sig.json +1 -1
- metadata +94 -16
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::IncludedWithTlsConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **included** | [**Array<IncludedWithTlsConfigurationItem>**](IncludedWithTlsConfigurationItem.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::IncludedWithTlsConfigurationItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The IP address or hostname of the DNS record. | [optional] |
|
8
|
+
| **type** | [**TypeTlsDnsRecord**](TypeTlsDnsRecord.md) | | [optional][default to 'dns_record'] |
|
9
|
+
| **attributes** | [**TlsDnsRecord**](TlsDnsRecord.md) | | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
data/docs/Invoice.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **customer_id** | **String** | Customer ID associated with the invoice. | [optional] |
|
8
|
-
| **invoice_id** | **String** |
|
8
|
+
| **invoice_id** | **String** | Numeric string identifying the invoice. | [optional] |
|
9
9
|
| **invoice_posted_on** | **Time** | Date and time invoice was posted on, in ISO 8601 format. | [optional] |
|
10
10
|
| **billing_start_date** | **Time** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
|
11
11
|
| **billing_end_date** | **Time** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |
|
data/docs/LineItemData.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **amount** | **Float** | | [optional] |
|
8
|
-
| **aria_invoice_id** |
|
8
|
+
| **aria_invoice_id** | **String** | An alphanumeric string identifying the invoice. | [optional][readonly] |
|
9
9
|
| **client_service_id** | **String** | | [optional] |
|
10
10
|
| **credit_coupon_code** | **String** | | [optional] |
|
11
11
|
| **description** | **String** | | [optional] |
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::ListDashboardsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Dashboard>**](Dashboard.md) | | [optional] |
|
8
|
+
| **meta** | **Object** | Meta for the pagination. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Fastly::MtdInvoiceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_id** | **String** | The Customer ID associated with the invoice. | [optional] |
|
8
|
+
| **invoice_id** | **String** | An alphanumeric string identifying the invoice. | [optional] |
|
9
|
+
| **billing_start_date** | **Time** | The date and time (in ISO 8601 format) for the initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
|
10
|
+
| **billing_end_date** | **Time** | The date and time (in ISO 8601 format) for the termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |
|
11
|
+
| **monthly_transaction_amount** | **String** | The total billable amount for invoiced services charged within a single month. | [optional] |
|
12
|
+
| **transaction_line_items** | [**Array<Mtdlineitems>**](Mtdlineitems.md) | | [optional] |
|
13
|
+
|
14
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
15
|
+
|
data/docs/Mtdinvoice.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# Fastly::Mtdinvoice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_id** | **String** | The Customer ID associated with the invoice. | [optional] |
|
8
|
+
| **invoice_id** | **String** | An alphanumeric string identifying the invoice. | [optional] |
|
9
|
+
| **billing_start_date** | **Time** | The date and time (in ISO 8601 format) for the initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
|
10
|
+
| **billing_end_date** | **Time** | The date and time (in ISO 8601 format) for the termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |
|
11
|
+
| **monthly_transaction_amount** | **String** | The total billable amount for invoiced services charged within a single month. | [optional] |
|
12
|
+
| **transaction_line_items** | [**Array<Mtdlineitems>**](Mtdlineitems.md) | | [optional] |
|
13
|
+
|
14
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
15
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Fastly::Mtdlineitems
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | Invoice line item transaction name. | [optional] |
|
8
|
+
| **amount** | **Float** | Billed amount for line item. | [optional] |
|
9
|
+
| **rate** | **Float** | Price per unit. | [optional] |
|
10
|
+
| **units** | **Float** | Total number of units of usage. | [optional] |
|
11
|
+
| **product_name** | **String** | The name of the product. | [optional] |
|
12
|
+
| **product_group** | **String** | The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`). | [optional] |
|
13
|
+
| **product_line** | **String** | The broader classification of the product (e.g., `Network Services` or `Security`). | [optional] |
|
14
|
+
| **region** | **String** | The geographical area applicable for regionally based products. | [optional] |
|
15
|
+
| **usage_type** | **String** | The unit of measure (e.g., `requests` or `bandwidth`). | [optional] |
|
16
|
+
|
17
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
18
|
+
|
@@ -0,0 +1,203 @@
|
|
1
|
+
# Fastly::ObservabilityCustomDashboardsApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.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
|
+
[**create_dashboard**](ObservabilityCustomDashboardsApi.md#create_dashboard) | **POST** /observability/dashboards | Create a new dashboard
|
17
|
+
[**delete_dashboard**](ObservabilityCustomDashboardsApi.md#delete_dashboard) | **DELETE** /observability/dashboards/{dashboard_id} | Delete an existing dashboard
|
18
|
+
[**get_dashboard**](ObservabilityCustomDashboardsApi.md#get_dashboard) | **GET** /observability/dashboards/{dashboard_id} | Retrieve a dashboard by ID
|
19
|
+
[**list_dashboards**](ObservabilityCustomDashboardsApi.md#list_dashboards) | **GET** /observability/dashboards | List all custom dashboards
|
20
|
+
[**update_dashboard**](ObservabilityCustomDashboardsApi.md#update_dashboard) | **PATCH** /observability/dashboards/{dashboard_id} | Update an existing dashboard
|
21
|
+
|
22
|
+
|
23
|
+
## `create_dashboard()`
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
create_dashboard(opts): <Dashboard> # Create a new dashboard
|
27
|
+
```
|
28
|
+
|
29
|
+
Create a new dashboard
|
30
|
+
|
31
|
+
### Examples
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.new
|
35
|
+
opts = {
|
36
|
+
create_dashboard_request: Fastly::CreateDashboardRequest.new({name: 'name_example'}), # CreateDashboardRequest |
|
37
|
+
}
|
38
|
+
|
39
|
+
begin
|
40
|
+
# Create a new dashboard
|
41
|
+
result = api_instance.create_dashboard(opts)
|
42
|
+
p result
|
43
|
+
rescue Fastly::ApiError => e
|
44
|
+
puts "Error when calling ObservabilityCustomDashboardsApi->create_dashboard: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Options
|
49
|
+
|
50
|
+
| Name | Type | Description | Notes |
|
51
|
+
| ---- | ---- | ----------- | ----- |
|
52
|
+
| **create_dashboard_request** | [**CreateDashboardRequest**](CreateDashboardRequest.md) | | [optional] |
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**Dashboard**](Dashboard.md)
|
57
|
+
|
58
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
59
|
+
[[Back to README]](../../README.md)
|
60
|
+
## `delete_dashboard()`
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
delete_dashboard(opts) # Delete an existing dashboard
|
64
|
+
```
|
65
|
+
|
66
|
+
Delete an existing dashboard
|
67
|
+
|
68
|
+
### Examples
|
69
|
+
|
70
|
+
```ruby
|
71
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.new
|
72
|
+
opts = {
|
73
|
+
dashboard_id: '2eGFXF4F4kTxd4gU39Bg3e', # String |
|
74
|
+
}
|
75
|
+
|
76
|
+
begin
|
77
|
+
# Delete an existing dashboard
|
78
|
+
api_instance.delete_dashboard(opts)
|
79
|
+
rescue Fastly::ApiError => e
|
80
|
+
puts "Error when calling ObservabilityCustomDashboardsApi->delete_dashboard: #{e}"
|
81
|
+
end
|
82
|
+
```
|
83
|
+
|
84
|
+
### Options
|
85
|
+
|
86
|
+
| Name | Type | Description | Notes |
|
87
|
+
| ---- | ---- | ----------- | ----- |
|
88
|
+
| **dashboard_id** | **String** | | |
|
89
|
+
|
90
|
+
### Return type
|
91
|
+
|
92
|
+
nil (empty response body)
|
93
|
+
|
94
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
95
|
+
[[Back to README]](../../README.md)
|
96
|
+
## `get_dashboard()`
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
get_dashboard(opts): <Dashboard> # Retrieve a dashboard by ID
|
100
|
+
```
|
101
|
+
|
102
|
+
Retrieve a dashboard by ID
|
103
|
+
|
104
|
+
### Examples
|
105
|
+
|
106
|
+
```ruby
|
107
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.new
|
108
|
+
opts = {
|
109
|
+
dashboard_id: '2eGFXF4F4kTxd4gU39Bg3e', # String |
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
# Retrieve a dashboard by ID
|
114
|
+
result = api_instance.get_dashboard(opts)
|
115
|
+
p result
|
116
|
+
rescue Fastly::ApiError => e
|
117
|
+
puts "Error when calling ObservabilityCustomDashboardsApi->get_dashboard: #{e}"
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
### Options
|
122
|
+
|
123
|
+
| Name | Type | Description | Notes |
|
124
|
+
| ---- | ---- | ----------- | ----- |
|
125
|
+
| **dashboard_id** | **String** | | |
|
126
|
+
|
127
|
+
### Return type
|
128
|
+
|
129
|
+
[**Dashboard**](Dashboard.md)
|
130
|
+
|
131
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
132
|
+
[[Back to README]](../../README.md)
|
133
|
+
## `list_dashboards()`
|
134
|
+
|
135
|
+
```ruby
|
136
|
+
list_dashboards: <ListDashboardsResponse> # List all custom dashboards
|
137
|
+
```
|
138
|
+
|
139
|
+
List all custom dashboards
|
140
|
+
|
141
|
+
### Examples
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.new
|
145
|
+
|
146
|
+
begin
|
147
|
+
# List all custom dashboards
|
148
|
+
result = api_instance.list_dashboards
|
149
|
+
p result
|
150
|
+
rescue Fastly::ApiError => e
|
151
|
+
puts "Error when calling ObservabilityCustomDashboardsApi->list_dashboards: #{e}"
|
152
|
+
end
|
153
|
+
```
|
154
|
+
|
155
|
+
### Options
|
156
|
+
|
157
|
+
This endpoint does not need any parameter.
|
158
|
+
|
159
|
+
### Return type
|
160
|
+
|
161
|
+
[**ListDashboardsResponse**](ListDashboardsResponse.md)
|
162
|
+
|
163
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
164
|
+
[[Back to README]](../../README.md)
|
165
|
+
## `update_dashboard()`
|
166
|
+
|
167
|
+
```ruby
|
168
|
+
update_dashboard(opts): <Dashboard> # Update an existing dashboard
|
169
|
+
```
|
170
|
+
|
171
|
+
Update an existing dashboard
|
172
|
+
|
173
|
+
### Examples
|
174
|
+
|
175
|
+
```ruby
|
176
|
+
api_instance = Fastly::ObservabilityCustomDashboardsApi.new
|
177
|
+
opts = {
|
178
|
+
dashboard_id: '2eGFXF4F4kTxd4gU39Bg3e', # String |
|
179
|
+
update_dashboard_request: Fastly::UpdateDashboardRequest.new, # UpdateDashboardRequest |
|
180
|
+
}
|
181
|
+
|
182
|
+
begin
|
183
|
+
# Update an existing dashboard
|
184
|
+
result = api_instance.update_dashboard(opts)
|
185
|
+
p result
|
186
|
+
rescue Fastly::ApiError => e
|
187
|
+
puts "Error when calling ObservabilityCustomDashboardsApi->update_dashboard: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
### Options
|
192
|
+
|
193
|
+
| Name | Type | Description | Notes |
|
194
|
+
| ---- | ---- | ----------- | ----- |
|
195
|
+
| **dashboard_id** | **String** | | |
|
196
|
+
| **update_dashboard_request** | [**UpdateDashboardRequest**](UpdateDashboardRequest.md) | | [optional] |
|
197
|
+
|
198
|
+
### Return type
|
199
|
+
|
200
|
+
[**Dashboard**](Dashboard.md)
|
201
|
+
|
202
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
203
|
+
[[Back to README]](../../README.md)
|
@@ -252,6 +252,7 @@
|
|
252
252
|
| **all_status_3xx** | **Integer** | Number of \"Redirection\" codes delivered for all sources. | [optional] |
|
253
253
|
| **all_status_4xx** | **Integer** | Number of \"Client Error\" codes delivered for all sources. | [optional] |
|
254
254
|
| **all_status_5xx** | **Integer** | Number of \"Server Error\" codes delivered for all sources. | [optional] |
|
255
|
+
| **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
|
255
256
|
|
256
257
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
257
258
|
|
@@ -252,6 +252,7 @@
|
|
252
252
|
| **all_status_3xx** | **Integer** | Number of \"Redirection\" codes delivered for all sources. | [optional] |
|
253
253
|
| **all_status_4xx** | **Integer** | Number of \"Client Error\" codes delivered for all sources. | [optional] |
|
254
254
|
| **all_status_5xx** | **Integer** | Number of \"Server Error\" codes delivered for all sources. | [optional] |
|
255
|
+
| **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
|
255
256
|
|
256
257
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
257
258
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipDefaultEcdsaTlsCertificate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **default_ecdsa_certificate** | [**RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificate**](RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificate.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificateData**](RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificateData.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::RelationshipDefaultEcdsaTlsCertificateDefaultEcdsaCertificateData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**TypeTlsCertificate**](TypeTlsCertificate.md) | | [optional][default to 'tls_certificate'] |
|
8
|
+
| **id** | **String** | Alphanumeric string identifying the default ECDSA TLS certificate. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipDefaultTlsCertificate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **default_certificate** | [**RelationshipDefaultTlsCertificateDefaultCertificate**](RelationshipDefaultTlsCertificateDefaultCertificate.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipDefaultTlsCertificateDefaultCertificate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**RelationshipDefaultTlsCertificateDefaultCertificateData**](RelationshipDefaultTlsCertificateDefaultCertificateData.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::RelationshipDefaultTlsCertificateDefaultCertificateData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**TypeTlsCertificate**](TypeTlsCertificate.md) | | [optional][default to 'tls_certificate'] |
|
8
|
+
| **id** | **String** | Alphanumeric string identifying the default TLS certificate. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipTlsDnsRecordsRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **dns_records** | [**RelationshipTlsDnsRecordsRequestDnsRecords**](RelationshipTlsDnsRecordsRequestDnsRecords.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipTlsDnsRecordsRequestDnsRecords
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<RelationshipTlsDnsRecordsRequestDnsRecordsData>**](RelationshipTlsDnsRecordsRequestDnsRecordsData.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::RelationshipTlsDnsRecordsRequestDnsRecordsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**TypeTlsDnsRecord**](TypeTlsDnsRecord.md) | | [optional][default to 'dns_record'] |
|
8
|
+
| **id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipTlsDnsRecordsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **dns_records** | [**RelationshipTlsDnsRecordsResponseDnsRecords**](RelationshipTlsDnsRecordsResponseDnsRecords.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::RelationshipTlsDnsRecordsResponseDnsRecords
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<RelationshipTlsDnsRecordsResponseDnsRecordsData>**](RelationshipTlsDnsRecordsResponseDnsRecordsData.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/Results.md
CHANGED
@@ -252,6 +252,7 @@
|
|
252
252
|
| **all_status_3xx** | **Integer** | Number of \"Redirection\" codes delivered for all sources. | [optional] |
|
253
253
|
| **all_status_4xx** | **Integer** | Number of \"Client Error\" codes delivered for all sources. | [optional] |
|
254
254
|
| **all_status_5xx** | **Integer** | Number of \"Server Error\" codes delivered for all sources. | [optional] |
|
255
|
+
| **origin_offload** | **Float** | Origin Offload measures the ratio of bytes served to end users that were cached by Fastly, over the bytes served to end users, between 0 and 1. ((`edge_resp_body_bytes` + `edge_resp_header_bytes`) - (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes`)) / (`edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
|
255
256
|
| **service_id** | **String** | | [optional][readonly] |
|
256
257
|
| **start_time** | **Integer** | Timestamp for the start of the time period being reported | [optional] |
|
257
258
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Fastly::Serviceusagemetric
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_id** | **String** | | [optional][readonly] |
|
8
|
+
| **service_id** | **String** | Service ID associated with the usage. | [optional] |
|
9
|
+
| **service_name** | **String** | Name of the service associated with the usage. | [optional] |
|
10
|
+
| **usage_units** | **Float** | The quantity of the usage for the billing period. Amount will be in the units provided in the parent object (e.g., a quantity of `1.3` with a unit of `gb` would have a usage amount of 1.3 gigabytes). | [optional] |
|
11
|
+
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::Serviceusagemetrics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**ServiceusagemetricsData**](ServiceusagemetricsData.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# Fastly::ServiceusagemetricsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_id** | **String** | | [optional][readonly] |
|
8
|
+
| **start_time** | **Time** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
|
9
|
+
| **end_time** | **Time** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |
|
10
|
+
| **usage_type** | **String** | The usage type identifier for the usage. This is a single, billable metric for the product. | [optional] |
|
11
|
+
| **unit** | **String** | The unit for the usage as shown on an invoice. If there is no explicit unit, this field will be \"unit\" (e.g., a request with `product_id` of 'cdn_usage' and `usage_type` of 'North America Requests' has no unit, and will return \"unit\"). | [optional] |
|
12
|
+
| **details** | [**Array<Serviceusagemetric>**](Serviceusagemetric.md) | | [optional] |
|
13
|
+
| **meta** | [**Metadata**](Metadata.md) | | [optional] |
|
14
|
+
|
15
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
16
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::Serviceusagetype
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **product_id** | **String** | The product identifier associated with the usage type. This corresponds to a Fastly product offering. | [optional] |
|
8
|
+
| **name** | **String** | Full name of the product usage type as it might appear on a customer's invoice. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::Serviceusagetypes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Serviceusagetype>**](Serviceusagetype.md) | | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::TlsCertificateBlobResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cert_blob** | **String** | A certificate blob | [optional][readonly] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/TlsCertificatesApi.md
CHANGED
@@ -16,6 +16,7 @@ Method | HTTP request | Description
|
|
16
16
|
[**create_tls_cert**](TlsCertificatesApi.md#create_tls_cert) | **POST** /tls/certificates | Create a TLS certificate
|
17
17
|
[**delete_tls_cert**](TlsCertificatesApi.md#delete_tls_cert) | **DELETE** /tls/certificates/{tls_certificate_id} | Delete a TLS certificate
|
18
18
|
[**get_tls_cert**](TlsCertificatesApi.md#get_tls_cert) | **GET** /tls/certificates/{tls_certificate_id} | Get a TLS certificate
|
19
|
+
[**get_tls_cert_blob**](TlsCertificatesApi.md#get_tls_cert_blob) | **GET** /tls/certificates/{tls_certificate_id}/blob | Get a TLS certificate blob (Limited Availability)
|
19
20
|
[**list_tls_certs**](TlsCertificatesApi.md#list_tls_certs) | **GET** /tls/certificates | List TLS certificates
|
20
21
|
[**update_tls_cert**](TlsCertificatesApi.md#update_tls_cert) | **PATCH** /tls/certificates/{tls_certificate_id} | Update a TLS certificate
|
21
22
|
|
@@ -128,6 +129,43 @@ end
|
|
128
129
|
|
129
130
|
[**TlsCertificateResponse**](TlsCertificateResponse.md)
|
130
131
|
|
132
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
133
|
+
[[Back to README]](../../README.md)
|
134
|
+
## `get_tls_cert_blob()`
|
135
|
+
|
136
|
+
```ruby
|
137
|
+
get_tls_cert_blob(opts): <TlsCertificateBlobResponse> # Get a TLS certificate blob (Limited Availability)
|
138
|
+
```
|
139
|
+
|
140
|
+
Retrieve a TLS certificate blob. This feature is part of a [limited availability](https://docs.fastly.com/products/fastly-product-lifecycle#limited-availability) release.
|
141
|
+
|
142
|
+
### Examples
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
api_instance = Fastly::TlsCertificatesApi.new
|
146
|
+
opts = {
|
147
|
+
tls_certificate_id: 'tls_certificate_id_example', # String | Alphanumeric string identifying a TLS certificate.
|
148
|
+
}
|
149
|
+
|
150
|
+
begin
|
151
|
+
# Get a TLS certificate blob (Limited Availability)
|
152
|
+
result = api_instance.get_tls_cert_blob(opts)
|
153
|
+
p result
|
154
|
+
rescue Fastly::ApiError => e
|
155
|
+
puts "Error when calling TlsCertificatesApi->get_tls_cert_blob: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Options
|
160
|
+
|
161
|
+
| Name | Type | Description | Notes |
|
162
|
+
| ---- | ---- | ----------- | ----- |
|
163
|
+
| **tls_certificate_id** | **String** | Alphanumeric string identifying a TLS certificate. | |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**TlsCertificateBlobResponse**](TlsCertificateBlobResponse.md)
|
168
|
+
|
131
169
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
132
170
|
[[Back to README]](../../README.md)
|
133
171
|
## `list_tls_certs()`
|
data/docs/TlsDnsRecord.md
CHANGED
@@ -4,8 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **region** | **String** | Specifies the regions that will be used to route traffic. Select DNS Records with a `global` region to route traffic to the most performant point of presence (POP) worldwide (global pricing will apply). Select DNS records with a `us-eu` region to exclusively land traffic on North American and European POPs. | [optional] |
|
7
|
+
| **region** | **String** | Specifies the regions that will be used to route traffic. Select DNS records with a `global` region to route traffic to the most performant point of presence (POP) worldwide (global pricing will apply). Select DNS records with a `na/eu` region to exclusively land traffic on North American and European POPs. | [optional] |
|
9
8
|
| **record_type** | **String** | The type of the DNS record. `A` specifies an IPv4 address to be used for an A record to be used for apex domains (e.g., `example.com`). `AAAA` specifies an IPv6 address for use in an A record for apex domains. `CNAME` specifies the hostname to be used for a CNAME record for subdomains or wildcard domains (e.g., `www.example.com` or `*.example.com`). | [optional] |
|
10
9
|
|
11
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::UpdateDashboardRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A human-readable name | [optional] |
|
8
|
+
| **description** | **String** | A short description of the dashboard | [optional] |
|
9
|
+
| **items** | [**Array<DashboardItem>**](DashboardItem.md) | A list of [dashboard items](#dashboard-item). | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|