fastly 14.0.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 +23 -0
- data/Gemfile.lock +1 -1
- data/README.md +13 -11
- 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/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/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/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 +2 -2
- data/docs/KvStoreItemApi.md +2 -2
- 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/NgwafResponseConfigure.md +1 -1
- data/docs/NgwafResponseEnable.md +1 -1
- data/docs/NgwafResponseService.md +1 -1
- data/docs/OriginInspectorResponseBodyEnable.md +1 -1
- data/docs/OriginInspectorResponseService.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/SuccessfulResponseAsObject.md +17 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +15 -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_ownerships_api.rb +3 -3
- 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 +3 -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/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/user_api.rb +6 -0
- data/lib/fastly/configuration.rb +56 -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_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/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_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/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/{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/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 +24 -3
- data/sig.json +1 -1
- metadata +50 -8
- data/docs/IamRole.md +0 -17
- data/docs/IamRoleAllOf.md +0 -15
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 811f03dabea8e6389703a81b5ae3f196631b6798af56c3273d932b488f860d66
|
|
4
|
+
data.tar.gz: 202ad7a54a01df5c22282dd5b7140c2d282955112aae00019f06db85a2f58003
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d2aea4e009761f11d495110ad76e5060abb255afef6ce5f659fe83c943cca324dec30f34cc7175b6d210a7d17a040052583c11db1a70e2272e27a56b3e1d5563
|
|
7
|
+
data.tar.gz: 430a5ad918dccf92a42971dd87b1c357b4188bde959753a0c13bd2b79cd385555b4a09999b7b1dded56327afbd7bbcabb30c9f6b22d7157badcfdde93a17abd9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [v15.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v15.0.0) (2025-10-31)
|
|
4
|
+
|
|
5
|
+
**Bug fixes:**
|
|
6
|
+
|
|
7
|
+
- fix(dictionary): Correct example dictionary name to use valid characters
|
|
8
|
+
|
|
9
|
+
**Enhancements:**
|
|
10
|
+
|
|
11
|
+
- feat(iam_roles): Add new IAM Roles API.
|
|
12
|
+
- feat(api_discovery): Add new API Discovery API.
|
|
13
|
+
- feat(realtime, historical): Add new metric `api_discovery_requests_count`.
|
|
14
|
+
- feat(user): Add the ability to assign multiple roles to users.
|
|
15
|
+
- feat(healthcheck): Clarify the valid range for the `check_interval` parameter.
|
|
16
|
+
- feat(ddos_protection): Add `traffic_percentage` field to DDoS Protection traffic statistics responses.
|
|
17
|
+
- feat(ddos_protection): Update `ddos-protection-event-rule-list` with `include=traffic_stats` parameter for embedded traffic statistics.
|
|
18
|
+
- feat(logging_https): Add `period` parameter to the logging HTTPS endpoint.
|
|
19
|
+
|
|
20
|
+
**Documentation:**
|
|
21
|
+
|
|
22
|
+
- doc(sudo): Spelling fixes.
|
|
23
|
+
- doc(enabled-products): Add support for product ID `api_discovery`.
|
|
24
|
+
|
|
25
|
+
|
|
3
26
|
## [v14.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v14.0.0) (2025-08-28)
|
|
4
27
|
|
|
5
28
|
**Breaking Changes:**
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
|
|
|
8
8
|
To install via RubyGems, add the following to your project's `Gemfile`:
|
|
9
9
|
|
|
10
10
|
```ruby
|
|
11
|
-
gem 'fastly', '~>
|
|
11
|
+
gem 'fastly', '~> 15.0.0'
|
|
12
12
|
```
|
|
13
13
|
|
|
14
14
|
Then run `bundle install`.
|
|
@@ -174,6 +174,11 @@ Class | Method | Description
|
|
|
174
174
|
[*Fastly::DirectorBackendApi*](docs/DirectorBackendApi.md) | [**create_director_backend**](docs/DirectorBackendApi.md#create_director_backend) | Create a director-backend relationship
|
|
175
175
|
[*Fastly::DirectorBackendApi*](docs/DirectorBackendApi.md) | [**delete_director_backend**](docs/DirectorBackendApi.md#delete_director_backend) | Delete a director-backend relationship
|
|
176
176
|
[*Fastly::DirectorBackendApi*](docs/DirectorBackendApi.md) | [**get_director_backend**](docs/DirectorBackendApi.md#get_director_backend) | Get a director-backend relationship
|
|
177
|
+
[*Fastly::DmDomainsApi*](docs/DmDomainsApi.md) | [**create_dm_domain**](docs/DmDomainsApi.md#create_dm_domain) | Create a domain
|
|
178
|
+
[*Fastly::DmDomainsApi*](docs/DmDomainsApi.md) | [**delete_dm_domain**](docs/DmDomainsApi.md#delete_dm_domain) | Delete a domain
|
|
179
|
+
[*Fastly::DmDomainsApi*](docs/DmDomainsApi.md) | [**get_dm_domain**](docs/DmDomainsApi.md#get_dm_domain) | Get a domain
|
|
180
|
+
[*Fastly::DmDomainsApi*](docs/DmDomainsApi.md) | [**list_dm_domains**](docs/DmDomainsApi.md#list_dm_domains) | List domains
|
|
181
|
+
[*Fastly::DmDomainsApi*](docs/DmDomainsApi.md) | [**update_dm_domain**](docs/DmDomainsApi.md#update_dm_domain) | Update a domain
|
|
177
182
|
[*Fastly::DomainApi*](docs/DomainApi.md) | [**check_domain**](docs/DomainApi.md#check_domain) | Validate DNS configuration for a single domain on a service
|
|
178
183
|
[*Fastly::DomainApi*](docs/DomainApi.md) | [**check_domains**](docs/DomainApi.md#check_domains) | Validate DNS configuration for all domains on a service
|
|
179
184
|
[*Fastly::DomainApi*](docs/DomainApi.md) | [**create_domain**](docs/DomainApi.md#create_domain) | Add a domain name to a service
|
|
@@ -216,14 +221,8 @@ Class | Method | Description
|
|
|
216
221
|
[*Fastly::Http3Api*](docs/Http3Api.md) | [**delete_http3**](docs/Http3Api.md#delete_http3) | Disable support for HTTP/3
|
|
217
222
|
[*Fastly::Http3Api*](docs/Http3Api.md) | [**get_http3**](docs/Http3Api.md#get_http3) | Get HTTP/3 status
|
|
218
223
|
[*Fastly::IamPermissionsApi*](docs/IamPermissionsApi.md) | [**list_permissions**](docs/IamPermissionsApi.md#list_permissions) | List permissions
|
|
219
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**
|
|
220
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**
|
|
221
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**delete_a_role**](docs/IamRolesApi.md#delete_a_role) | Delete a role
|
|
222
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**get_a_role**](docs/IamRolesApi.md#get_a_role) | Get a role
|
|
223
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**list_role_permissions**](docs/IamRolesApi.md#list_role_permissions) | List permissions in a role
|
|
224
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**list_roles**](docs/IamRolesApi.md#list_roles) | List roles
|
|
225
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**remove_role_permissions**](docs/IamRolesApi.md#remove_role_permissions) | Remove permissions from a role
|
|
226
|
-
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**update_a_role**](docs/IamRolesApi.md#update_a_role) | Update a role
|
|
224
|
+
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**iam_v1_roles_get**](docs/IamRolesApi.md#iam_v1_roles_get) | Get IAM role by ID
|
|
225
|
+
[*Fastly::IamRolesApi*](docs/IamRolesApi.md) | [**iam_v1_roles_list**](docs/IamRolesApi.md#iam_v1_roles_list) | List IAM roles
|
|
227
226
|
[*Fastly::IamServiceGroupsApi*](docs/IamServiceGroupsApi.md) | [**add_service_group_services**](docs/IamServiceGroupsApi.md#add_service_group_services) | Add services in a service group
|
|
228
227
|
[*Fastly::IamServiceGroupsApi*](docs/IamServiceGroupsApi.md) | [**create_a_service_group**](docs/IamServiceGroupsApi.md#create_a_service_group) | Create a service group
|
|
229
228
|
[*Fastly::IamServiceGroupsApi*](docs/IamServiceGroupsApi.md) | [**delete_a_service_group**](docs/IamServiceGroupsApi.md#delete_a_service_group) | Delete a service group
|
|
@@ -434,6 +433,10 @@ Class | Method | Description
|
|
|
434
433
|
[*Fastly::ProductAiAcceleratorApi*](docs/ProductAiAcceleratorApi.md) | [**disable_product_ai_accelerator**](docs/ProductAiAcceleratorApi.md#disable_product_ai_accelerator) | Disable product
|
|
435
434
|
[*Fastly::ProductAiAcceleratorApi*](docs/ProductAiAcceleratorApi.md) | [**enable_ai_accelerator**](docs/ProductAiAcceleratorApi.md#enable_ai_accelerator) | Enable product
|
|
436
435
|
[*Fastly::ProductAiAcceleratorApi*](docs/ProductAiAcceleratorApi.md) | [**get_ai_accelerator**](docs/ProductAiAcceleratorApi.md#get_ai_accelerator) | Get product enablement status
|
|
436
|
+
[*Fastly::ProductApiDiscoveryApi*](docs/ProductApiDiscoveryApi.md) | [**disable_product_api_discovery**](docs/ProductApiDiscoveryApi.md#disable_product_api_discovery) | Disable product
|
|
437
|
+
[*Fastly::ProductApiDiscoveryApi*](docs/ProductApiDiscoveryApi.md) | [**enable_product_api_discovery**](docs/ProductApiDiscoveryApi.md#enable_product_api_discovery) | Enable product
|
|
438
|
+
[*Fastly::ProductApiDiscoveryApi*](docs/ProductApiDiscoveryApi.md) | [**get_product_api_discovery**](docs/ProductApiDiscoveryApi.md#get_product_api_discovery) | Get product enablement status
|
|
439
|
+
[*Fastly::ProductApiDiscoveryApi*](docs/ProductApiDiscoveryApi.md) | [**get_services_product_api_discovery**](docs/ProductApiDiscoveryApi.md#get_services_product_api_discovery) | Get services with product enabled
|
|
437
440
|
[*Fastly::ProductBotManagementApi*](docs/ProductBotManagementApi.md) | [**disable_product_bot_management**](docs/ProductBotManagementApi.md#disable_product_bot_management) | Disable product
|
|
438
441
|
[*Fastly::ProductBotManagementApi*](docs/ProductBotManagementApi.md) | [**enable_product_bot_management**](docs/ProductBotManagementApi.md#enable_product_bot_management) | Enable product
|
|
439
442
|
[*Fastly::ProductBotManagementApi*](docs/ProductBotManagementApi.md) | [**get_product_bot_management**](docs/ProductBotManagementApi.md#get_product_bot_management) | Get product enablement status
|
|
@@ -643,8 +646,6 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
|
643
646
|
- [`/alerts/history`](https://www.fastly.com/documentation/reference/api/observability/alerts/history) (GET)
|
|
644
647
|
- [`/dns/configurations/{dns_configuration_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
|
645
648
|
- [`/dns/configurations`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
646
|
-
- [`/domain-management/v1/domains/{domain_id}`](https://www.fastly.com/documentation/reference/api/) (DELETE, GET, PATCH)
|
|
647
|
-
- [`/domain-management/v1/domains`](https://www.fastly.com/documentation/reference/api/) (GET, POST)
|
|
648
649
|
- [`/domains/v1/tools/status`](https://www.fastly.com/documentation/reference/api/) (GET)
|
|
649
650
|
- [`/domains/v1/tools/suggest`](https://www.fastly.com/documentation/reference/api/) (GET)
|
|
650
651
|
- [`/ngwaf/v1/lists/{listId}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/lists) (DELETE, GET, PATCH)
|
|
@@ -661,6 +662,7 @@ The fastly-ruby API client currently does not support the following endpoints:
|
|
|
661
662
|
- [`/ngwaf/v1/workspaces/{workspace_id}/events`](https://www.fastly.com/documentation/reference/api/ngwaf/events) (GET)
|
|
662
663
|
- [`/ngwaf/v1/workspaces/{workspace_id}/redactions/{redaction_id}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/redactions) (DELETE, GET, PATCH)
|
|
663
664
|
- [`/ngwaf/v1/workspaces/{workspace_id}/redactions`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/redactions) (GET, POST)
|
|
665
|
+
- [`/ngwaf/v1/workspaces/{workspace_id}/requests/{request_id}/report`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/requests) (POST)
|
|
664
666
|
- [`/ngwaf/v1/workspaces/{workspace_id}/requests/{request_id}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/requests) (GET)
|
|
665
667
|
- [`/ngwaf/v1/workspaces/{workspace_id}/requests`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/requests) (GET)
|
|
666
668
|
- [`/ngwaf/v1/workspaces/{workspace_id}/rules/{rule_id}`](https://www.fastly.com/documentation/reference/api/ngwaf/v1/rules) (DELETE, GET, PATCH)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseBodyGetAllServices
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product** | [**ApiDiscoveryResponseProductProduct**](ApiDiscoveryResponseProductProduct.md) | | [optional] |
|
|
8
|
+
| **customer** | [**ApiDiscoveryResponseCustomerCustomer**](ApiDiscoveryResponseCustomerCustomer.md) | | [optional] |
|
|
9
|
+
| **services** | **Array<String>** | A list of services for a customer with API Discovery enabled. | [optional] |
|
|
10
|
+
| **_links** | [**ApiDiscoveryResponseLinksGetAllServicesLinks**](ApiDiscoveryResponseLinksGetAllServicesLinks.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseCustomer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer** | [**ApiDiscoveryResponseCustomerCustomer**](ApiDiscoveryResponseCustomerCustomer.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseCustomerCustomer
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Customer 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
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseEnable
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product** | [**ApiDiscoveryResponseProductProduct**](ApiDiscoveryResponseProductProduct.md) | | [optional] |
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
|
+
| **_links** | [**ApiDiscoveryResponseLinksLinks**](ApiDiscoveryResponseLinksLinks.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseEnabledServices
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **services** | **Array<String>** | A list of services for a customer with API Discovery enabled. | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseLinks
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**ApiDiscoveryResponseLinksLinks**](ApiDiscoveryResponseLinksLinks.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseLinksGetAllServices
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**ApiDiscoveryResponseLinksGetAllServicesLinks**](ApiDiscoveryResponseLinksGetAllServicesLinks.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseLinksGetAllServicesLinks
|
|
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::ApiDiscoveryResponseLinksLinks
|
|
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::ApiDiscoveryResponseProduct
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **product** | [**ApiDiscoveryResponseProductProduct**](ApiDiscoveryResponseProductProduct.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseProductProduct
|
|
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
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::ApiDiscoveryResponseService
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **product** | [**BotManagementResponseProductProduct**](BotManagementResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **_links** | [**BotManagementResponseLinksLinks**](BotManagementResponseLinksLinks.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
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **product** | [**BrotliCompressionResponseProductProduct**](BrotliCompressionResponseProductProduct.md) | | [optional] |
|
|
8
|
-
| **service** | [**
|
|
8
|
+
| **service** | [**ApiDiscoveryResponseServiceService**](ApiDiscoveryResponseServiceService.md) | | [optional] |
|
|
9
9
|
| **_links** | [**BrotliCompressionResponseLinksLinks**](BrotliCompressionResponseLinksLinks.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/DdosProtectionApi.md
CHANGED
|
@@ -121,6 +121,7 @@ opts = {
|
|
|
121
121
|
event_id: 'event_id_example', # String | Unique ID of the event.
|
|
122
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.
|
|
123
123
|
limit: 56, # Integer | Limit how many results are returned.
|
|
124
|
+
include: 'include_example', # String | Include relationships. Optional. Comma-separated values.
|
|
124
125
|
}
|
|
125
126
|
|
|
126
127
|
begin
|
|
@@ -139,6 +140,7 @@ end
|
|
|
139
140
|
| **event_id** | **String** | Unique ID of the event. | |
|
|
140
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] |
|
|
141
142
|
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
143
|
+
| **include** | **String** | Include relationships. Optional. Comma-separated values. | [optional] |
|
|
142
144
|
|
|
143
145
|
### Return type
|
|
144
146
|
|
|
@@ -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
|
|
|
@@ -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)
|