fastly 13.1.0 → 15.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +48 -0
- data/Gemfile.lock +4 -4
- data/README.md +26 -12
- data/docs/ApiDiscoveryResponseBodyGetAllServices.md +13 -0
- data/docs/ApiDiscoveryResponseCustomer.md +10 -0
- data/docs/{LogTimeseriesGetResponseMetaFilters.md → ApiDiscoveryResponseCustomerCustomer.md} +3 -2
- data/docs/ApiDiscoveryResponseEnable.md +12 -0
- data/docs/ApiDiscoveryResponseEnabledServices.md +10 -0
- data/docs/ApiDiscoveryResponseLinks.md +10 -0
- data/docs/ApiDiscoveryResponseLinksGetAllServices.md +10 -0
- data/docs/{LogTimeseriesResultDimensions.md → ApiDiscoveryResponseLinksGetAllServicesLinks.md} +2 -2
- data/docs/{DdosProtectionAction.md → ApiDiscoveryResponseLinksLinks.md} +2 -1
- data/docs/ApiDiscoveryResponseProduct.md +10 -0
- data/docs/ApiDiscoveryResponseProductProduct.md +11 -0
- data/docs/ApiDiscoveryResponseService.md +10 -0
- data/docs/{BotManagementResponseServiceService.md → ApiDiscoveryResponseServiceService.md} +1 -1
- data/docs/AttackReport.md +19 -0
- data/docs/AttackSignal.md +12 -0
- data/docs/AttackSource.md +13 -0
- data/docs/Backend.md +4 -4
- data/docs/BackendApi.md +10 -10
- data/docs/BackendResponse.md +4 -4
- data/docs/BotManagementResponseBodyEnable.md +1 -1
- data/docs/BotManagementResponseService.md +1 -1
- data/docs/BrotliCompressionResponseBodyEnable.md +1 -1
- data/docs/BrotliCompressionResponseService.md +1 -1
- data/docs/DdosProtectionApi.md +42 -0
- data/docs/DdosProtectionAttributeStats.md +1 -1
- data/docs/DdosProtectionInvalidRequest.md +13 -0
- data/docs/DdosProtectionNotAuthorized.md +11 -0
- data/docs/DdosProtectionResponseConfigure.md +1 -1
- data/docs/DdosProtectionResponseEnable.md +1 -1
- data/docs/DdosProtectionResponseService.md +1 -1
- data/docs/DdosProtectionRule.md +1 -1
- data/docs/DdosProtectionRuleAllOf.md +1 -1
- data/docs/DdosProtectionRulePatch.md +10 -0
- data/docs/DdosProtectionRuleWithStats.md +23 -0
- data/docs/DdosProtectionRuleWithStatsAllOf.md +10 -0
- data/docs/DdosProtectionTrafficStats.md +1 -0
- data/docs/DdosProtectionTrafficStatsAllOf.md +1 -0
- data/docs/DmDomainsApi.md +220 -0
- data/docs/DomainInspectorResponseBodyEnable.md +1 -1
- data/docs/DomainInspectorResponseService.md +1 -1
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/FanoutResponseBodyEnable.md +1 -1
- data/docs/FanoutResponseService.md +1 -1
- data/docs/Healthcheck.md +1 -1
- data/docs/HealthcheckApi.md +4 -4
- data/docs/HealthcheckResponse.md +1 -1
- data/docs/HistoricalApi.md +2 -0
- data/docs/IamRolesApi.md +23 -253
- data/docs/IamV1RoleListResponse.md +12 -0
- data/docs/IamV1RoleResponse.md +13 -0
- data/docs/ImageOptimizerResponseBodyEnable.md +1 -1
- data/docs/ImageOptimizerResponseService.md +1 -1
- data/docs/InlineResponse20010.md +10 -0
- data/docs/InlineResponse2003.md +2 -2
- data/docs/InlineResponse2004.md +2 -1
- data/docs/InlineResponse2005.md +1 -2
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +2 -1
- data/docs/InvitationDataAttributes.md +1 -0
- data/docs/KvStoreApi.md +4 -2
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/ListAttackReport.md +11 -0
- data/docs/ListAttackReportMeta.md +10 -0
- data/docs/{DdosProtectionTrafficAttribute.md → ListSignalReport.md} +2 -1
- data/docs/LogExplorerApi.md +1 -1
- data/docs/LogExplorerInsightsResponseBodyEnable.md +1 -1
- data/docs/LogExplorerInsightsResponseService.md +1 -1
- data/docs/LoggingHttpsAdditional.md +1 -0
- data/docs/LoggingHttpsApi.md +4 -0
- data/docs/LoggingHttpsResponse.md +1 -0
- data/docs/NgwafReportsApi.md +99 -0
- data/docs/NgwafResponseConfigure.md +1 -1
- data/docs/NgwafResponseEnable.md +1 -1
- data/docs/NgwafResponseService.md +1 -1
- data/docs/ObservabilityTimeseriesApi.md +67 -0
- data/docs/OriginInspectorResponseBodyEnable.md +1 -1
- data/docs/OriginInspectorResponseService.md +1 -1
- data/docs/PoolApi.md +4 -4
- data/docs/PoolResponse.md +1 -1
- data/docs/PoolResponseCommon.md +1 -1
- data/docs/PoolResponsePost.md +1 -1
- data/docs/ProductApiDiscoveryApi.md +163 -0
- data/docs/RealtimeEntryAggregated.md +1 -0
- data/docs/RealtimeMeasurements.md +1 -0
- data/docs/RequestBodyForCreate.md +12 -0
- data/docs/RequestBodyForUpdate.md +11 -0
- data/docs/Results.md +1 -0
- data/docs/SchemasUserResponse.md +1 -0
- data/docs/SecretStoreApi.md +2 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/ServiceAuthorizationsApi.md +2 -2
- data/docs/SignalReport.md +13 -0
- data/docs/SuccessfulResponseAsObject.md +17 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +15 -0
- data/docs/TimeseriesGetResponse.md +11 -0
- data/docs/TimeseriesMeta.md +13 -0
- data/docs/TimeseriesResult.md +11 -0
- data/docs/TlsSubscriptionsApi.md +0 -2
- data/docs/TopWorkspace.md +12 -0
- data/docs/User.md +1 -0
- data/docs/UserApi.md +4 -0
- data/docs/UserResponse.md +1 -0
- data/docs/WebsocketsResponseBodyEnable.md +1 -1
- data/docs/WebsocketsResponseService.md +1 -1
- data/lib/fastly/api/backend_api.rb +16 -16
- data/lib/fastly/api/ddos_protection_api.rb +73 -0
- data/lib/fastly/api/dm_domains_api.rb +362 -0
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/healthcheck_api.rb +20 -4
- data/lib/fastly/api/historical_api.rb +3 -0
- data/lib/fastly/api/iam_roles_api.rb +43 -435
- data/lib/fastly/api/kv_store_api.rb +6 -3
- data/lib/fastly/api/kv_store_item_api.rb +3 -3
- data/lib/fastly/api/logging_https_api.rb +6 -0
- data/lib/fastly/api/ngwaf_reports_api.rb +161 -0
- data/lib/fastly/api/{observability_timeseries_for_logs_api.rb → observability_timeseries_api.rb} +38 -43
- data/lib/fastly/api/pool_api.rb +4 -4
- data/lib/fastly/api/product_api_discovery_api.rb +263 -0
- data/lib/fastly/api/secret_store_api.rb +3 -3
- data/lib/fastly/api/secret_store_item_api.rb +3 -3
- data/lib/fastly/api/service_authorizations_api.rb +3 -3
- data/lib/fastly/api/tls_subscriptions_api.rb +0 -3
- data/lib/fastly/api/user_api.rb +6 -0
- data/lib/fastly/configuration.rb +75 -39
- data/lib/fastly/models/api_discovery_response_body_get_all_services.rb +256 -0
- data/lib/fastly/models/api_discovery_response_customer.rb +216 -0
- data/lib/fastly/models/api_discovery_response_customer_customer.rb +227 -0
- data/lib/fastly/models/api_discovery_response_enable.rb +243 -0
- data/lib/fastly/models/{log_timeseries_get_response_meta_filters.rb → api_discovery_response_enabled_services.rb} +12 -13
- data/lib/fastly/models/api_discovery_response_links.rb +216 -0
- data/lib/fastly/models/api_discovery_response_links_get_all_services.rb +216 -0
- data/lib/fastly/models/api_discovery_response_links_get_all_services_links.rb +217 -0
- data/lib/fastly/models/api_discovery_response_links_links.rb +217 -0
- data/lib/fastly/models/api_discovery_response_product.rb +216 -0
- data/lib/fastly/models/api_discovery_response_product_product.rb +227 -0
- data/lib/fastly/models/api_discovery_response_service.rb +216 -0
- data/lib/fastly/models/{bot_management_response_service_service.rb → api_discovery_response_service_service.rb} +3 -3
- data/lib/fastly/models/attack_report.rb +359 -0
- data/lib/fastly/models/attack_signal.rb +252 -0
- data/lib/fastly/models/attack_source.rb +267 -0
- data/lib/fastly/models/backend.rb +7 -1
- data/lib/fastly/models/backend_response.rb +7 -1
- data/lib/fastly/models/bot_management_response_body_enable.rb +1 -1
- data/lib/fastly/models/bot_management_response_service.rb +1 -1
- data/lib/fastly/models/brotli_compression_response_body_enable.rb +1 -1
- data/lib/fastly/models/brotli_compression_response_service.rb +1 -1
- data/lib/fastly/models/ddos_protection_attribute_stats.rb +2 -1
- data/lib/fastly/models/ddos_protection_invalid_request.rb +309 -0
- data/lib/fastly/models/{log_timeseries_filter_field_item.rb → ddos_protection_not_authorized.rb} +24 -36
- data/lib/fastly/models/ddos_protection_response_configure.rb +1 -1
- data/lib/fastly/models/ddos_protection_response_enable.rb +1 -1
- data/lib/fastly/models/ddos_protection_response_service.rb +1 -1
- data/lib/fastly/models/ddos_protection_rule.rb +2 -1
- data/lib/fastly/models/ddos_protection_rule_all_of.rb +2 -1
- data/lib/fastly/models/ddos_protection_rule_patch.rb +219 -0
- data/lib/fastly/models/ddos_protection_rule_with_stats.rb +365 -0
- data/lib/fastly/models/ddos_protection_rule_with_stats_all_of.rb +216 -0
- data/lib/fastly/models/ddos_protection_traffic_stats.rb +20 -4
- data/lib/fastly/models/ddos_protection_traffic_stats_all_of.rb +20 -4
- data/lib/fastly/models/domain_inspector_response_body_enable.rb +1 -1
- data/lib/fastly/models/domain_inspector_response_service.rb +1 -1
- data/lib/fastly/models/fanout_response_body_enable.rb +1 -1
- data/lib/fastly/models/fanout_response_service.rb +1 -1
- data/lib/fastly/models/healthcheck.rb +25 -1
- data/lib/fastly/models/healthcheck_response.rb +25 -1
- data/lib/fastly/models/iam_v1_role_list_response.rb +240 -0
- data/lib/fastly/models/{iam_role_all_of.rb → iam_v1_role_response.rb} +14 -34
- data/lib/fastly/models/image_optimizer_response_body_enable.rb +1 -1
- data/lib/fastly/models/image_optimizer_response_service.rb +1 -1
- data/lib/fastly/models/inline_response20010.rb +218 -0
- data/lib/fastly/models/inline_response2003.rb +11 -1
- data/lib/fastly/models/inline_response2004.rb +20 -8
- data/lib/fastly/models/inline_response2005.rb +8 -18
- data/lib/fastly/models/inline_response2006.rb +1 -1
- data/lib/fastly/models/inline_response2007.rb +1 -1
- data/lib/fastly/models/inline_response2008.rb +1 -1
- data/lib/fastly/models/inline_response2009.rb +13 -4
- data/lib/fastly/models/invitation_data_attributes.rb +12 -1
- data/lib/fastly/models/{log_timeseries_get_response.rb → list_attack_report.rb} +5 -5
- data/lib/fastly/models/list_attack_report_meta.rb +218 -0
- data/lib/fastly/models/{log_timeseries_result_dimensions.rb → list_signal_report.rb} +12 -10
- data/lib/fastly/models/log_explorer_insights_response_body_enable.rb +1 -1
- data/lib/fastly/models/log_explorer_insights_response_service.rb +1 -1
- data/lib/fastly/models/logging_https_additional.rb +16 -4
- data/lib/fastly/models/logging_https_response.rb +13 -1
- data/lib/fastly/models/ngwaf_response_configure.rb +1 -1
- data/lib/fastly/models/ngwaf_response_enable.rb +1 -1
- data/lib/fastly/models/ngwaf_response_service.rb +1 -1
- data/lib/fastly/models/origin_inspector_response_body_enable.rb +1 -1
- data/lib/fastly/models/origin_inspector_response_service.rb +1 -1
- data/lib/fastly/models/pool_response.rb +1 -1
- data/lib/fastly/models/pool_response_common.rb +1 -1
- data/lib/fastly/models/pool_response_post.rb +1 -1
- data/lib/fastly/models/realtime_entry_aggregated.rb +14 -4
- data/lib/fastly/models/realtime_measurements.rb +14 -4
- data/lib/fastly/models/request_body_for_create.rb +244 -0
- data/lib/fastly/models/request_body_for_update.rb +229 -0
- data/lib/fastly/models/results.rb +11 -1
- data/lib/fastly/models/role_user.rb +2 -0
- data/lib/fastly/models/schemas_user_response.rb +13 -1
- data/lib/fastly/models/signal_report.rb +249 -0
- data/lib/fastly/models/{iam_role.rb → successful_response_as_object.rb} +37 -35
- data/lib/fastly/models/successful_response_as_object_all_of.rb +268 -0
- data/lib/fastly/models/timeseries_get_response.rb +227 -0
- data/lib/fastly/models/{log_timeseries_get_response_meta.rb → timeseries_meta.rb} +23 -32
- data/lib/fastly/models/{log_timeseries_result.rb → timeseries_result.rb} +9 -5
- data/lib/fastly/models/top_workspace.rb +238 -0
- data/lib/fastly/models/user.rb +13 -1
- data/lib/fastly/models/user_response.rb +13 -1
- data/lib/fastly/models/websockets_response_body_enable.rb +1 -1
- data/lib/fastly/models/websockets_response_service.rb +1 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +40 -13
- data/sig.json +1 -1
- metadata +82 -28
- data/docs/IamRole.md +0 -17
- data/docs/IamRoleAllOf.md +0 -15
- data/docs/LogTimeseriesFilterFieldItem.md +0 -12
- data/docs/LogTimeseriesGetResponse.md +0 -11
- data/docs/LogTimeseriesGetResponseMeta.md +0 -14
- data/docs/LogTimeseriesResult.md +0 -11
- data/docs/LogTimeseriesValueField.md +0 -59
- data/docs/ObservabilityTimeseriesForLogsApi.md +0 -67
- data/lib/fastly/models/ddos_protection_action.rb +0 -37
- data/lib/fastly/models/ddos_protection_traffic_attribute.rb +0 -40
- data/lib/fastly/models/log_timeseries_value_field.rb +0 -108
data/docs/DdosProtectionApi.md
CHANGED
|
@@ -17,6 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
[**ddos_protection_event_list**](DdosProtectionApi.md#ddos_protection_event_list) | **GET** /ddos-protection/v1/events | Get events
|
|
18
18
|
[**ddos_protection_event_rule_list**](DdosProtectionApi.md#ddos_protection_event_rule_list) | **GET** /ddos-protection/v1/events/{event_id}/rules | Get all rules for an event
|
|
19
19
|
[**ddos_protection_rule_get**](DdosProtectionApi.md#ddos_protection_rule_get) | **GET** /ddos-protection/v1/rules/{rule_id} | Get a rule by ID
|
|
20
|
+
[**ddos_protection_rule_patch**](DdosProtectionApi.md#ddos_protection_rule_patch) | **PATCH** /ddos-protection/v1/rules/{rule_id} | Update rule
|
|
20
21
|
[**ddos_protection_traffic_stats_rule_get**](DdosProtectionApi.md#ddos_protection_traffic_stats_rule_get) | **GET** /ddos-protection/v1/events/{event_id}/rules/{rule_id}/traffic-stats | Get traffic stats for a rule
|
|
21
22
|
|
|
22
23
|
|
|
@@ -120,6 +121,7 @@ opts = {
|
|
|
120
121
|
event_id: 'event_id_example', # String | Unique ID of the event.
|
|
121
122
|
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.
|
|
122
123
|
limit: 56, # Integer | Limit how many results are returned.
|
|
124
|
+
include: 'include_example', # String | Include relationships. Optional. Comma-separated values.
|
|
123
125
|
}
|
|
124
126
|
|
|
125
127
|
begin
|
|
@@ -138,6 +140,7 @@ end
|
|
|
138
140
|
| **event_id** | **String** | Unique ID of the event. | |
|
|
139
141
|
| **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] |
|
|
140
142
|
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
143
|
+
| **include** | **String** | Include relationships. Optional. Comma-separated values. | [optional] |
|
|
141
144
|
|
|
142
145
|
### Return type
|
|
143
146
|
|
|
@@ -180,6 +183,45 @@ end
|
|
|
180
183
|
|
|
181
184
|
[**DdosProtectionRule**](DdosProtectionRule.md)
|
|
182
185
|
|
|
186
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
187
|
+
[[Back to README]](../../README.md)
|
|
188
|
+
## `ddos_protection_rule_patch()`
|
|
189
|
+
|
|
190
|
+
```ruby
|
|
191
|
+
ddos_protection_rule_patch(opts): <DdosProtectionRule> # Update rule
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Update rule.
|
|
195
|
+
|
|
196
|
+
### Examples
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
api_instance = Fastly::DdosProtectionApi.new
|
|
200
|
+
opts = {
|
|
201
|
+
rule_id: 'rule_id_example', # String | Unique ID of the rule.
|
|
202
|
+
ddos_protection_rule_patch: Fastly::DdosProtectionRulePatch.new, # DdosProtectionRulePatch |
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
begin
|
|
206
|
+
# Update rule
|
|
207
|
+
result = api_instance.ddos_protection_rule_patch(opts)
|
|
208
|
+
p result
|
|
209
|
+
rescue Fastly::ApiError => e
|
|
210
|
+
puts "Error when calling DdosProtectionApi->ddos_protection_rule_patch: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Options
|
|
215
|
+
|
|
216
|
+
| Name | Type | Description | Notes |
|
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
|
218
|
+
| **rule_id** | **String** | Unique ID of the rule. | |
|
|
219
|
+
| **ddos_protection_rule_patch** | [**DdosProtectionRulePatch**](DdosProtectionRulePatch.md) | | [optional] |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**DdosProtectionRule**](DdosProtectionRule.md)
|
|
224
|
+
|
|
183
225
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
184
226
|
[[Back to README]](../../README.md)
|
|
185
227
|
## `ddos_protection_traffic_stats_rule_get()`
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **name** |
|
|
7
|
+
| **name** | **String** | Name of an attribute type used in traffic stats. Currently, supported values are source_ip, country_code, host, asn, source_ip_prefix, user_agent, method_path. | [optional] |
|
|
8
8
|
| **values** | [**Array<DdosProtectionAttributeValue>**](DdosProtectionAttributeValue.md) | Values for traffic attribute. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::DdosProtectionInvalidRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | |
|
|
8
|
+
| **status** | **Integer** | | |
|
|
9
|
+
| **detail** | **String** | | |
|
|
10
|
+
| **errors** | [**Array<DdosProtectionErrorErrors>**](DdosProtectionErrorErrors.md) | | |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::DdosProtectionNotAuthorized
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **Integer** | | [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
|
| **product** | [**DdosProtectionResponseProductProduct**](DdosProtectionResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **configuration** | [**DdosProtectionResponseConfigurationConfiguration**](DdosProtectionResponseConfigurationConfiguration.md) | | [optional] |
|
|
10
10
|
| **_links** | [**DdosProtectionResponseLinksLinks**](DdosProtectionResponseLinksLinks.md) | | [optional] |
|
|
11
11
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **product** | [**DdosProtectionResponseProductProduct**](DdosProtectionResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **_links** | [**DdosProtectionResponseLinksLinks**](DdosProtectionResponseLinksLinks.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **service** | [**
|
|
7
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
10
|
|
data/docs/DdosProtectionRule.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
9
9
|
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
10
10
|
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
11
|
-
| **action** |
|
|
11
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
12
12
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
13
13
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
14
14
|
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
8
8
|
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
9
|
-
| **action** |
|
|
9
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
10
10
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
11
11
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
12
12
|
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DdosProtectionRulePatch
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Fastly::DdosProtectionRuleWithStats
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
8
|
+
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
9
|
+
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
10
|
+
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
11
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
12
|
+
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
13
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
14
|
+
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
|
15
|
+
| **country_code** | **String** | Country code attribute. | [optional] |
|
|
16
|
+
| **host** | **String** | Host attribute. | [optional] |
|
|
17
|
+
| **asn** | **String** | ASN attribute. | [optional] |
|
|
18
|
+
| **source_ip_prefix** | **String** | Source IP prefix attribute. | [optional] |
|
|
19
|
+
| **additional_attributes** | **Array<String>** | Attribute category for additional, unlisted attributes used in a rule. | [optional] |
|
|
20
|
+
| **traffic_stats** | [**DdosProtectionTrafficStats**](DdosProtectionTrafficStats.md) | | [optional] |
|
|
21
|
+
|
|
22
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
23
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DdosProtectionRuleWithStatsAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **traffic_stats** | [**DdosProtectionTrafficStats**](DdosProtectionTrafficStats.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
10
10
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
11
11
|
| **attributes** | [**Array<DdosProtectionAttributeStats>**](DdosProtectionAttributeStats.md) | | [optional] |
|
|
12
|
+
| **traffic_percentage** | **Float** | Rule traffic percentage for the event. | [optional] |
|
|
12
13
|
|
|
13
14
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
15
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
8
8
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
9
9
|
| **attributes** | [**Array<DdosProtectionAttributeStats>**](DdosProtectionAttributeStats.md) | | [optional] |
|
|
10
|
+
| **traffic_percentage** | **Float** | Rule traffic percentage for the event. | [optional] |
|
|
10
11
|
|
|
11
12
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
13
|
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# Fastly::DmDomainsApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::DmDomainsApi.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_dm_domain**](DmDomainsApi.md#create_dm_domain) | **POST** /domain-management/v1/domains | Create a domain
|
|
17
|
+
[**delete_dm_domain**](DmDomainsApi.md#delete_dm_domain) | **DELETE** /domain-management/v1/domains/{domain_id} | Delete a domain
|
|
18
|
+
[**get_dm_domain**](DmDomainsApi.md#get_dm_domain) | **GET** /domain-management/v1/domains/{domain_id} | Get a domain
|
|
19
|
+
[**list_dm_domains**](DmDomainsApi.md#list_dm_domains) | **GET** /domain-management/v1/domains | List domains
|
|
20
|
+
[**update_dm_domain**](DmDomainsApi.md#update_dm_domain) | **PATCH** /domain-management/v1/domains/{domain_id} | Update a domain
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
## `create_dm_domain()`
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
create_dm_domain(opts): <SuccessfulResponseAsObject> # Create a domain
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Create a domain
|
|
30
|
+
|
|
31
|
+
### Examples
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
api_instance = Fastly::DmDomainsApi.new
|
|
35
|
+
opts = {
|
|
36
|
+
request_body_for_create: Fastly::RequestBodyForCreate.new({fqdn: 'fqdn_example'}), # RequestBodyForCreate |
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Create a domain
|
|
41
|
+
result = api_instance.create_dm_domain(opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue Fastly::ApiError => e
|
|
44
|
+
puts "Error when calling DmDomainsApi->create_dm_domain: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Options
|
|
49
|
+
|
|
50
|
+
| Name | Type | Description | Notes |
|
|
51
|
+
| ---- | ---- | ----------- | ----- |
|
|
52
|
+
| **request_body_for_create** | [**RequestBodyForCreate**](RequestBodyForCreate.md) | | [optional] |
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
[**SuccessfulResponseAsObject**](SuccessfulResponseAsObject.md)
|
|
57
|
+
|
|
58
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
59
|
+
[[Back to README]](../../README.md)
|
|
60
|
+
## `delete_dm_domain()`
|
|
61
|
+
|
|
62
|
+
```ruby
|
|
63
|
+
delete_dm_domain(opts) # Delete a domain
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Delete a domain
|
|
67
|
+
|
|
68
|
+
### Examples
|
|
69
|
+
|
|
70
|
+
```ruby
|
|
71
|
+
api_instance = Fastly::DmDomainsApi.new
|
|
72
|
+
opts = {
|
|
73
|
+
domain_id: 'domain_id_example', # String |
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
begin
|
|
77
|
+
# Delete a domain
|
|
78
|
+
api_instance.delete_dm_domain(opts)
|
|
79
|
+
rescue Fastly::ApiError => e
|
|
80
|
+
puts "Error when calling DmDomainsApi->delete_dm_domain: #{e}"
|
|
81
|
+
end
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Options
|
|
85
|
+
|
|
86
|
+
| Name | Type | Description | Notes |
|
|
87
|
+
| ---- | ---- | ----------- | ----- |
|
|
88
|
+
| **domain_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_dm_domain()`
|
|
97
|
+
|
|
98
|
+
```ruby
|
|
99
|
+
get_dm_domain(opts): <SuccessfulResponseAsObject> # Get a domain
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Show a domain
|
|
103
|
+
|
|
104
|
+
### Examples
|
|
105
|
+
|
|
106
|
+
```ruby
|
|
107
|
+
api_instance = Fastly::DmDomainsApi.new
|
|
108
|
+
opts = {
|
|
109
|
+
domain_id: 'domain_id_example', # String |
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
# Get a domain
|
|
114
|
+
result = api_instance.get_dm_domain(opts)
|
|
115
|
+
p result
|
|
116
|
+
rescue Fastly::ApiError => e
|
|
117
|
+
puts "Error when calling DmDomainsApi->get_dm_domain: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Options
|
|
122
|
+
|
|
123
|
+
| Name | Type | Description | Notes |
|
|
124
|
+
| ---- | ---- | ----------- | ----- |
|
|
125
|
+
| **domain_id** | **String** | | |
|
|
126
|
+
|
|
127
|
+
### Return type
|
|
128
|
+
|
|
129
|
+
[**SuccessfulResponseAsObject**](SuccessfulResponseAsObject.md)
|
|
130
|
+
|
|
131
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
132
|
+
[[Back to README]](../../README.md)
|
|
133
|
+
## `list_dm_domains()`
|
|
134
|
+
|
|
135
|
+
```ruby
|
|
136
|
+
list_dm_domains(opts): <InlineResponse2004> # List domains
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
List all domains
|
|
140
|
+
|
|
141
|
+
### Examples
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
api_instance = Fastly::DmDomainsApi.new
|
|
145
|
+
opts = {
|
|
146
|
+
fqdn: 'fqdn_example', # String |
|
|
147
|
+
service_id: 'service_id_example', # String | Filter results based on a service_id.
|
|
148
|
+
sort: 'fqdn', # String | The order in which to list the results.
|
|
149
|
+
activated: true, # Boolean |
|
|
150
|
+
verified: true, # Boolean |
|
|
151
|
+
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.
|
|
152
|
+
limit: 56, # Integer | Limit how many results are returned.
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
begin
|
|
156
|
+
# List domains
|
|
157
|
+
result = api_instance.list_dm_domains(opts)
|
|
158
|
+
p result
|
|
159
|
+
rescue Fastly::ApiError => e
|
|
160
|
+
puts "Error when calling DmDomainsApi->list_dm_domains: #{e}"
|
|
161
|
+
end
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Options
|
|
165
|
+
|
|
166
|
+
| Name | Type | Description | Notes |
|
|
167
|
+
| ---- | ---- | ----------- | ----- |
|
|
168
|
+
| **fqdn** | **String** | | [optional] |
|
|
169
|
+
| **service_id** | **String** | Filter results based on a service_id. | [optional] |
|
|
170
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to 'fqdn'] |
|
|
171
|
+
| **activated** | **Boolean** | | [optional] |
|
|
172
|
+
| **verified** | **Boolean** | | [optional] |
|
|
173
|
+
| **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] |
|
|
174
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
175
|
+
|
|
176
|
+
### Return type
|
|
177
|
+
|
|
178
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
179
|
+
|
|
180
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
181
|
+
[[Back to README]](../../README.md)
|
|
182
|
+
## `update_dm_domain()`
|
|
183
|
+
|
|
184
|
+
```ruby
|
|
185
|
+
update_dm_domain(opts): <SuccessfulResponseAsObject> # Update a domain
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
Update a domain
|
|
189
|
+
|
|
190
|
+
### Examples
|
|
191
|
+
|
|
192
|
+
```ruby
|
|
193
|
+
api_instance = Fastly::DmDomainsApi.new
|
|
194
|
+
opts = {
|
|
195
|
+
domain_id: 'domain_id_example', # String |
|
|
196
|
+
request_body_for_update: Fastly::RequestBodyForUpdate.new, # RequestBodyForUpdate |
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
begin
|
|
200
|
+
# Update a domain
|
|
201
|
+
result = api_instance.update_dm_domain(opts)
|
|
202
|
+
p result
|
|
203
|
+
rescue Fastly::ApiError => e
|
|
204
|
+
puts "Error when calling DmDomainsApi->update_dm_domain: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Options
|
|
209
|
+
|
|
210
|
+
| Name | Type | Description | Notes |
|
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
|
212
|
+
| **domain_id** | **String** | | |
|
|
213
|
+
| **request_body_for_update** | [**RequestBodyForUpdate**](RequestBodyForUpdate.md) | | [optional] |
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
[**SuccessfulResponseAsObject**](SuccessfulResponseAsObject.md)
|
|
218
|
+
|
|
219
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
220
|
+
[[Back to README]](../../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **product** | [**DomainInspectorResponseProductProduct**](DomainInspectorResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **_links** | [**DomainInspectorResponseLinksLinks**](DomainInspectorResponseLinksLinks.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **service** | [**
|
|
7
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
10
|
|
data/docs/DomainOwnershipsApi.md
CHANGED
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
|
19
19
|
## `list_domain_ownerships()`
|
|
20
20
|
|
|
21
21
|
```ruby
|
|
22
|
-
list_domain_ownerships: <
|
|
22
|
+
list_domain_ownerships: <InlineResponse2005> # List domain-ownerships
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
List all domain-ownerships.
|
|
@@ -44,7 +44,7 @@ This endpoint does not need any parameter.
|
|
|
44
44
|
|
|
45
45
|
### Return type
|
|
46
46
|
|
|
47
|
-
[**
|
|
47
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
|
48
48
|
|
|
49
49
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
50
50
|
[[Back to README]](../../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **product** | [**FanoutResponseProductProduct**](FanoutResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **_links** | [**FanoutResponseLinksLinks**](FanoutResponseLinksLinks.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **service** | [**
|
|
7
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
10
|
|
data/docs/Healthcheck.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] |
|
|
7
|
+
| **check_interval** | **Integer** | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour. | [optional] |
|
|
8
8
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
9
9
|
| **expected_response** | **Integer** | The status code expected from the host. | [optional] |
|
|
10
10
|
| **headers** | **Array<String>** | Array of custom headers that will be added to the health check probes. | [optional] |
|
data/docs/HealthcheckApi.md
CHANGED
|
@@ -35,7 +35,7 @@ api_instance = Fastly::HealthcheckApi.new
|
|
|
35
35
|
opts = {
|
|
36
36
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
37
37
|
version_id: 56, # Integer | Integer identifying a service version.
|
|
38
|
-
check_interval: 56, # Integer | How often to run the health check in milliseconds.
|
|
38
|
+
check_interval: 56, # Integer | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour.
|
|
39
39
|
comment: 'comment_example', # String | A freeform descriptive note.
|
|
40
40
|
expected_response: 56, # Integer | The status code expected from the host.
|
|
41
41
|
headers: ['inner_example'], # Array<String> | Array of custom headers that will be added to the health check probes.
|
|
@@ -65,7 +65,7 @@ end
|
|
|
65
65
|
| ---- | ---- | ----------- | ----- |
|
|
66
66
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
67
67
|
| **version_id** | **Integer** | Integer identifying a service version. | |
|
|
68
|
-
| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] |
|
|
68
|
+
| **check_interval** | **Integer** | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour. | [optional] |
|
|
69
69
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
70
70
|
| **expected_response** | **Integer** | The status code expected from the host. | [optional] |
|
|
71
71
|
| **headers** | [**Array<String>**](String.md) | Array of custom headers that will be added to the health check probes. | [optional] |
|
|
@@ -222,7 +222,7 @@ opts = {
|
|
|
222
222
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
223
223
|
version_id: 56, # Integer | Integer identifying a service version.
|
|
224
224
|
healthcheck_name: 'healthcheck_name_example', # String | The name of the health check.
|
|
225
|
-
check_interval: 56, # Integer | How often to run the health check in milliseconds.
|
|
225
|
+
check_interval: 56, # Integer | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour.
|
|
226
226
|
comment: 'comment_example', # String | A freeform descriptive note.
|
|
227
227
|
expected_response: 56, # Integer | The status code expected from the host.
|
|
228
228
|
headers: ['inner_example'], # Array<String> | Array of custom headers that will be added to the health check probes.
|
|
@@ -253,7 +253,7 @@ end
|
|
|
253
253
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
254
254
|
| **version_id** | **Integer** | Integer identifying a service version. | |
|
|
255
255
|
| **healthcheck_name** | **String** | The name of the health check. | |
|
|
256
|
-
| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] |
|
|
256
|
+
| **check_interval** | **Integer** | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour. | [optional] |
|
|
257
257
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
258
258
|
| **expected_response** | **Integer** | The status code expected from the host. | [optional] |
|
|
259
259
|
| **headers** | [**Array<String>**](String.md) | Array of custom headers that will be added to the health check probes. | [optional] |
|
data/docs/HealthcheckResponse.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] |
|
|
7
|
+
| **check_interval** | **Integer** | How often to run the health check in milliseconds. Minimum 1 second, maximum 1 hour. | [optional] |
|
|
8
8
|
| **comment** | **String** | A freeform descriptive note. | [optional] |
|
|
9
9
|
| **expected_response** | **Integer** | The status code expected from the host. | [optional] |
|
|
10
10
|
| **headers** | **Array<String>** | Array of custom headers that will be added to the health check probes. | [optional] |
|
data/docs/HistoricalApi.md
CHANGED
|
@@ -41,6 +41,7 @@ opts = {
|
|
|
41
41
|
to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
|
|
42
42
|
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
|
|
43
43
|
region: 'usa', # String | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `mexico` - Mexico. * `southamerica_std` - South America.
|
|
44
|
+
services: 'services_example', # String | Limit the query to only the specified, comma-separated list of services.
|
|
44
45
|
}
|
|
45
46
|
|
|
46
47
|
begin
|
|
@@ -60,6 +61,7 @@ end
|
|
|
60
61
|
| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
|
|
61
62
|
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
|
|
62
63
|
| **region** | **String** | Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea. * `africa_std` - Africa. * `mexico` - Mexico. * `southamerica_std` - South America. | [optional] |
|
|
64
|
+
| **services** | **String** | Limit the query to only the specified, comma-separated list of services. | [optional] |
|
|
63
65
|
|
|
64
66
|
### Return type
|
|
65
67
|
|