fastly 8.8.0 → 8.9.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 +23 -1
- data/Gemfile.lock +1 -1
- data/README.md +30 -3
- data/docs/AclsInComputeApi.md +284 -0
- data/docs/{OriginInspectorRealtimeEntryRecorded.md → ComputeAclCreateAclsRequest.md} +2 -1
- data/docs/ComputeAclCreateAclsResponse.md +11 -0
- data/docs/ComputeAclListEntries.md +11 -0
- data/docs/ComputeAclListEntriesItem.md +11 -0
- data/docs/ComputeAclListEntriesMeta.md +11 -0
- data/docs/ComputeAclLookup.md +12 -0
- data/docs/ComputeAclUpdateEntry.md +12 -0
- data/docs/ConfiguredProductResponse.md +13 -0
- data/docs/ConfiguredProductResponseConfiguration.md +11 -0
- data/docs/ConfiguredProductResponseLinks.md +11 -0
- data/docs/ConfiguredProductResponseProduct.md +11 -0
- data/docs/ContactApi.md +1 -1
- data/docs/CustomerAddress.md +16 -0
- data/docs/CustomerAddressesApi.md +127 -0
- data/docs/DomainInspector.md +1 -1
- data/docs/DomainInspectorRealtimeEntry.md +1 -1
- data/docs/EnabledProductsApi.md +93 -9
- data/docs/Environment.md +12 -0
- data/docs/{RecordedTimestamp.md → EnvironmentName.md} +1 -1
- data/docs/{OriginInspectorSubsequentRequestTimestamp.md → InlineResponse201.md} +2 -1
- data/docs/{SubsequentRequestTimestamp.md → ListCustomerAddressesResponse.md} +2 -1
- data/docs/OriginInspector.md +1 -1
- data/docs/OriginInspectorRealtimeEntry.md +1 -1
- data/docs/RealtimeEntryAggregated.md +1 -0
- data/docs/RealtimeMeasurements.md +1 -0
- data/docs/Results.md +1 -0
- data/docs/SchemasVersionResponse.md +1 -0
- data/docs/ServiceDetail.md +1 -0
- data/docs/ServiceListResponse.md +1 -0
- data/docs/ServiceListResponseAllOf.md +1 -0
- data/docs/ServiceResponse.md +1 -0
- data/docs/ServiceResponseAllOf.md +1 -0
- data/docs/ServiceVersionDetail.md +1 -0
- data/docs/ServiceVersionDetailOrNull.md +1 -0
- data/docs/SetConfiguration.md +11 -0
- data/docs/SetWorkspaceId.md +10 -0
- data/docs/TlsCertificatesApi.md +2 -2
- data/docs/TlsDomainsApi.md +2 -2
- data/docs/TlsSubscriptionsApi.md +2 -2
- data/docs/VersionApi.md +84 -0
- data/docs/VersionResponse.md +1 -0
- data/docs/VersionResponseAllOf.md +1 -0
- data/lib/fastly/api/acls_in_compute_api.rb +470 -0
- data/lib/fastly/api/contact_api.rb +1 -1
- data/lib/fastly/api/customer_addresses_api.rb +224 -0
- data/lib/fastly/api/enabled_products_api.rb +164 -10
- data/lib/fastly/api/tls_certificates_api.rb +7 -7
- data/lib/fastly/api/tls_domains_api.rb +7 -7
- data/lib/fastly/api/tls_subscriptions_api.rb +7 -7
- data/lib/fastly/api/version_api.rb +154 -0
- data/lib/fastly/configuration.rb +84 -0
- data/lib/fastly/models/billing_response_line_item.rb +10 -0
- data/lib/fastly/models/{origin_inspector_realtime_entry_recorded.rb → compute_acl_create_acls_request.rb} +15 -6
- data/lib/fastly/models/compute_acl_create_acls_response.rb +227 -0
- data/lib/fastly/models/compute_acl_list_entries.rb +228 -0
- data/lib/fastly/models/compute_acl_list_entries_item.rb +227 -0
- data/lib/fastly/models/compute_acl_list_entries_meta.rb +227 -0
- data/lib/fastly/models/compute_acl_lookup.rb +238 -0
- data/lib/fastly/models/compute_acl_update_entry.rb +238 -0
- data/lib/fastly/models/configured_product_response.rb +243 -0
- data/lib/fastly/models/configured_product_response_configuration.rb +227 -0
- data/lib/fastly/models/configured_product_response_links.rb +227 -0
- data/lib/fastly/models/configured_product_response_product.rb +227 -0
- data/lib/fastly/models/customer_address.rb +294 -0
- data/lib/fastly/models/domain_inspector.rb +2 -1
- data/lib/fastly/models/domain_inspector_realtime_entry.rb +2 -1
- data/lib/fastly/models/environment.rb +235 -0
- data/lib/fastly/models/environment_name.rb +34 -0
- data/lib/fastly/models/event_attributes.rb +2 -2
- data/lib/fastly/models/{recorded_timestamp.rb → inline_response201.rb} +15 -6
- data/lib/fastly/models/line_item_data.rb +10 -0
- data/lib/fastly/models/{origin_inspector_subsequent_request_timestamp.rb → list_customer_addresses_response.rb} +16 -6
- data/lib/fastly/models/origin_inspector.rb +2 -1
- data/lib/fastly/models/origin_inspector_realtime_entry.rb +2 -1
- data/lib/fastly/models/realtime_entry_aggregated.rb +14 -4
- data/lib/fastly/models/realtime_measurements.rb +14 -4
- data/lib/fastly/models/results.rb +11 -1
- data/lib/fastly/models/schemas_version_response.rb +16 -4
- data/lib/fastly/models/service_detail.rb +13 -1
- data/lib/fastly/models/service_list_response.rb +16 -4
- data/lib/fastly/models/service_list_response_all_of.rb +16 -4
- data/lib/fastly/models/service_response.rb +16 -4
- data/lib/fastly/models/service_response_all_of.rb +16 -4
- data/lib/fastly/models/service_version_detail.rb +13 -1
- data/lib/fastly/models/service_version_detail_or_null.rb +13 -1
- data/lib/fastly/models/set_configuration.rb +227 -0
- data/lib/fastly/models/{subsequent_request_timestamp.rb → set_workspace_id.rb} +15 -6
- data/lib/fastly/models/version_response.rb +16 -4
- data/lib/fastly/models/version_response_all_of.rb +16 -4
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +20 -4
- data/sig.json +1 -1
- metadata +42 -10
@@ -0,0 +1,127 @@
|
|
1
|
+
# Fastly::CustomerAddressesApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::CustomerAddressesApi.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_customer_address**](CustomerAddressesApi.md#create_customer_address) | **POST** /billing/v3/customer-addresses | Creates an address associated with a customer account.
|
17
|
+
[**list_customer_addresses**](CustomerAddressesApi.md#list_customer_addresses) | **GET** /billing/v3/customer-addresses | Return the list of addresses associated with a customer account.
|
18
|
+
[**update_customer_address**](CustomerAddressesApi.md#update_customer_address) | **PUT** /billing/v3/customer-addresses/{type} | Updates an address associated with a customer account.
|
19
|
+
|
20
|
+
|
21
|
+
## `create_customer_address()`
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
create_customer_address(opts): <InlineResponse201> # Creates an address associated with a customer account.
|
25
|
+
```
|
26
|
+
|
27
|
+
Creates an address associated with a customer account.
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
api_instance = Fastly::CustomerAddressesApi.new
|
33
|
+
opts = {
|
34
|
+
customer_address: Fastly::CustomerAddress.new, # CustomerAddress |
|
35
|
+
}
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Creates an address associated with a customer account.
|
39
|
+
result = api_instance.create_customer_address(opts)
|
40
|
+
p result
|
41
|
+
rescue Fastly::ApiError => e
|
42
|
+
puts "Error when calling CustomerAddressesApi->create_customer_address: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Options
|
47
|
+
|
48
|
+
| Name | Type | Description | Notes |
|
49
|
+
| ---- | ---- | ----------- | ----- |
|
50
|
+
| **customer_address** | [**CustomerAddress**](CustomerAddress.md) | | |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**InlineResponse201**](InlineResponse201.md)
|
55
|
+
|
56
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
57
|
+
[[Back to README]](../../README.md)
|
58
|
+
## `list_customer_addresses()`
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
list_customer_addresses: <ListCustomerAddressesResponse> # Return the list of addresses associated with a customer account.
|
62
|
+
```
|
63
|
+
|
64
|
+
Return the list of addresses associated with a customer account.
|
65
|
+
|
66
|
+
### Examples
|
67
|
+
|
68
|
+
```ruby
|
69
|
+
api_instance = Fastly::CustomerAddressesApi.new
|
70
|
+
|
71
|
+
begin
|
72
|
+
# Return the list of addresses associated with a customer account.
|
73
|
+
result = api_instance.list_customer_addresses
|
74
|
+
p result
|
75
|
+
rescue Fastly::ApiError => e
|
76
|
+
puts "Error when calling CustomerAddressesApi->list_customer_addresses: #{e}"
|
77
|
+
end
|
78
|
+
```
|
79
|
+
|
80
|
+
### Options
|
81
|
+
|
82
|
+
This endpoint does not need any parameter.
|
83
|
+
|
84
|
+
### Return type
|
85
|
+
|
86
|
+
[**ListCustomerAddressesResponse**](ListCustomerAddressesResponse.md)
|
87
|
+
|
88
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
89
|
+
[[Back to README]](../../README.md)
|
90
|
+
## `update_customer_address()`
|
91
|
+
|
92
|
+
```ruby
|
93
|
+
update_customer_address(opts) # Updates an address associated with a customer account.
|
94
|
+
```
|
95
|
+
|
96
|
+
Updates an address associated with a customer account.
|
97
|
+
|
98
|
+
### Examples
|
99
|
+
|
100
|
+
```ruby
|
101
|
+
api_instance = Fastly::CustomerAddressesApi.new
|
102
|
+
opts = {
|
103
|
+
type: 'type_example', # String | Alphanumeric type of the address being modified.
|
104
|
+
customer_address: Fastly::CustomerAddress.new, # CustomerAddress |
|
105
|
+
}
|
106
|
+
|
107
|
+
begin
|
108
|
+
# Updates an address associated with a customer account.
|
109
|
+
api_instance.update_customer_address(opts)
|
110
|
+
rescue Fastly::ApiError => e
|
111
|
+
puts "Error when calling CustomerAddressesApi->update_customer_address: #{e}"
|
112
|
+
end
|
113
|
+
```
|
114
|
+
|
115
|
+
### Options
|
116
|
+
|
117
|
+
| Name | Type | Description | Notes |
|
118
|
+
| ---- | ---- | ----------- | ----- |
|
119
|
+
| **type** | **String** | Alphanumeric type of the address being modified. | |
|
120
|
+
| **customer_address** | [**CustomerAddress**](CustomerAddress.md) | | |
|
121
|
+
|
122
|
+
### Return type
|
123
|
+
|
124
|
+
nil (empty response body)
|
125
|
+
|
126
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
127
|
+
[[Back to README]](../../README.md)
|
data/docs/DomainInspector.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **timestamp** |
|
7
|
+
| **timestamp** | **Integer** | Value to use for subsequent requests. | [optional] |
|
8
8
|
| **aggregate_delay** | **Integer** | Offset of entry timestamps from the current time due to processing time. | [optional] |
|
9
9
|
| **data** | [**Array<DomainInspectorRealtimeEntry>**](DomainInspectorRealtimeEntry.md) | A list of report [entries](#entry-data-model), each representing one second of time. | [optional] |
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **recorded** |
|
7
|
+
| **recorded** | **Integer** | The Unix timestamp at which this record's data was generated. | [optional] |
|
8
8
|
| **aggregated** | [**Hash<String, DomainInspectorMeasurements>**](DomainInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name and then by IP address. | [optional] |
|
9
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
|
|
data/docs/EnabledProductsApi.md
CHANGED
@@ -13,9 +13,11 @@ api_instance = Fastly::EnabledProductsApi.new
|
|
13
13
|
|
14
14
|
Method | HTTP request | Description
|
15
15
|
------ | ------------ | -----------
|
16
|
-
[**disable_product**](EnabledProductsApi.md#disable_product) | **DELETE** /enabled-products/{product_id}/services/{service_id} | Disable a product
|
17
|
-
[**enable_product**](EnabledProductsApi.md#enable_product) | **PUT** /enabled-products/{product_id}/services/{service_id} | Enable a product
|
18
|
-
[**get_enabled_product**](EnabledProductsApi.md#get_enabled_product) | **GET** /enabled-products/{product_id}/services/{service_id} | Get enabled product
|
16
|
+
[**disable_product**](EnabledProductsApi.md#disable_product) | **DELETE** /enabled-products/v1/{product_id}/services/{service_id} | Disable a product
|
17
|
+
[**enable_product**](EnabledProductsApi.md#enable_product) | **PUT** /enabled-products/v1/{product_id}/services/{service_id} | Enable a product
|
18
|
+
[**get_enabled_product**](EnabledProductsApi.md#get_enabled_product) | **GET** /enabled-products/v1/{product_id}/services/{service_id} | Get enabled product
|
19
|
+
[**get_product_configuration**](EnabledProductsApi.md#get_product_configuration) | **GET** /enabled-products/v1/{product_id}/services/{service_id}/configuration | Get configuration for a product
|
20
|
+
[**set_product_configuration**](EnabledProductsApi.md#set_product_configuration) | **PATCH** /enabled-products/v1/{product_id}/services/{service_id}/configuration | Update configuration for a product
|
19
21
|
|
20
22
|
|
21
23
|
## `disable_product()`
|
@@ -24,14 +26,14 @@ Method | HTTP request | Description
|
|
24
26
|
disable_product(opts) # Disable a product
|
25
27
|
```
|
26
28
|
|
27
|
-
Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `
|
29
|
+
Disable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
|
28
30
|
|
29
31
|
### Examples
|
30
32
|
|
31
33
|
```ruby
|
32
34
|
api_instance = Fastly::EnabledProductsApi.new
|
33
35
|
opts = {
|
34
|
-
product_id: '
|
36
|
+
product_id: 'ngwaf', # String |
|
35
37
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
36
38
|
}
|
37
39
|
|
@@ -62,15 +64,16 @@ nil (empty response body)
|
|
62
64
|
enable_product(opts): <EnabledProductResponse> # Enable a product
|
63
65
|
```
|
64
66
|
|
65
|
-
Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `
|
67
|
+
Enable a product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
|
66
68
|
|
67
69
|
### Examples
|
68
70
|
|
69
71
|
```ruby
|
70
72
|
api_instance = Fastly::EnabledProductsApi.new
|
71
73
|
opts = {
|
72
|
-
product_id: '
|
74
|
+
product_id: 'ngwaf', # String |
|
73
75
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
76
|
+
set_workspace_id: Fastly::SetWorkspaceId.new, # SetWorkspaceId |
|
74
77
|
}
|
75
78
|
|
76
79
|
begin
|
@@ -88,6 +91,7 @@ end
|
|
88
91
|
| ---- | ---- | ----------- | ----- |
|
89
92
|
| **product_id** | **String** | | |
|
90
93
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
94
|
+
| **set_workspace_id** | [**SetWorkspaceId**](SetWorkspaceId.md) | | [optional] |
|
91
95
|
|
92
96
|
### Return type
|
93
97
|
|
@@ -101,14 +105,14 @@ end
|
|
101
105
|
get_enabled_product(opts): <EnabledProductResponse> # Get enabled product
|
102
106
|
```
|
103
107
|
|
104
|
-
Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, and `
|
108
|
+
Get enabled product on a service. Supported product IDs: `brotli_compression`,`domain_inspector`,`fanout`,`image_optimizer`,`origin_inspector`, `websockets`, `bot_management`, and `ngwaf`.
|
105
109
|
|
106
110
|
### Examples
|
107
111
|
|
108
112
|
```ruby
|
109
113
|
api_instance = Fastly::EnabledProductsApi.new
|
110
114
|
opts = {
|
111
|
-
product_id: '
|
115
|
+
product_id: 'ngwaf', # String |
|
112
116
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
113
117
|
}
|
114
118
|
|
@@ -134,3 +138,83 @@ end
|
|
134
138
|
|
135
139
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
136
140
|
[[Back to README]](../../README.md)
|
141
|
+
## `get_product_configuration()`
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
get_product_configuration(opts): <ConfiguredProductResponse> # Get configuration for a product
|
145
|
+
```
|
146
|
+
|
147
|
+
Get configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
|
148
|
+
|
149
|
+
### Examples
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
api_instance = Fastly::EnabledProductsApi.new
|
153
|
+
opts = {
|
154
|
+
product_id: 'ngwaf', # String |
|
155
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
156
|
+
}
|
157
|
+
|
158
|
+
begin
|
159
|
+
# Get configuration for a product
|
160
|
+
result = api_instance.get_product_configuration(opts)
|
161
|
+
p result
|
162
|
+
rescue Fastly::ApiError => e
|
163
|
+
puts "Error when calling EnabledProductsApi->get_product_configuration: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
### Options
|
168
|
+
|
169
|
+
| Name | Type | Description | Notes |
|
170
|
+
| ---- | ---- | ----------- | ----- |
|
171
|
+
| **product_id** | **String** | | |
|
172
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
173
|
+
|
174
|
+
### Return type
|
175
|
+
|
176
|
+
[**ConfiguredProductResponse**](ConfiguredProductResponse.md)
|
177
|
+
|
178
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
179
|
+
[[Back to README]](../../README.md)
|
180
|
+
## `set_product_configuration()`
|
181
|
+
|
182
|
+
```ruby
|
183
|
+
set_product_configuration(opts): <ConfiguredProductResponse> # Update configuration for a product
|
184
|
+
```
|
185
|
+
|
186
|
+
Update configuration for an enabled product on a service. Supported product IDs: `ngwaf`.
|
187
|
+
|
188
|
+
### Examples
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
api_instance = Fastly::EnabledProductsApi.new
|
192
|
+
opts = {
|
193
|
+
product_id: 'ngwaf', # String |
|
194
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
195
|
+
set_configuration: Fastly::SetConfiguration.new, # SetConfiguration |
|
196
|
+
}
|
197
|
+
|
198
|
+
begin
|
199
|
+
# Update configuration for a product
|
200
|
+
result = api_instance.set_product_configuration(opts)
|
201
|
+
p result
|
202
|
+
rescue Fastly::ApiError => e
|
203
|
+
puts "Error when calling EnabledProductsApi->set_product_configuration: #{e}"
|
204
|
+
end
|
205
|
+
```
|
206
|
+
|
207
|
+
### Options
|
208
|
+
|
209
|
+
| Name | Type | Description | Notes |
|
210
|
+
| ---- | ---- | ----------- | ----- |
|
211
|
+
| **product_id** | **String** | | |
|
212
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
213
|
+
| **set_configuration** | [**SetConfiguration**](SetConfiguration.md) | | [optional] |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**ConfiguredProductResponse**](ConfiguredProductResponse.md)
|
218
|
+
|
219
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
220
|
+
[[Back to README]](../../README.md)
|
data/docs/Environment.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::Environment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional][readonly] |
|
8
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional][readonly] |
|
9
|
+
| **active_version** | **Integer** | | [optional][readonly] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -1,9 +1,10 @@
|
|
1
|
-
# Fastly::
|
1
|
+
# Fastly::InlineResponse201
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Alphanumeric string identifying the address. | [optional] |
|
7
8
|
|
8
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
9
10
|
|
@@ -1,9 +1,10 @@
|
|
1
|
-
# Fastly::
|
1
|
+
# Fastly::ListCustomerAddressesResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<CustomerAddress>**](CustomerAddress.md) | | [optional] |
|
7
8
|
|
8
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
9
10
|
|
data/docs/OriginInspector.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **timestamp** |
|
7
|
+
| **timestamp** | **Integer** | Value to use for subsequent requests. | [optional] |
|
8
8
|
| **aggregate_delay** | **Integer** | Offset of entry timestamps from the current time due to processing time. | [optional] |
|
9
9
|
| **data** | [**Array<OriginInspectorRealtimeEntry>**](OriginInspectorRealtimeEntry.md) | A list of report [entries](#entry-data-model), each representing one second of time. | [optional] |
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **recorded** |
|
7
|
+
| **recorded** | **Integer** | The Unix timestamp at which this record's data was generated. | [optional] |
|
8
8
|
| **aggregated** | [**Hash<String, OriginInspectorMeasurements>**](OriginInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name. | [optional] |
|
9
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
|
|
@@ -253,6 +253,7 @@
|
|
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
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] |
|
256
|
+
| **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
|
256
257
|
|
257
258
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
258
259
|
|
@@ -253,6 +253,7 @@
|
|
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
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] |
|
256
|
+
| **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
|
256
257
|
|
257
258
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
258
259
|
|
data/docs/Results.md
CHANGED
@@ -253,6 +253,7 @@
|
|
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
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] |
|
256
|
+
| **request_denied_get_head_body** | **Integer** | Number of requests where Fastly responded with 400 due to the request being a GET or HEAD request containing a body. | [optional] |
|
256
257
|
| **service_id** | **String** | | [optional][readonly] |
|
257
258
|
| **start_time** | **Integer** | Timestamp for the start of the time period being reported | [optional] |
|
258
259
|
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
16
16
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
17
17
|
| **service_id** | **String** | | [optional][readonly] |
|
18
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
18
19
|
|
19
20
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
20
21
|
|
data/docs/ServiceDetail.md
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
| **publish_key** | **String** | Unused at this time. | [optional] |
|
16
16
|
| **paused** | **Boolean** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] |
|
17
17
|
| **versions** | [**Array<SchemasVersionResponse>**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] |
|
18
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
18
19
|
| **active_version** | [**ServiceVersionDetailOrNull**](ServiceVersionDetailOrNull.md) | | [optional] |
|
19
20
|
| **version** | [**ServiceVersionDetail**](ServiceVersionDetail.md) | | [optional] |
|
20
21
|
|
data/docs/ServiceListResponse.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **id** | **String** | | [optional][readonly] |
|
15
15
|
| **version** | **Integer** | Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service. | [optional] |
|
16
16
|
| **versions** | [**Array<SchemasVersionResponse>**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] |
|
17
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
17
18
|
|
18
19
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
19
20
|
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **id** | **String** | | [optional][readonly] |
|
8
8
|
| **version** | **Integer** | Current [version](https://www.fastly.com/documentation/reference/api/services/version/) of the service. | [optional] |
|
9
9
|
| **versions** | [**Array<SchemasVersionResponse>**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] |
|
10
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
10
11
|
|
11
12
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
13
|
|
data/docs/ServiceResponse.md
CHANGED
@@ -15,6 +15,7 @@
|
|
15
15
|
| **publish_key** | **String** | Unused at this time. | [optional] |
|
16
16
|
| **paused** | **Boolean** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] |
|
17
17
|
| **versions** | [**Array<SchemasVersionResponse>**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] |
|
18
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
18
19
|
|
19
20
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
20
21
|
|
@@ -8,6 +8,7 @@
|
|
8
8
|
| **publish_key** | **String** | Unused at this time. | [optional] |
|
9
9
|
| **paused** | **Boolean** | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. | [optional] |
|
10
10
|
| **versions** | [**Array<SchemasVersionResponse>**](SchemasVersionResponse.md) | A list of [versions](https://www.fastly.com/documentation/reference/api/services/version/) associated with the service. | [optional] |
|
11
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
11
12
|
|
12
13
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
14
|
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
16
16
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
17
17
|
| **service_id** | **String** | | [optional][readonly] |
|
18
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
18
19
|
| **backends** | [**Array<BackendResponse>**](BackendResponse.md) | List of backends associated to this service. | [optional] |
|
19
20
|
| **cache_settings** | [**Array<CacheSettingResponse>**](CacheSettingResponse.md) | List of cache settings associated to this service. | [optional] |
|
20
21
|
| **conditions** | [**Array<ConditionResponse>**](ConditionResponse.md) | List of conditions associated to this service. | [optional] |
|
@@ -15,6 +15,7 @@
|
|
15
15
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
16
16
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
17
17
|
| **service_id** | **String** | | [optional][readonly] |
|
18
|
+
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments where the service has been deployed. | [optional] |
|
18
19
|
| **backends** | [**Array<BackendResponse>**](BackendResponse.md) | List of backends associated to this service. | [optional] |
|
19
20
|
| **cache_settings** | [**Array<CacheSettingResponse>**](CacheSettingResponse.md) | List of cache settings associated to this service. | [optional] |
|
20
21
|
| **conditions** | [**Array<ConditionResponse>**](ConditionResponse.md) | List of conditions associated to this service. | [optional] |
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::SetConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **workspace_id** | **String** | The new workspace_id. Required in the `PUT` request body when `product_id` is `ngwaf`. Optional in the `PATCH` request body for `ngwaf`. | [optional] |
|
8
|
+
| **traffic_ramp** | **String** | The new traffic ramp. Optional in the `PATCH` request body for `ngwaf`. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::SetWorkspaceId
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **workspace_id** | **String** | The workspace to link with the Next-Gen WAF product. Note this body is only supported and required when `product_id` is `ngwaf` | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/TlsCertificatesApi.md
CHANGED
@@ -185,9 +185,9 @@ opts = {
|
|
185
185
|
filter_not_after: 'filter_not_after_example', # String | Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05).
|
186
186
|
filter_tls_domains_id: 'filter_tls_domains_id_example', # String | Limit the returned certificates to those that include the specific domain.
|
187
187
|
include: 'include_example', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`.
|
188
|
+
sort: 'created_at', # String | The order in which to list the results.
|
188
189
|
page_number: 1, # Integer | Current page.
|
189
190
|
page_size: 20, # Integer | Number of records per page.
|
190
|
-
sort: 'created_at', # String | The order in which to list the results by creation date.
|
191
191
|
}
|
192
192
|
|
193
193
|
begin
|
@@ -207,9 +207,9 @@ end
|
|
207
207
|
| **filter_not_after** | **String** | Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05). | [optional] |
|
208
208
|
| **filter_tls_domains_id** | **String** | Limit the returned certificates to those that include the specific domain. | [optional] |
|
209
209
|
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`. | [optional] |
|
210
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to '-created_at'] |
|
210
211
|
| **page_number** | **Integer** | Current page. | [optional] |
|
211
212
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
212
|
-
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
213
213
|
|
214
214
|
### Return type
|
215
215
|
|
data/docs/TlsDomainsApi.md
CHANGED
@@ -33,9 +33,9 @@ opts = {
|
|
33
33
|
filter_tls_certificates_id: 'filter_tls_certificates_id_example', # String | Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list.
|
34
34
|
filter_tls_subscriptions_id: 'filter_tls_subscriptions_id_example', # String | Optional. Limit the returned domains to those for a given TLS subscription.
|
35
35
|
include: 'include_example', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`.
|
36
|
+
sort: 'tls_activations.created_at', # String | The order in which to list the results.
|
36
37
|
page_number: 1, # Integer | Current page.
|
37
38
|
page_size: 20, # Integer | Number of records per page.
|
38
|
-
sort: 'created_at', # String | The order in which to list the results by creation date.
|
39
39
|
}
|
40
40
|
|
41
41
|
begin
|
@@ -55,9 +55,9 @@ end
|
|
55
55
|
| **filter_tls_certificates_id** | **String** | Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list. | [optional] |
|
56
56
|
| **filter_tls_subscriptions_id** | **String** | Optional. Limit the returned domains to those for a given TLS subscription. | [optional] |
|
57
57
|
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. | [optional] |
|
58
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to 'id'] |
|
58
59
|
| **page_number** | **Integer** | Current page. | [optional] |
|
59
60
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
60
|
-
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
61
61
|
|
62
62
|
### Return type
|
63
63
|
|
data/docs/TlsSubscriptionsApi.md
CHANGED
@@ -234,10 +234,10 @@ opts = {
|
|
234
234
|
filter_tls_domains_id: 'filter_tls_domains_id_example', # String | Limit the returned subscriptions to those that include the specific domain.
|
235
235
|
filter_has_active_order: true, # Boolean | Limit the returned subscriptions to those that have currently active orders. Permitted values: `true`.
|
236
236
|
filter_certificate_authority: 'filter_certificate_authority_example', # String | Limit the returned subscriptions to a specific certification authority. Values may include `certainly`, `lets-encrypt`, or `globalsign`.
|
237
|
+
sort: 'created_at', # String | The order in which to list the results.
|
237
238
|
include: 'tls_authorizations', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, `tls_authorizations.self_managed_http_challenge`, and `tls_certificates`.
|
238
239
|
page_number: 1, # Integer | Current page.
|
239
240
|
page_size: 20, # Integer | Number of records per page.
|
240
|
-
sort: 'created_at', # String | The order in which to list the results by creation date.
|
241
241
|
}
|
242
242
|
|
243
243
|
begin
|
@@ -257,10 +257,10 @@ end
|
|
257
257
|
| **filter_tls_domains_id** | **String** | Limit the returned subscriptions to those that include the specific domain. | [optional] |
|
258
258
|
| **filter_has_active_order** | **Boolean** | Limit the returned subscriptions to those that have currently active orders. Permitted values: `true`. | [optional] |
|
259
259
|
| **filter_certificate_authority** | **String** | Limit the returned subscriptions to a specific certification authority. Values may include `certainly`, `lets-encrypt`, or `globalsign`. | [optional] |
|
260
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to '-created_at'] |
|
260
261
|
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, `tls_authorizations.self_managed_http_challenge`, and `tls_certificates`. | [optional] |
|
261
262
|
| **page_number** | **Integer** | Current page. | [optional] |
|
262
263
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
263
|
-
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
264
264
|
|
265
265
|
### Return type
|
266
266
|
|