fastly 14.0.0 → 15.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 +45 -0
- data/Gemfile.lock +1 -1
- data/README.md +22 -13
- data/docs/ApiDiscoveryResponseBodyGetAllServices.md +13 -0
- data/docs/ApiDiscoveryResponseCustomer.md +10 -0
- data/docs/ApiDiscoveryResponseCustomerCustomer.md +11 -0
- 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/ApiDiscoveryResponseLinksGetAllServicesLinks.md +10 -0
- data/docs/ApiDiscoveryResponseLinksLinks.md +10 -0
- 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/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 +2 -0
- data/docs/DdosProtectionEvent.md +2 -0
- data/docs/DdosProtectionEventAllOf.md +2 -0
- data/docs/DdosProtectionRequestEnableMode.md +10 -0
- data/docs/DdosProtectionResponseConfigure.md +1 -1
- data/docs/DdosProtectionResponseEnable.md +1 -1
- data/docs/DdosProtectionResponseService.md +1 -1
- 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/DomainInspectorHistoricalApi.md +1 -1
- data/docs/DomainInspectorResponseBodyEnable.md +1 -1
- data/docs/DomainInspectorResponseService.md +1 -1
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/DomainResearchApi.md +103 -0
- data/docs/DomainResearchResponseBodyEnable.md +12 -0
- data/docs/DomainResearchResponseCustomer.md +10 -0
- data/docs/DomainResearchResponseLinks.md +10 -0
- data/docs/DomainResearchResponseLinksLinks.md +10 -0
- data/docs/DomainResearchResponseProduct.md +10 -0
- data/docs/DomainResearchResponseProductProduct.md +11 -0
- 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/IamRolesApi.md +23 -253
- data/docs/IamV1RoleListResponse.md +12 -0
- data/docs/IamV1RoleResponse.md +14 -0
- data/docs/ImageOptimizerResponseBodyEnable.md +1 -1
- data/docs/ImageOptimizerResponseService.md +1 -1
- data/docs/InlineResponse20010.md +11 -0
- data/docs/InlineResponse20011.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 -2
- 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 +43 -4
- data/docs/KvStoreDetails.md +2 -0
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/{KvStoreRequestCreate.md → KvStoreRequestCreateOrUpdate.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/MetricsPlatformApi.md +75 -0
- data/docs/NgwafRequestEnable.md +1 -0
- data/docs/NgwafResponseConfigure.md +1 -1
- data/docs/NgwafResponseEnable.md +1 -1
- data/docs/NgwafResponseService.md +1 -1
- data/docs/Offer.md +12 -0
- data/docs/OfferAllOf.md +12 -0
- data/docs/OriginInspectorHistoricalApi.md +1 -1
- data/docs/OriginInspectorResponseBodyEnable.md +1 -1
- data/docs/OriginInspectorResponseService.md +1 -1
- data/docs/PlatformMetadata.md +14 -0
- data/docs/PlatformMetricsResponse.md +11 -0
- data/docs/PlatformValues.md +25 -0
- data/docs/ProductApiDiscoveryApi.md +163 -0
- data/docs/ProductDdosProtectionApi.md +3 -1
- data/docs/ProductDomainResearchApi.md +115 -0
- data/docs/RealtimeEntryAggregated.md +5 -0
- data/docs/RealtimeMeasurements.md +5 -0
- data/docs/RequestBodyForCreate.md +12 -0
- data/docs/RequestBodyForUpdate.md +11 -0
- data/docs/Results.md +5 -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/Status.md +15 -0
- data/docs/StatusAllOf.md +15 -0
- data/docs/SuccessfulResponseAsObject.md +17 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +15 -0
- data/docs/Suggestion.md +13 -0
- data/docs/SuggestionAllOf.md +13 -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/ddos_protection_api.rb +3 -0
- data/lib/fastly/api/dm_domains_api.rb +362 -0
- data/lib/fastly/api/domain_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/domain_research_api.rb +163 -0
- data/lib/fastly/api/healthcheck_api.rb +20 -4
- data/lib/fastly/api/iam_roles_api.rb +43 -435
- data/lib/fastly/api/kv_store_api.rb +74 -6
- 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/metrics_platform_api.rb +134 -0
- data/lib/fastly/api/origin_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/product_api_discovery_api.rb +263 -0
- data/lib/fastly/api/product_ddos_protection_api.rb +10 -3
- data/lib/fastly/api/product_domain_research_api.rb +186 -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/user_api.rb +6 -0
- data/lib/fastly/configuration.rb +98 -38
- 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/api_discovery_response_enabled_services.rb +219 -0
- 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/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_event.rb +21 -1
- data/lib/fastly/models/ddos_protection_event_all_of.rb +21 -1
- data/lib/fastly/models/ddos_protection_request_enable_mode.rb +251 -0
- 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_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/domain_research_response_body_enable.rb +243 -0
- data/lib/fastly/models/domain_research_response_customer.rb +216 -0
- data/lib/fastly/models/domain_research_response_links.rb +216 -0
- data/lib/fastly/models/domain_research_response_links_links.rb +217 -0
- data/lib/fastly/models/domain_research_response_product.rb +216 -0
- data/lib/fastly/models/domain_research_response_product_product.rb +227 -0
- 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} +23 -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 +227 -0
- data/lib/fastly/models/inline_response20011.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 +8 -17
- 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/kv_store_details.rb +24 -4
- data/lib/fastly/models/{kv_store_request_create.rb → kv_store_request_create_or_update.rb} +3 -3
- 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_request_enable.rb +14 -4
- 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/offer.rb +245 -0
- data/lib/fastly/models/offer_all_of.rb +237 -0
- 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/platform_metadata.rb +258 -0
- data/lib/fastly/models/platform_metrics_response.rb +228 -0
- data/lib/fastly/models/platform_values.rb +368 -0
- data/lib/fastly/models/realtime_entry_aggregated.rb +54 -4
- data/lib/fastly/models/realtime_measurements.rb +54 -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 +51 -1
- data/lib/fastly/models/role_user.rb +2 -0
- data/lib/fastly/models/schemas_user_response.rb +13 -1
- data/lib/fastly/models/status.rb +276 -0
- data/lib/fastly/models/status_all_of.rb +268 -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/suggestion.rb +255 -0
- data/lib/fastly/models/suggestion_all_of.rb +247 -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 +45 -4
- data/sig.json +1 -1
- metadata +92 -10
- data/docs/IamRole.md +0 -17
- data/docs/IamRoleAllOf.md +0 -15
|
@@ -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)
|
|
@@ -37,7 +37,7 @@ opts = {
|
|
|
37
37
|
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).
|
|
38
38
|
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
|
39
39
|
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.
|
|
40
|
-
region: '
|
|
40
|
+
region: 'africa_std', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
41
41
|
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
42
42
|
domain: 'domain_1.com,domain_2.com', # String | Limit query to one or more specific domains. Values should be comma-separated.
|
|
43
43
|
}
|
|
@@ -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)
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Fastly::DomainResearchApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::DomainResearchApi.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
|
+
[**domain_status**](DomainResearchApi.md#domain_status) | **GET** /domain-management/v1/tools/status | Domain status
|
|
17
|
+
[**suggest_domains**](DomainResearchApi.md#suggest_domains) | **GET** /domain-management/v1/tools/suggest | Suggest domains
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## `domain_status()`
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
domain_status(opts): <Status> # Domain status
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The `Status` method checks the availability status of a single domain name.
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
api_instance = Fastly::DomainResearchApi.new
|
|
32
|
+
opts = {
|
|
33
|
+
domain: 'acmecoffee.shop', # String |
|
|
34
|
+
scope: 'estimate', # String |
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Domain status
|
|
39
|
+
result = api_instance.domain_status(opts)
|
|
40
|
+
p result
|
|
41
|
+
rescue Fastly::ApiError => e
|
|
42
|
+
puts "Error when calling DomainResearchApi->domain_status: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Options
|
|
47
|
+
|
|
48
|
+
| Name | Type | Description | Notes |
|
|
49
|
+
| ---- | ---- | ----------- | ----- |
|
|
50
|
+
| **domain** | **String** | | |
|
|
51
|
+
| **scope** | **String** | | [optional] |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
[**Status**](Status.md)
|
|
56
|
+
|
|
57
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
58
|
+
[[Back to README]](../../README.md)
|
|
59
|
+
## `suggest_domains()`
|
|
60
|
+
|
|
61
|
+
```ruby
|
|
62
|
+
suggest_domains(opts): <InlineResponse2006> # Suggest domains
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
The `Suggest` method performs a real-time query of the search term(s) against the [known zone database](http://zonedb.org), making recommendations, stemming, and applying Unicode folding, IDN normalization, registrar supported-zone restrictions, and other refinements. **Note:** `Suggest` method responses do not include domain availability status.
|
|
66
|
+
|
|
67
|
+
### Examples
|
|
68
|
+
|
|
69
|
+
```ruby
|
|
70
|
+
api_instance = Fastly::DomainResearchApi.new
|
|
71
|
+
opts = {
|
|
72
|
+
query: 'foo%20bar', # String |
|
|
73
|
+
defaults: 'club', # String |
|
|
74
|
+
keywords: 'food,kitchen', # String |
|
|
75
|
+
location: 'de', # String |
|
|
76
|
+
vendor: 'dnsimple.com', # String |
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
begin
|
|
80
|
+
# Suggest domains
|
|
81
|
+
result = api_instance.suggest_domains(opts)
|
|
82
|
+
p result
|
|
83
|
+
rescue Fastly::ApiError => e
|
|
84
|
+
puts "Error when calling DomainResearchApi->suggest_domains: #{e}"
|
|
85
|
+
end
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Options
|
|
89
|
+
|
|
90
|
+
| Name | Type | Description | Notes |
|
|
91
|
+
| ---- | ---- | ----------- | ----- |
|
|
92
|
+
| **query** | **String** | | |
|
|
93
|
+
| **defaults** | **String** | | [optional] |
|
|
94
|
+
| **keywords** | **String** | | [optional] |
|
|
95
|
+
| **location** | **String** | | [optional] |
|
|
96
|
+
| **vendor** | **String** | | [optional] |
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
|
101
|
+
|
|
102
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
103
|
+
[[Back to README]](../../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseBodyEnable
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product** | [**DomainResearchResponseProductProduct**](DomainResearchResponseProductProduct.md) | | [optional] |
|
|
8
|
+
| **customer** | [**AiAcceleratorResponseCustomerCustomer**](AiAcceleratorResponseCustomerCustomer.md) | | [optional] |
|
|
9
|
+
| **_links** | [**DomainResearchResponseLinksLinks**](DomainResearchResponseLinksLinks.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseCustomer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer** | [**AiAcceleratorResponseCustomerCustomer**](AiAcceleratorResponseCustomerCustomer.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**DomainResearchResponseLinksLinks**](DomainResearchResponseLinksLinks.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseLinksLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_self** | **String** | Location of resource | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product** | [**DomainResearchResponseProductProduct**](DomainResearchResponseProductProduct.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::DomainResearchResponseProductProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Product identifier | [optional] |
|
|
8
|
+
| **object** | **String** | Name of the object | [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** | [**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] |
|