fastly 8.0.1 → 8.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +198 -130
- data/Gemfile.lock +1 -1
- data/README.md +13 -7
- data/docs/{ErrorResponse.md → AutomationTokenErrorResponse.md} +1 -1
- data/docs/AutomationTokensApi.md +2 -2
- data/docs/Backend.md +1 -1
- data/docs/BackendApi.md +4 -4
- data/docs/BackendResponse.md +1 -1
- data/docs/BillingInvoicesApi.md +96 -0
- data/docs/Director.md +1 -1
- data/docs/DirectorApi.md +2 -2
- data/docs/DirectorResponse.md +1 -1
- data/docs/DomainInspectorHistoricalApi.md +4 -4
- data/docs/DomainInspectorRealtimeEntry.md +1 -1
- data/docs/Error.md +13 -0
- data/docs/ErrorResponseData.md +11 -0
- data/docs/Invoice.md +18 -0
- data/docs/InvoiceResponse.md +18 -0
- data/docs/Invoicelineitems.md +18 -0
- data/docs/KvStoreApi.md +1 -1
- data/docs/ListInvoicesResponse.md +11 -0
- data/docs/Listinvoices.md +11 -0
- data/docs/LoggingScalyrAdditional.md +1 -1
- data/docs/LoggingScalyrApi.md +4 -4
- data/docs/LoggingScalyrResponse.md +1 -1
- data/docs/Metadata.md +13 -0
- data/docs/OriginInspectorHistoricalApi.md +4 -4
- data/docs/OriginInspectorRealtimeEntry.md +1 -1
- data/docs/PoolAdditional.md +1 -1
- data/docs/PoolApi.md +4 -4
- data/docs/PoolResponse.md +1 -1
- data/docs/PoolResponsePost.md +1 -1
- data/docs/Pop.md +2 -2
- data/docs/PublishApi.md +1 -1
- data/docs/RealtimeEntry.md +1 -1
- data/docs/Results.md +2 -0
- data/docs/SecretStoreApi.md +4 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/ServiceDetail.md +1 -1
- data/docs/ServiceListResponse.md +2 -2
- data/docs/ServiceListResponseAllOf.md +2 -2
- data/docs/ServiceResponse.md +1 -1
- data/docs/ServiceResponseAllOf.md +1 -1
- data/docs/TlsConfigurationResponseAttributes.md +1 -1
- data/docs/TlsConfigurationResponseAttributesAllOf.md +1 -1
- data/docs/TlsCsr.md +10 -0
- data/docs/TlsCsrData.md +12 -0
- data/docs/TlsCsrDataAttributes.md +20 -0
- data/docs/TlsCsrErrorResponse.md +10 -0
- data/docs/TlsCsrResponse.md +10 -0
- data/docs/TlsCsrResponseAttributes.md +10 -0
- data/docs/TlsCsrResponseData.md +13 -0
- data/docs/TlsCsrsApi.md +52 -0
- data/docs/TlsSubscriptionResponseAttributes.md +1 -0
- data/docs/TlsSubscriptionResponseAttributesAllOf.md +1 -0
- data/docs/TokensApi.md +1 -1
- data/docs/TypeTlsCsr.md +9 -0
- data/docs/VclApi.md +1 -1
- data/docs/WafActiveRulesApi.md +1 -1
- data/lib/fastly/api/automation_tokens_api.rb +3 -3
- data/lib/fastly/api/backend_api.rb +4 -4
- data/lib/fastly/api/billing_invoices_api.rb +151 -0
- data/lib/fastly/api/director_api.rb +2 -2
- data/lib/fastly/api/domain_inspector_historical_api.rb +4 -4
- data/lib/fastly/api/kv_store_api.rb +2 -2
- data/lib/fastly/api/logging_scalyr_api.rb +4 -4
- data/lib/fastly/api/origin_inspector_historical_api.rb +4 -4
- data/lib/fastly/api/pool_api.rb +4 -4
- data/lib/fastly/api/publish_api.rb +2 -2
- data/lib/fastly/api/secret_store_api.rb +5 -2
- data/lib/fastly/api/secret_store_item_api.rb +2 -2
- data/lib/fastly/api/tls_csrs_api.rb +83 -0
- data/lib/fastly/api/tokens_api.rb +2 -2
- data/lib/fastly/api/vcl_api.rb +2 -2
- data/lib/fastly/api/waf_active_rules_api.rb +2 -2
- data/lib/fastly/configuration.rb +18 -0
- data/lib/fastly/models/{error_response.rb → automation_token_error_response.rb} +3 -3
- data/lib/fastly/models/backend.rb +1 -1
- data/lib/fastly/models/backend_response.rb +1 -1
- data/lib/fastly/models/director.rb +1 -1
- data/lib/fastly/models/director_response.rb +1 -1
- data/lib/fastly/models/domain_inspector_realtime_entry.rb +1 -1
- data/lib/fastly/models/error.rb +243 -0
- data/lib/fastly/models/error_response_data.rb +225 -0
- data/lib/fastly/models/event_attributes.rb +2 -2
- data/lib/fastly/models/invoice.rb +298 -0
- data/lib/fastly/models/invoice_response.rb +305 -0
- data/lib/fastly/models/invoicelineitems.rb +297 -0
- data/lib/fastly/models/list_invoices_response.rb +234 -0
- data/lib/fastly/models/listinvoices.rb +227 -0
- data/lib/fastly/models/logging_scalyr_additional.rb +1 -1
- data/lib/fastly/models/logging_scalyr_response.rb +1 -1
- data/lib/fastly/models/metadata.rb +250 -0
- data/lib/fastly/models/origin_inspector_realtime_entry.rb +1 -1
- data/lib/fastly/models/pool_additional.rb +1 -1
- data/lib/fastly/models/pool_response.rb +1 -1
- data/lib/fastly/models/pool_response_post.rb +1 -1
- data/lib/fastly/models/pop.rb +2 -2
- data/lib/fastly/models/realtime_entry.rb +1 -1
- data/lib/fastly/models/relationship_tls_certificate.rb +1 -1
- data/lib/fastly/models/relationship_tls_configuration.rb +1 -1
- data/lib/fastly/models/results.rb +21 -1
- data/lib/fastly/models/service_detail.rb +1 -1
- data/lib/fastly/models/service_list_response.rb +2 -2
- data/lib/fastly/models/service_list_response_all_of.rb +2 -2
- data/lib/fastly/models/service_response.rb +1 -1
- data/lib/fastly/models/service_response_all_of.rb +1 -1
- data/lib/fastly/models/tls_configuration_response_attributes.rb +1 -1
- data/lib/fastly/models/tls_configuration_response_attributes_all_of.rb +1 -1
- data/lib/fastly/models/tls_csr.rb +216 -0
- data/lib/fastly/models/tls_csr_data.rb +236 -0
- data/lib/fastly/models/tls_csr_data_attributes.rb +358 -0
- data/lib/fastly/models/tls_csr_error_response.rb +218 -0
- data/lib/fastly/models/tls_csr_response.rb +216 -0
- data/lib/fastly/models/tls_csr_response_attributes.rb +217 -0
- data/lib/fastly/models/tls_csr_response_data.rb +245 -0
- data/lib/fastly/models/tls_subscription_data_attributes.rb +2 -2
- data/lib/fastly/models/tls_subscription_response_attributes.rb +14 -4
- data/lib/fastly/models/tls_subscription_response_attributes_all_of.rb +14 -4
- data/lib/fastly/models/type_tls_csr.rb +34 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +19 -1
- data/sig.json +1 -1
- metadata +40 -4
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', '~> 8.0
|
|
11
|
+
gem 'fastly', '~> 8.1.0'
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
Then run `bundle install`.
|
|
@@ -94,6 +94,8 @@ Class | Method | Description
|
|
|
94
94
|
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**delete_billing_addr**](docs/BillingAddressApi.md#delete_billing_addr) | Delete a billing address
|
|
95
95
|
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**get_billing_addr**](docs/BillingAddressApi.md#get_billing_addr) | Get a billing address
|
|
96
96
|
[*Fastly::BillingAddressApi*](docs/BillingAddressApi.md) | [**update_billing_addr**](docs/BillingAddressApi.md#update_billing_addr) | Update a billing address
|
|
97
|
+
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**get_invoice_by_invoice_id**](docs/BillingInvoicesApi.md#get_invoice_by_invoice_id) | Get invoice by ID.
|
|
98
|
+
[*Fastly::BillingInvoicesApi*](docs/BillingInvoicesApi.md) | [**list_invoices**](docs/BillingInvoicesApi.md#list_invoices) | List of invoices.
|
|
97
99
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**create_cache_settings**](docs/CacheSettingsApi.md#create_cache_settings) | Create a cache settings object
|
|
98
100
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**delete_cache_settings**](docs/CacheSettingsApi.md#delete_cache_settings) | Delete a cache settings object
|
|
99
101
|
[*Fastly::CacheSettingsApi*](docs/CacheSettingsApi.md) | [**get_cache_settings**](docs/CacheSettingsApi.md#get_cache_settings) | Get a cache settings object
|
|
@@ -509,6 +511,7 @@ Class | Method | Description
|
|
|
509
511
|
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**get_tls_config**](docs/TlsConfigurationsApi.md#get_tls_config) | Get a TLS configuration
|
|
510
512
|
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**list_tls_configs**](docs/TlsConfigurationsApi.md#list_tls_configs) | List TLS configurations
|
|
511
513
|
[*Fastly::TlsConfigurationsApi*](docs/TlsConfigurationsApi.md) | [**update_tls_config**](docs/TlsConfigurationsApi.md#update_tls_config) | Update a TLS configuration
|
|
514
|
+
[*Fastly::TlsCsrsApi*](docs/TlsCsrsApi.md) | [**create_csr**](docs/TlsCsrsApi.md#create_csr) | Create CSR
|
|
512
515
|
[*Fastly::TlsDomainsApi*](docs/TlsDomainsApi.md) | [**list_tls_domains**](docs/TlsDomainsApi.md#list_tls_domains) | List TLS domains
|
|
513
516
|
[*Fastly::TlsPrivateKeysApi*](docs/TlsPrivateKeysApi.md) | [**create_tls_key**](docs/TlsPrivateKeysApi.md#create_tls_key) | Create a TLS private key
|
|
514
517
|
[*Fastly::TlsPrivateKeysApi*](docs/TlsPrivateKeysApi.md) | [**delete_tls_key**](docs/TlsPrivateKeysApi.md#delete_tls_key) | Delete a TLS private key
|
|
@@ -595,12 +598,15 @@ Class | Method | Description
|
|
|
595
598
|
|
|
596
599
|
The fastly-ruby API client currently does not support the following endpoints:
|
|
597
600
|
|
|
598
|
-
- [`/
|
|
599
|
-
- [`/
|
|
600
|
-
- [`/
|
|
601
|
-
- [`/
|
|
602
|
-
- [`/
|
|
603
|
-
- [`/
|
|
601
|
+
- [`/alerts/definitions/{definition_id}`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (DELETE, GET, PUT)
|
|
602
|
+
- [`/alerts/definitions`](https://www.fastly.com/documentation/reference/api/observability/alerts/definitions) (GET, POST)
|
|
603
|
+
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
|
|
604
|
+
- [`/resources/stores/kv/{store_id}/batch`](https://www.fastly.com/documentation/reference/api/services/resources/kv-store-item) (PUT)
|
|
605
|
+
- [`/tls/activations/{tls_activation_id}`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET, PATCH)
|
|
606
|
+
- [`/tls/activations`](https://www.fastly.com/documentation/reference/api/tls/mutual-tls/activations) (GET)
|
|
607
|
+
- [`/v1/channel/{service_id}/ts/h/limit/{max_entries}`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
|
|
608
|
+
- [`/v1/channel/{service_id}/ts/h`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
|
|
609
|
+
- [`/v1/channel/{service_id}/ts/{start_timestamp}`](https://www.fastly.com/documentation/reference/api/metrics-stats/origin-insights) (GET)
|
|
604
610
|
|
|
605
611
|
|
|
606
612
|
If you encounter any non-security-related bug or unexpected behavior, please [file an issue][bug]
|
data/docs/AutomationTokensApi.md
CHANGED
|
@@ -174,7 +174,7 @@ end
|
|
|
174
174
|
## `revoke_automation_token_id()`
|
|
175
175
|
|
|
176
176
|
```ruby
|
|
177
|
-
revoke_automation_token_id(opts): <
|
|
177
|
+
revoke_automation_token_id(opts): <AutomationTokenErrorResponse> # Revoke an Automation Token by ID
|
|
178
178
|
```
|
|
179
179
|
|
|
180
180
|
Revoke an automation token by ID.
|
|
@@ -204,7 +204,7 @@ end
|
|
|
204
204
|
|
|
205
205
|
### Return type
|
|
206
206
|
|
|
207
|
-
[**
|
|
207
|
+
[**AutomationTokenErrorResponse**](AutomationTokenErrorResponse.md)
|
|
208
208
|
|
|
209
209
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
210
210
|
[[Back to README]](../../README.md)
|
data/docs/Backend.md
CHANGED
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
|
29
29
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
|
30
30
|
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
|
|
31
|
-
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
31
|
+
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
|
|
32
32
|
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
|
|
33
33
|
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
|
|
34
34
|
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
|
data/docs/BackendApi.md
CHANGED
|
@@ -56,7 +56,7 @@ opts = {
|
|
|
56
56
|
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
|
|
57
57
|
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
|
58
58
|
ssl_check_cert: true, # Boolean | Be strict on checking SSL certs.
|
|
59
|
-
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
59
|
+
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
|
|
60
60
|
ssl_client_cert: 'ssl_client_cert_example', # String | Client certificate attached to origin.
|
|
61
61
|
ssl_client_key: 'ssl_client_key_example', # String | Client key attached to origin.
|
|
62
62
|
ssl_hostname: 'ssl_hostname_example', # String | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
|
|
@@ -104,7 +104,7 @@ end
|
|
|
104
104
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
|
105
105
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
|
106
106
|
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
|
|
107
|
-
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
107
|
+
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
|
|
108
108
|
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
|
|
109
109
|
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
|
|
110
110
|
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
|
|
@@ -279,7 +279,7 @@ opts = {
|
|
|
279
279
|
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
|
|
280
280
|
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
|
281
281
|
ssl_check_cert: true, # Boolean | Be strict on checking SSL certs.
|
|
282
|
-
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
282
|
+
ssl_ciphers: 'ssl_ciphers_example', # String | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated.
|
|
283
283
|
ssl_client_cert: 'ssl_client_cert_example', # String | Client certificate attached to origin.
|
|
284
284
|
ssl_client_key: 'ssl_client_key_example', # String | Client key attached to origin.
|
|
285
285
|
ssl_hostname: 'ssl_hostname_example', # String | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation.
|
|
@@ -328,7 +328,7 @@ end
|
|
|
328
328
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
|
329
329
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
|
330
330
|
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
|
|
331
|
-
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
331
|
+
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
|
|
332
332
|
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
|
|
333
333
|
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
|
|
334
334
|
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
|
data/docs/BackendResponse.md
CHANGED
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
|
29
29
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
|
30
30
|
| **ssl_check_cert** | **Boolean** | Be strict on checking SSL certs. | [optional][default to true] |
|
|
31
|
-
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/
|
|
31
|
+
| **ssl_ciphers** | **String** | List of [OpenSSL ciphers](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic `503` error response will be generated. | [optional] |
|
|
32
32
|
| **ssl_client_cert** | **String** | Client certificate attached to origin. | [optional] |
|
|
33
33
|
| **ssl_client_key** | **String** | Client key attached to origin. | [optional] |
|
|
34
34
|
| **ssl_hostname** | **String** | Use `ssl_cert_hostname` and `ssl_sni_hostname` to configure certificate validation. | [optional] |
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Fastly::BillingInvoicesApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::BillingInvoicesApi.new
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Methods
|
|
10
|
+
|
|
11
|
+
| Method | HTTP request | Description |
|
|
12
|
+
| ------ | ------------ | ----------- |
|
|
13
|
+
| [**get_invoice_by_invoice_id**](BillingInvoicesApi.md#get_invoice_by_invoice_id) | **GET** /billing/v3/invoices/{invoice_id} | Get invoice by ID. |
|
|
14
|
+
| [**list_invoices**](BillingInvoicesApi.md#list_invoices) | **GET** /billing/v3/invoices | List of invoices. |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## `get_invoice_by_invoice_id()`
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
get_invoice_by_invoice_id(opts): <InvoiceResponse> # Get invoice by ID.
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Returns invoice associated with the invoice id.
|
|
24
|
+
|
|
25
|
+
### Examples
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
api_instance = Fastly::BillingInvoicesApi.new
|
|
29
|
+
opts = {
|
|
30
|
+
invoice_id: 'invoice_id_example', # String | Alphanumeric string identifying the invoice.
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
begin
|
|
34
|
+
# Get invoice by ID.
|
|
35
|
+
result = api_instance.get_invoice_by_invoice_id(opts)
|
|
36
|
+
p result
|
|
37
|
+
rescue Fastly::ApiError => e
|
|
38
|
+
puts "Error when calling BillingInvoicesApi->get_invoice_by_invoice_id: #{e}"
|
|
39
|
+
end
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Options
|
|
43
|
+
|
|
44
|
+
| Name | Type | Description | Notes |
|
|
45
|
+
| ---- | ---- | ----------- | ----- |
|
|
46
|
+
| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | |
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
[**InvoiceResponse**](InvoiceResponse.md)
|
|
51
|
+
|
|
52
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
53
|
+
[[Back to README]](../../README.md)
|
|
54
|
+
## `list_invoices()`
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
list_invoices(opts): <ListInvoicesResponse> # List of invoices.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Returns the list of invoices, sorted by billing start date (newest to oldest).
|
|
61
|
+
|
|
62
|
+
### Examples
|
|
63
|
+
|
|
64
|
+
```ruby
|
|
65
|
+
api_instance = Fastly::BillingInvoicesApi.new
|
|
66
|
+
opts = {
|
|
67
|
+
billing_start_date: '2023-01-01T00:00:00Z', # String |
|
|
68
|
+
billing_end_date: '2023-01-31T00:00:00Z', # String |
|
|
69
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
|
70
|
+
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.
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
begin
|
|
74
|
+
# List of invoices.
|
|
75
|
+
result = api_instance.list_invoices(opts)
|
|
76
|
+
p result
|
|
77
|
+
rescue Fastly::ApiError => e
|
|
78
|
+
puts "Error when calling BillingInvoicesApi->list_invoices: #{e}"
|
|
79
|
+
end
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Options
|
|
83
|
+
|
|
84
|
+
| Name | Type | Description | Notes |
|
|
85
|
+
| ---- | ---- | ----------- | ----- |
|
|
86
|
+
| **billing_start_date** | **String** | | [optional] |
|
|
87
|
+
| **billing_end_date** | **String** | | [optional] |
|
|
88
|
+
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to '100'] |
|
|
89
|
+
| **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] |
|
|
90
|
+
|
|
91
|
+
### Return type
|
|
92
|
+
|
|
93
|
+
[**ListInvoicesResponse**](ListInvoicesResponse.md)
|
|
94
|
+
|
|
95
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
96
|
+
[[Back to README]](../../README.md)
|
data/docs/Director.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
10
10
|
| **name** | **String** | Name for the Director. | [optional] |
|
|
11
11
|
| **quorum** | **Integer** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional][default to 75] |
|
|
12
|
-
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
12
|
+
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
13
13
|
| **type** | **Integer** | What type of load balance group to use. | [optional][default to TYPE::random] |
|
|
14
14
|
| **retries** | **Integer** | How many backends to search if it fails. | [optional][default to 5] |
|
|
15
15
|
|
data/docs/DirectorApi.md
CHANGED
|
@@ -37,7 +37,7 @@ opts = {
|
|
|
37
37
|
comment: 'comment_example', # String | A freeform descriptive note.
|
|
38
38
|
name: 'name_example', # String | Name for the Director.
|
|
39
39
|
quorum: 56, # Integer | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`.
|
|
40
|
-
shield: 'shield_example', # String | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding.
|
|
40
|
+
shield: 'shield_example', # String | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding.
|
|
41
41
|
type: 1, # Integer | What type of load balance group to use.
|
|
42
42
|
retries: 56, # Integer | How many backends to search if it fails.
|
|
43
43
|
}
|
|
@@ -62,7 +62,7 @@ end
|
|
|
62
62
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
63
63
|
| **name** | **String** | Name for the Director. | [optional] |
|
|
64
64
|
| **quorum** | **Integer** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional][default to 75] |
|
|
65
|
-
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
65
|
+
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
66
66
|
| **type** | **Integer** | What type of load balance group to use. | [optional][default to 1] |
|
|
67
67
|
| **retries** | **Integer** | How many backends to search if it fails. | [optional][default to 5] |
|
|
68
68
|
|
data/docs/DirectorResponse.md
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
10
10
|
| **name** | **String** | Name for the Director. | [optional] |
|
|
11
11
|
| **quorum** | **Integer** | The percentage of capacity that needs to be up for a director to be considered up. `0` to `100`. | [optional][default to 75] |
|
|
12
|
-
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
12
|
+
| **shield** | **String** | Selected POP to serve as a shield for the backends. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
13
13
|
| **type** | **Integer** | What type of load balance group to use. | [optional][default to TYPE::random] |
|
|
14
14
|
| **retries** | **Integer** | How many backends to search if it fails. | [optional][default to 5] |
|
|
15
15
|
| **service_id** | **String** | | [optional][readonly] |
|
|
@@ -30,10 +30,10 @@ opts = {
|
|
|
30
30
|
start: '2021-08-01T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
|
|
31
31
|
_end: '2020-08-02T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
|
|
32
32
|
downsample: 'hour', # String | Duration of sample windows.
|
|
33
|
-
metric: 'resp_body_bytes,status_2xx', # String | The
|
|
33
|
+
metric: 'resp_body_bytes,status_2xx', # String | The metrics to retrieve. Multiple values should be comma-separated.
|
|
34
34
|
group_by: 'domain', # String | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs).
|
|
35
35
|
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
|
36
|
-
cursor: 'cursor_example', # String | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
|
|
36
|
+
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.
|
|
37
37
|
region: 'usa', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
38
38
|
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
39
39
|
domain: 'domain_1.com,domain_2.com', # String | Limit query to one or more specific domains. Values should be comma-separated.
|
|
@@ -56,10 +56,10 @@ end
|
|
|
56
56
|
| **start** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
|
|
57
57
|
| **_end** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
|
|
58
58
|
| **downsample** | **String** | Duration of sample windows. | [optional][default to 'hour'] |
|
|
59
|
-
| **metric** | **String** | The
|
|
59
|
+
| **metric** | **String** | The metrics to retrieve. Multiple values should be comma-separated. | [optional][default to 'edge_requests'] |
|
|
60
60
|
| **group_by** | **String** | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=domain` will return one timeseries for every domain, as a total across all datacenters (POPs). | [optional] |
|
|
61
61
|
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to '100'] |
|
|
62
|
-
| **cursor** | **String** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
|
62
|
+
| **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] |
|
|
63
63
|
| **region** | **String** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] |
|
|
64
64
|
| **datacenter** | **String** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional] |
|
|
65
65
|
| **domain** | **String** | Limit query to one or more specific domains. Values should be comma-separated. | [optional] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **recorded** | [**RecordedTimestamp**](RecordedTimestamp.md) | | [optional] |
|
|
8
8
|
| **aggregated** | [**Hash<String, DomainInspectorMeasurements>**](DomainInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name and then by IP address. | [optional] |
|
|
9
|
-
| **datacenter** | **Hash<String, Hash<String, DomainInspectorMeasurements>>** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
|
|
9
|
+
| **datacenter** | **Hash<String, Hash<String, DomainInspectorMeasurements>>** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
12
|
|
data/docs/Error.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::Error
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | [optional] |
|
|
8
|
+
| **title** | **String** | | [optional] |
|
|
9
|
+
| **code** | **String** | | [optional] |
|
|
10
|
+
| **status** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::ErrorResponseData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **detail** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
data/docs/Invoice.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Fastly::Invoice
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer_id** | **String** | Customer ID associated with the invoice. | [optional] |
|
|
8
|
+
| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | [optional] |
|
|
9
|
+
| **invoice_posted_on** | **Time** | Date and time invoice was posted on, in ISO 8601 format. | [optional] |
|
|
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
|
+
| **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] |
|
|
12
|
+
| **statement_number** | **String** | Alphanumeric string identifying the statement number. | [optional] |
|
|
13
|
+
| **currency_code** | **String** | Three-letter code representing a specific currency used for financial transactions. | [optional] |
|
|
14
|
+
| **monthly_transaction_amount** | **Float** | Total billable amount for invoiced services charged within a single month. | [optional] |
|
|
15
|
+
| **transaction_line_items** | [**Array<Invoicelineitems>**](Invoicelineitems.md) | | [optional] |
|
|
16
|
+
|
|
17
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Fastly::InvoiceResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer_id** | **String** | Customer ID associated with the invoice. | [optional] |
|
|
8
|
+
| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | [optional] |
|
|
9
|
+
| **invoice_posted_on** | **Time** | Date and time invoice was posted on, in ISO 8601 format. | [optional] |
|
|
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
|
+
| **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] |
|
|
12
|
+
| **statement_number** | **String** | Alphanumeric string identifying the statement number. | [optional] |
|
|
13
|
+
| **currency_code** | **String** | Three-letter code representing a specific currency used for financial transactions. | [optional] |
|
|
14
|
+
| **monthly_transaction_amount** | **Float** | Total billable amount for invoiced services charged within a single month. | [optional] |
|
|
15
|
+
| **transaction_line_items** | [**Array<Invoicelineitems>**](Invoicelineitems.md) | | [optional] |
|
|
16
|
+
|
|
17
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Fastly::Invoicelineitems
|
|
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
|
+
| **credit_coupon_code** | **String** | Discount coupon associated with the invoice for any account or service credits. | [optional] |
|
|
10
|
+
| **rate** | **Float** | Price per unit. | [optional] |
|
|
11
|
+
| **units** | **Float** | Total number of units of usage. | [optional] |
|
|
12
|
+
| **product_name** | **String** | The name of the product. | [optional] |
|
|
13
|
+
| **product_group** | **String** | The broader classification of the product (e.g., `Compute` or `Full-Site Delivery`). | [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
|
+
|
data/docs/KvStoreApi.md
CHANGED
|
@@ -159,7 +159,7 @@ end
|
|
|
159
159
|
| Name | Type | Description | Notes |
|
|
160
160
|
| ---- | ---- | ----------- | ----- |
|
|
161
161
|
| **cursor** | **String** | | [optional] |
|
|
162
|
-
| **limit** | **Integer** | | [optional][default to
|
|
162
|
+
| **limit** | **Integer** | | [optional][default to 1000] |
|
|
163
163
|
|
|
164
164
|
### Return type
|
|
165
165
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::ListInvoicesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Invoice>**](Invoice.md) | | [optional] |
|
|
8
|
+
| **meta** | [**Metadata**](Metadata.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::Listinvoices
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Invoice>**](Invoice.md) | | [optional] |
|
|
8
|
+
| **meta** | [**Metadata**](Metadata.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
|
8
|
-
| **token** | **String** | The token to use for authentication
|
|
8
|
+
| **token** | **String** | The token to use for authentication. | [optional] |
|
|
9
9
|
| **project_id** | **String** | The name of the logfile within Scalyr. | [optional][default to 'logplex'] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
data/docs/LoggingScalyrApi.md
CHANGED
|
@@ -38,7 +38,7 @@ opts = {
|
|
|
38
38
|
format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
|
|
39
39
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
40
40
|
region: 'US', # String | The region that log data will be sent to.
|
|
41
|
-
token: 'token_example', # String | The token to use for authentication
|
|
41
|
+
token: 'token_example', # String | The token to use for authentication.
|
|
42
42
|
project_id: 'project_id_example', # String | The name of the logfile within Scalyr.
|
|
43
43
|
}
|
|
44
44
|
|
|
@@ -63,7 +63,7 @@ end
|
|
|
63
63
|
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %&gt;s %b'] |
|
|
64
64
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
65
65
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
|
66
|
-
| **token** | **String** | The token to use for authentication
|
|
66
|
+
| **token** | **String** | The token to use for authentication. | [optional] |
|
|
67
67
|
| **project_id** | **String** | The name of the logfile within Scalyr. | [optional][default to 'logplex'] |
|
|
68
68
|
|
|
69
69
|
### Return type
|
|
@@ -215,7 +215,7 @@ opts = {
|
|
|
215
215
|
format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
|
|
216
216
|
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
|
217
217
|
region: 'US', # String | The region that log data will be sent to.
|
|
218
|
-
token: 'token_example', # String | The token to use for authentication
|
|
218
|
+
token: 'token_example', # String | The token to use for authentication.
|
|
219
219
|
project_id: 'project_id_example', # String | The name of the logfile within Scalyr.
|
|
220
220
|
}
|
|
221
221
|
|
|
@@ -241,7 +241,7 @@ end
|
|
|
241
241
|
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %&gt;s %b'] |
|
|
242
242
|
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
|
243
243
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
|
244
|
-
| **token** | **String** | The token to use for authentication
|
|
244
|
+
| **token** | **String** | The token to use for authentication. | [optional] |
|
|
245
245
|
| **project_id** | **String** | The name of the logfile within Scalyr. | [optional][default to 'logplex'] |
|
|
246
246
|
|
|
247
247
|
### Return type
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '%h %l %u %t \"%r\" %&gt;s %b'] |
|
|
11
11
|
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
|
12
12
|
| **region** | **String** | The region that log data will be sent to. | [optional][default to 'US'] |
|
|
13
|
-
| **token** | **String** | The token to use for authentication
|
|
13
|
+
| **token** | **String** | The token to use for authentication. | [optional] |
|
|
14
14
|
| **project_id** | **String** | The name of the logfile within Scalyr. | [optional][default to 'logplex'] |
|
|
15
15
|
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
16
16
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
data/docs/Metadata.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::Metadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **next_cursor** | **String** | The token used to request the next set of results. | [optional] |
|
|
8
|
+
| **limit** | **Integer** | The number of invoices included in the response. | [optional] |
|
|
9
|
+
| **sort** | **String** | The sort order of the invoices in the response. | [optional][default to 'billing_start_date'] |
|
|
10
|
+
| **total** | **Integer** | Total number of records available on the backend. | [optional] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -30,10 +30,10 @@ opts = {
|
|
|
30
30
|
start: '2021-08-01T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
|
|
31
31
|
_end: '2020-08-02T00:00:00.000Z', # String | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
|
|
32
32
|
downsample: 'hour', # String | Duration of sample windows.
|
|
33
|
-
metric: 'resp_body_bytes,status_2xx', # String | The
|
|
33
|
+
metric: 'resp_body_bytes,status_2xx', # String | The metrics to retrieve. Multiple values should be comma-separated.
|
|
34
34
|
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.
|
|
35
35
|
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
|
36
|
-
cursor: 'cursor_example', # String | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
|
|
36
|
+
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.
|
|
37
37
|
region: 'usa', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
38
38
|
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
39
39
|
host: 'origin_1,origin_2', # String | Limit query to one or more specific origin hosts. Values should be comma-separated.
|
|
@@ -56,10 +56,10 @@ end
|
|
|
56
56
|
| **start** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
|
|
57
57
|
| **_end** | **String** | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value. | [optional] |
|
|
58
58
|
| **downsample** | **String** | Duration of sample windows. | [optional][default to 'hour'] |
|
|
59
|
-
| **metric** | **String** | The
|
|
59
|
+
| **metric** | **String** | The metrics to retrieve. Multiple values should be comma-separated. | [optional][default to 'responses'] |
|
|
60
60
|
| **group_by** | **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. | [optional] |
|
|
61
61
|
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to '100'] |
|
|
62
|
-
| **cursor** | **String** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
|
62
|
+
| **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] |
|
|
63
63
|
| **region** | **String** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] |
|
|
64
64
|
| **datacenter** | **String** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional] |
|
|
65
65
|
| **host** | **String** | Limit query to one or more specific origin hosts. Values should be comma-separated. | [optional] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **recorded** | [**OriginInspectorRealtimeEntryRecorded**](OriginInspectorRealtimeEntryRecorded.md) | | [optional] |
|
|
8
8
|
| **aggregated** | [**Hash<String, OriginInspectorMeasurements>**](OriginInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name. | [optional] |
|
|
9
|
-
| **datacenter** | **Hash<String, Hash<String, OriginInspectorMeasurements>>** | Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
|
|
9
|
+
| **datacenter** | **Hash<String, Hash<String, OriginInspectorMeasurements>>** | Groups [measurements](#measurements-data-model) by POP, then backend name. See the [POPs API](https://www.fastly.com/documentation/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
12
|
|
data/docs/PoolAdditional.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | Name for the Pool. | [optional] |
|
|
8
|
-
| **shield** | **String** | Selected POP to serve as a shield for the servers. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
8
|
+
| **shield** | **String** | Selected POP to serve as a shield for the servers. Defaults to `null` meaning no origin shielding if not set. Refer to the [POPs API endpoint](https://www.fastly.com/documentation/reference/api/utils/pops/) to get a list of available POPs used for shielding. | [optional][default to 'null'] |
|
|
9
9
|
| **request_condition** | **String** | Condition which, if met, will select this configuration during a request. Optional. | [optional] |
|
|
10
10
|
| **tls_ciphers** | **String** | List of OpenSSL ciphers (see the [openssl.org manpages](https://www.openssl.org/docs/man1.1.1/man1/ciphers.html) for details). Optional. | [optional] |
|
|
11
11
|
| **tls_sni_hostname** | **String** | SNI hostname. Optional. | [optional] |
|