fastly 16.1.0 → 17.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 +58 -0
- data/Gemfile.lock +1 -1
- data/README.md +101 -58
- data/docs/Action.md +11 -0
- data/docs/ActionType.md +9 -0
- data/docs/AgentKey.md +14 -0
- data/docs/AgentKeyMeta.md +10 -0
- data/docs/Backend.md +3 -1
- data/docs/BackendApi.md +12 -4
- data/docs/BackendResponse.md +3 -1
- data/docs/BotManagementRequestUpdateConfiguration.md +10 -0
- data/docs/BotManagementResponseConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigurationConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigure.md +13 -0
- data/docs/ClientSideProtectionApi.md +821 -0
- data/docs/ConditionOperator.md +9 -0
- data/docs/ConditionType.md +9 -0
- data/docs/DdosProtectionApi.md +4 -4
- data/docs/Directive.md +11 -0
- data/docs/DmDomainsApi.md +2 -2
- data/docs/DmRoutingConfigsApi.md +912 -0
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/DomainResearchApi.md +2 -2
- data/docs/DraftDiff.md +12 -0
- data/docs/DraftUpdate.md +10 -0
- data/docs/EventsResponse.md +1 -1
- data/docs/HeaderEvent.md +14 -0
- data/docs/InitialVersion.md +12 -0
- data/docs/InitialVersionPath.md +11 -0
- data/docs/InlineResponse20010.md +2 -2
- data/docs/InlineResponse20011.md +2 -2
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +2 -2
- data/docs/InlineResponse20014.md +2 -1
- data/docs/InlineResponse20015.md +10 -0
- data/docs/InlineResponse20016.md +10 -0
- data/docs/InlineResponse20017.md +11 -0
- data/docs/InlineResponse20018.md +11 -0
- data/docs/InlineResponse20019.md +11 -0
- data/docs/InlineResponse20020.md +11 -0
- data/docs/InlineResponse20021.md +11 -0
- data/docs/InlineResponse20022.md +10 -0
- data/docs/InlineResponse2005.md +2 -2
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +2 -1
- data/docs/InlineResponse2009.md +2 -1
- data/docs/InvitationsResponse.md +1 -1
- data/docs/KvStoreApi.md +2 -2
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/KvStoreResponseBodyEnable.md +12 -0
- data/docs/KvStoreResponseCustomer.md +10 -0
- data/docs/KvStoreResponseLinks.md +10 -0
- data/docs/KvStoreResponseLinksLinks.md +10 -0
- data/docs/KvStoreResponseProduct.md +10 -0
- data/docs/KvStoreResponseProductProduct.md +11 -0
- data/docs/LoggingAzureblobApi.md +4 -4
- data/docs/LoggingAzureblobResponse.md +1 -1
- data/docs/LoggingCloudfilesApi.md +4 -4
- data/docs/LoggingCloudfilesResponse.md +1 -1
- data/docs/LoggingDigitaloceanApi.md +4 -4
- data/docs/LoggingDigitaloceanResponse.md +1 -1
- data/docs/LoggingFtpApi.md +4 -4
- data/docs/LoggingFtpResponse.md +1 -1
- data/docs/LoggingGcsApi.md +4 -4
- data/docs/LoggingGcsResponse.md +1 -1
- data/docs/LoggingGenericCommon.md +1 -1
- data/docs/LoggingGenericCommonResponse.md +1 -1
- data/docs/LoggingGenericCommonResponseAllOf.md +1 -1
- data/docs/LoggingHttpsAdditional.md +1 -1
- data/docs/LoggingHttpsApi.md +4 -4
- data/docs/LoggingHttpsResponse.md +1 -1
- data/docs/LoggingOpenstackApi.md +4 -4
- data/docs/LoggingOpenstackResponse.md +1 -1
- data/docs/LoggingS3Api.md +4 -4
- data/docs/LoggingS3Response.md +1 -1
- data/docs/LoggingSftpApi.md +4 -4
- data/docs/LoggingSftpResponse.md +1 -1
- data/docs/LoggingSumologicAdditional.md +1 -1
- data/docs/LoggingSumologicApi.md +4 -4
- data/docs/LoggingSumologicResponse.md +1 -1
- data/docs/LoggingSyslogAdditional.md +1 -1
- data/docs/LoggingSyslogApi.md +4 -4
- data/docs/LoggingSyslogResponse.md +1 -1
- data/docs/MutualAuthenticationsResponse.md +1 -1
- data/docs/NgwafAgentKeysApi.md +55 -0
- data/docs/NgwafSimulateApi.md +61 -0
- data/docs/Notification.md +11 -0
- data/docs/NotificationConfig.md +10 -0
- data/docs/Page.md +17 -0
- data/docs/PageCreate.md +14 -0
- data/docs/PageUpdate.md +14 -0
- data/docs/Pagination.md +1 -1
- data/docs/PaginationMeta.md +4 -4
- data/docs/PaginationMeta1.md +13 -0
- data/docs/PathChange.md +15 -0
- data/docs/PathCreate.md +10 -0
- data/docs/PathResponse.md +14 -0
- data/docs/PathResponseAllOf.md +12 -0
- data/docs/PathUpdate.md +10 -0
- data/docs/PathWithRules.md +11 -0
- data/docs/PathsResponse.md +11 -0
- data/docs/Policy.md +17 -0
- data/docs/PolicyCreate.md +13 -0
- data/docs/PolicyUpdate.md +13 -0
- data/docs/Position.md +11 -0
- data/docs/ProductBotManagementApi.md +78 -0
- data/docs/ProductKvStoreApi.md +115 -0
- data/docs/RealtimeEntry.md +1 -1
- data/docs/RealtimeEntryAggregated.md +34 -3
- data/docs/RealtimeEntryDatacenter.md +345 -0
- data/docs/RealtimeMeasurements.md +34 -3
- data/docs/Report.md +15 -0
- data/docs/RequestBodyForCreate.md +1 -0
- data/docs/RequestBodyForUpdate.md +1 -0
- data/docs/Results.md +34 -3
- data/docs/RoutingConfig.md +11 -0
- data/docs/RoutingConfigCondition.md +13 -0
- data/docs/RoutingConfigResponse.md +16 -0
- data/docs/RoutingConfigResponseAllOf.md +14 -0
- data/docs/RoutingConfigState.md +9 -0
- data/docs/RoutingConfigVersionResponse.md +13 -0
- data/docs/RoutingConfigsResponse.md +11 -0
- data/docs/RuleChange.md +12 -0
- data/docs/RuleCreate.md +12 -0
- data/docs/RuleResponse.md +15 -0
- data/docs/RuleResponseAllOf.md +13 -0
- data/docs/RuleUpdate.md +12 -0
- data/docs/RulesResponse.md +11 -0
- data/docs/Script.md +20 -0
- data/docs/ScriptUpdate.md +12 -0
- data/docs/SecretStoreApi.md +2 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/SecurityHeader.md +12 -0
- data/docs/ServiceAuthorizationsApi.md +2 -2
- data/docs/ServiceAuthorizationsResponse.md +1 -1
- data/docs/SuccessfulResponseAsObject.md +1 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +1 -0
- data/docs/TlsActivationsResponse.md +1 -1
- data/docs/TlsBulkCertificatesResponse.md +1 -1
- data/docs/TlsCertificatesResponse.md +1 -1
- data/docs/TlsConfigurationsResponse.md +1 -1
- data/docs/TlsDomainsResponse.md +1 -1
- data/docs/TlsPrivateKeysResponse.md +1 -1
- data/docs/TlsSubscriptionsResponse.md +1 -1
- data/docs/VersionsResponse.md +11 -0
- data/docs/WafSimulateRequest.md +11 -0
- data/docs/WafSimulateResponse.md +11 -0
- data/docs/WafSimulateSignal.md +16 -0
- data/docs/Website.md +14 -0
- data/docs/WebsiteCreate.md +10 -0
- data/docs/WebsiteUpdate.md +10 -0
- data/lib/fastly/api/backend_api.rb +16 -4
- data/lib/fastly/api/client_side_protection_api.rb +1465 -0
- data/lib/fastly/api/ddos_protection_api.rb +6 -6
- data/lib/fastly/api/dm_domains_api.rb +3 -3
- data/lib/fastly/api/dm_routing_configs_api.rb +1596 -0
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/domain_research_api.rb +3 -3
- 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_azureblob_api.rb +6 -6
- data/lib/fastly/api/logging_cloudfiles_api.rb +6 -6
- data/lib/fastly/api/logging_digitalocean_api.rb +6 -6
- data/lib/fastly/api/logging_ftp_api.rb +6 -6
- data/lib/fastly/api/logging_gcs_api.rb +6 -6
- data/lib/fastly/api/logging_https_api.rb +4 -4
- data/lib/fastly/api/logging_openstack_api.rb +6 -6
- data/lib/fastly/api/logging_s3_api.rb +6 -6
- data/lib/fastly/api/logging_sftp_api.rb +6 -6
- data/lib/fastly/api/logging_sumologic_api.rb +4 -4
- data/lib/fastly/api/logging_syslog_api.rb +4 -4
- data/lib/fastly/api/ngwaf_agent_keys_api.rb +83 -0
- data/lib/fastly/api/ngwaf_simulate_api.rb +95 -0
- data/lib/fastly/api/product_bot_management_api.rb +133 -0
- data/lib/fastly/api/product_kv_store_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/configuration.rb +294 -0
- data/lib/fastly/models/action.rb +237 -0
- data/lib/fastly/models/action_type.rb +34 -0
- data/lib/fastly/models/agent_key.rb +283 -0
- data/lib/fastly/models/agent_key_meta.rb +223 -0
- data/lib/fastly/models/backend.rb +24 -2
- data/lib/fastly/models/backend_response.rb +24 -2
- data/lib/fastly/models/bot_management_request_update_configuration.rb +256 -0
- data/lib/fastly/models/bot_management_response_configuration.rb +216 -0
- data/lib/fastly/models/bot_management_response_configuration_configuration.rb +217 -0
- data/lib/fastly/models/bot_management_response_configure.rb +253 -0
- data/lib/fastly/models/condition_operator.rb +37 -0
- data/lib/fastly/models/condition_type.rb +34 -0
- data/lib/fastly/models/directive.rb +229 -0
- data/lib/fastly/models/draft_diff.rb +244 -0
- data/lib/fastly/models/draft_update.rb +218 -0
- data/lib/fastly/models/events_response.rb +1 -1
- data/lib/fastly/models/header_event.rb +252 -0
- data/lib/fastly/models/initial_version.rb +242 -0
- data/lib/fastly/models/initial_version_path.rb +254 -0
- data/lib/fastly/models/inline_response20010.rb +2 -2
- data/lib/fastly/models/inline_response20011.rb +2 -2
- data/lib/fastly/models/inline_response20012.rb +1 -1
- data/lib/fastly/models/inline_response20013.rb +11 -1
- data/lib/fastly/models/inline_response20014.rb +15 -4
- data/lib/fastly/models/inline_response20015.rb +217 -0
- data/lib/fastly/models/inline_response20016.rb +218 -0
- data/lib/fastly/models/inline_response20017.rb +227 -0
- data/lib/fastly/models/inline_response20018.rb +227 -0
- data/lib/fastly/models/inline_response20019.rb +228 -0
- data/lib/fastly/models/inline_response20020.rb +227 -0
- data/lib/fastly/models/inline_response20021.rb +227 -0
- data/lib/fastly/models/inline_response20022.rb +218 -0
- data/lib/fastly/models/inline_response2005.rb +2 -2
- data/lib/fastly/models/inline_response2006.rb +2 -12
- data/lib/fastly/models/inline_response2007.rb +2 -4
- data/lib/fastly/models/inline_response2008.rb +18 -8
- data/lib/fastly/models/inline_response2009.rb +17 -8
- data/lib/fastly/models/invitations_response.rb +1 -1
- data/lib/fastly/models/kv_store_response_body_enable.rb +243 -0
- data/lib/fastly/models/kv_store_response_customer.rb +216 -0
- data/lib/fastly/models/kv_store_response_links.rb +216 -0
- data/lib/fastly/models/kv_store_response_links_links.rb +217 -0
- data/lib/fastly/models/kv_store_response_product.rb +216 -0
- data/lib/fastly/models/kv_store_response_product_product.rb +227 -0
- data/lib/fastly/models/logging_azureblob_response.rb +3 -3
- data/lib/fastly/models/logging_cloudfiles_response.rb +3 -3
- data/lib/fastly/models/logging_digitalocean_response.rb +3 -3
- data/lib/fastly/models/logging_ftp_response.rb +3 -3
- data/lib/fastly/models/logging_gcs_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response_all_of.rb +3 -3
- data/lib/fastly/models/logging_https_additional.rb +1 -1
- data/lib/fastly/models/logging_https_response.rb +1 -1
- data/lib/fastly/models/logging_message_type.rb +1 -1
- data/lib/fastly/models/logging_openstack_response.rb +3 -3
- data/lib/fastly/models/logging_s3_response.rb +3 -3
- data/lib/fastly/models/logging_sftp_response.rb +3 -3
- data/lib/fastly/models/logging_sumologic_additional.rb +1 -1
- data/lib/fastly/models/logging_sumologic_response.rb +1 -1
- data/lib/fastly/models/logging_syslog_additional.rb +1 -1
- data/lib/fastly/models/logging_syslog_response.rb +1 -1
- data/lib/fastly/models/mutual_authentications_response.rb +1 -1
- data/lib/fastly/models/notification.rb +270 -0
- data/lib/fastly/models/notification_config.rb +218 -0
- data/lib/fastly/models/page.rb +289 -0
- data/lib/fastly/models/page_create.rb +266 -0
- data/lib/fastly/models/page_update.rb +256 -0
- data/lib/fastly/models/pagination.rb +1 -1
- data/lib/fastly/models/pagination_meta.rb +30 -55
- data/lib/fastly/models/pagination_meta1.rb +273 -0
- data/lib/fastly/models/path_change.rb +274 -0
- data/lib/fastly/models/path_create.rb +242 -0
- data/lib/fastly/models/path_response.rb +285 -0
- data/lib/fastly/models/path_response_all_of.rb +254 -0
- data/lib/fastly/models/path_update.rb +233 -0
- data/lib/fastly/models/path_with_rules.rb +228 -0
- data/lib/fastly/models/paths_response.rb +228 -0
- data/lib/fastly/models/policy.rb +315 -0
- data/lib/fastly/models/policy_create.rb +289 -0
- data/lib/fastly/models/policy_update.rb +279 -0
- data/lib/fastly/models/position.rb +228 -0
- data/lib/fastly/models/realtime_entry.rb +2 -5
- data/lib/fastly/models/realtime_entry_aggregated.rb +344 -34
- data/lib/fastly/models/realtime_entry_datacenter.rb +3577 -0
- data/lib/fastly/models/realtime_measurements.rb +344 -34
- data/lib/fastly/models/report.rb +261 -0
- data/lib/fastly/models/request_body_for_create.rb +12 -1
- data/lib/fastly/models/request_body_for_update.rb +12 -1
- data/lib/fastly/models/results.rb +341 -31
- data/lib/fastly/models/routing_config.rb +251 -0
- data/lib/fastly/models/routing_config_condition.rb +261 -0
- data/lib/fastly/models/routing_config_response.rb +305 -0
- data/lib/fastly/models/routing_config_response_all_of.rb +274 -0
- data/lib/fastly/models/routing_config_state.rb +36 -0
- data/lib/fastly/models/routing_config_version_response.rb +250 -0
- data/lib/fastly/models/routing_configs_response.rb +228 -0
- data/lib/fastly/models/rule_change.rb +236 -0
- data/lib/fastly/models/rule_create.rb +267 -0
- data/lib/fastly/models/rule_response.rb +279 -0
- data/lib/fastly/models/rule_response_all_of.rb +248 -0
- data/lib/fastly/models/rule_update.rb +252 -0
- data/lib/fastly/models/rules_response.rb +228 -0
- data/lib/fastly/models/script.rb +350 -0
- data/lib/fastly/models/script_update.rb +271 -0
- data/lib/fastly/models/security_header.rb +234 -0
- data/lib/fastly/models/service_authorizations_response.rb +1 -1
- data/lib/fastly/models/successful_response_as_object.rb +12 -1
- data/lib/fastly/models/successful_response_as_object_all_of.rb +12 -1
- data/lib/fastly/models/tls_activations_response.rb +1 -1
- data/lib/fastly/models/tls_bulk_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_configurations_response.rb +1 -1
- data/lib/fastly/models/tls_domains_response.rb +1 -1
- data/lib/fastly/models/tls_private_keys_response.rb +1 -1
- data/lib/fastly/models/tls_subscriptions_response.rb +1 -1
- data/lib/fastly/models/versions_response.rb +228 -0
- data/lib/fastly/models/waf_simulate_request.rb +233 -0
- data/lib/fastly/models/waf_simulate_response.rb +240 -0
- data/lib/fastly/models/waf_simulate_signal.rb +344 -0
- data/lib/fastly/models/website.rb +257 -0
- data/lib/fastly/models/website_create.rb +222 -0
- data/lib/fastly/models/website_update.rb +217 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +77 -0
- data/sig.json +1 -1
- metadata +156 -2
|
@@ -0,0 +1,912 @@
|
|
|
1
|
+
# Fastly::DmRoutingConfigsApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::DmRoutingConfigsApi.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
|
+
[**activate_dm_routing_config_draft**](DmRoutingConfigsApi.md#activate_dm_routing_config_draft) | **POST** /domain-management/v1/routing-configs/{config_id}/activate | Activate the draft
|
|
17
|
+
[**create_dm_routing_config**](DmRoutingConfigsApi.md#create_dm_routing_config) | **POST** /domain-management/v1/routing-configs | Create a routing config
|
|
18
|
+
[**create_dm_routing_config_path**](DmRoutingConfigsApi.md#create_dm_routing_config_path) | **POST** /domain-management/v1/routing-configs/{config_id}/paths | Create a path
|
|
19
|
+
[**create_dm_routing_config_rule**](DmRoutingConfigsApi.md#create_dm_routing_config_rule) | **POST** /domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules | Create a rule
|
|
20
|
+
[**deactivate_dm_routing_config**](DmRoutingConfigsApi.md#deactivate_dm_routing_config) | **POST** /domain-management/v1/routing-configs/{config_id}/deactivate | Deactivate a routing config
|
|
21
|
+
[**delete_dm_routing_config**](DmRoutingConfigsApi.md#delete_dm_routing_config) | **DELETE** /domain-management/v1/routing-configs/{config_id} | Delete a routing config
|
|
22
|
+
[**delete_dm_routing_config_inactive_versions**](DmRoutingConfigsApi.md#delete_dm_routing_config_inactive_versions) | **DELETE** /domain-management/v1/routing-configs/{config_id}/versions/inactive | Delete inactive versions
|
|
23
|
+
[**delete_dm_routing_config_path**](DmRoutingConfigsApi.md#delete_dm_routing_config_path) | **DELETE** /domain-management/v1/routing-configs/{config_id}/paths/{path_id} | Delete a path
|
|
24
|
+
[**delete_dm_routing_config_rule**](DmRoutingConfigsApi.md#delete_dm_routing_config_rule) | **DELETE** /domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id} | Delete a rule
|
|
25
|
+
[**discard_dm_routing_config_draft**](DmRoutingConfigsApi.md#discard_dm_routing_config_draft) | **DELETE** /domain-management/v1/routing-configs/{config_id}/draft | Discard the draft
|
|
26
|
+
[**get_dm_routing_config**](DmRoutingConfigsApi.md#get_dm_routing_config) | **GET** /domain-management/v1/routing-configs/{config_id} | Get a routing config
|
|
27
|
+
[**get_dm_routing_config_draft_diff**](DmRoutingConfigsApi.md#get_dm_routing_config_draft_diff) | **GET** /domain-management/v1/routing-configs/{config_id}/draft/diff | Get the draft diff
|
|
28
|
+
[**get_dm_routing_config_path**](DmRoutingConfigsApi.md#get_dm_routing_config_path) | **GET** /domain-management/v1/routing-configs/{config_id}/paths/{path_id} | Get a path
|
|
29
|
+
[**get_dm_routing_config_rule**](DmRoutingConfigsApi.md#get_dm_routing_config_rule) | **GET** /domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id} | Get a rule
|
|
30
|
+
[**list_dm_routing_config_paths**](DmRoutingConfigsApi.md#list_dm_routing_config_paths) | **GET** /domain-management/v1/routing-configs/{config_id}/paths | List paths
|
|
31
|
+
[**list_dm_routing_config_rules**](DmRoutingConfigsApi.md#list_dm_routing_config_rules) | **GET** /domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules | List rules
|
|
32
|
+
[**list_dm_routing_config_versions**](DmRoutingConfigsApi.md#list_dm_routing_config_versions) | **GET** /domain-management/v1/routing-configs/{config_id}/versions | List versions
|
|
33
|
+
[**list_dm_routing_configs**](DmRoutingConfigsApi.md#list_dm_routing_configs) | **GET** /domain-management/v1/routing-configs | List routing configs
|
|
34
|
+
[**reactivate_dm_routing_config_version**](DmRoutingConfigsApi.md#reactivate_dm_routing_config_version) | **POST** /domain-management/v1/routing-configs/{config_id}/versions/{version_id}/activate | Reactivate a version
|
|
35
|
+
[**update_dm_routing_config_draft**](DmRoutingConfigsApi.md#update_dm_routing_config_draft) | **PATCH** /domain-management/v1/routing-configs/{config_id}/draft | Update the draft
|
|
36
|
+
[**update_dm_routing_config_path**](DmRoutingConfigsApi.md#update_dm_routing_config_path) | **PATCH** /domain-management/v1/routing-configs/{config_id}/paths/{path_id} | Update a path
|
|
37
|
+
[**update_dm_routing_config_rule**](DmRoutingConfigsApi.md#update_dm_routing_config_rule) | **PATCH** /domain-management/v1/routing-configs/{config_id}/paths/{path_id}/rules/{rule_id} | Update a rule
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## `activate_dm_routing_config_draft()`
|
|
41
|
+
|
|
42
|
+
```ruby
|
|
43
|
+
activate_dm_routing_config_draft(opts): <RoutingConfigVersionResponse> # Activate the draft
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Activate the current draft version. The previously active version, if any, becomes inactive but is retained in version history.
|
|
47
|
+
|
|
48
|
+
### Examples
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
52
|
+
opts = {
|
|
53
|
+
config_id: 'config_id_example', # String |
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
begin
|
|
57
|
+
# Activate the draft
|
|
58
|
+
result = api_instance.activate_dm_routing_config_draft(opts)
|
|
59
|
+
p result
|
|
60
|
+
rescue Fastly::ApiError => e
|
|
61
|
+
puts "Error when calling DmRoutingConfigsApi->activate_dm_routing_config_draft: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Options
|
|
66
|
+
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
|
69
|
+
| **config_id** | **String** | | |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**RoutingConfigVersionResponse**](RoutingConfigVersionResponse.md)
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
76
|
+
[[Back to README]](../../README.md)
|
|
77
|
+
## `create_dm_routing_config()`
|
|
78
|
+
|
|
79
|
+
```ruby
|
|
80
|
+
create_dm_routing_config(opts): <RoutingConfigResponse> # Create a routing config
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Create a new routing config. An optional `initial_version` may be provided to seed the config with paths and rules in a single request, and may also be activated immediately.
|
|
84
|
+
|
|
85
|
+
### Examples
|
|
86
|
+
|
|
87
|
+
```ruby
|
|
88
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
89
|
+
opts = {
|
|
90
|
+
routing_config: Fastly::RoutingConfig.new({name: 'name_example'}), # RoutingConfig |
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
begin
|
|
94
|
+
# Create a routing config
|
|
95
|
+
result = api_instance.create_dm_routing_config(opts)
|
|
96
|
+
p result
|
|
97
|
+
rescue Fastly::ApiError => e
|
|
98
|
+
puts "Error when calling DmRoutingConfigsApi->create_dm_routing_config: #{e}"
|
|
99
|
+
end
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Options
|
|
103
|
+
|
|
104
|
+
| Name | Type | Description | Notes |
|
|
105
|
+
| ---- | ---- | ----------- | ----- |
|
|
106
|
+
| **routing_config** | [**RoutingConfig**](RoutingConfig.md) | | [optional] |
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**RoutingConfigResponse**](RoutingConfigResponse.md)
|
|
111
|
+
|
|
112
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
113
|
+
[[Back to README]](../../README.md)
|
|
114
|
+
## `create_dm_routing_config_path()`
|
|
115
|
+
|
|
116
|
+
```ruby
|
|
117
|
+
create_dm_routing_config_path(opts): <PathResponse> # Create a path
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Add a new path to the config's draft version. If no draft exists, one is created automatically by cloning the active version.
|
|
121
|
+
|
|
122
|
+
### Examples
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
126
|
+
opts = {
|
|
127
|
+
config_id: 'config_id_example', # String |
|
|
128
|
+
path_create: Fastly::PathCreate.new({path: 'path_example'}), # PathCreate |
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
begin
|
|
132
|
+
# Create a path
|
|
133
|
+
result = api_instance.create_dm_routing_config_path(opts)
|
|
134
|
+
p result
|
|
135
|
+
rescue Fastly::ApiError => e
|
|
136
|
+
puts "Error when calling DmRoutingConfigsApi->create_dm_routing_config_path: #{e}"
|
|
137
|
+
end
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Options
|
|
141
|
+
|
|
142
|
+
| Name | Type | Description | Notes |
|
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
|
144
|
+
| **config_id** | **String** | | |
|
|
145
|
+
| **path_create** | [**PathCreate**](PathCreate.md) | | [optional] |
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
[**PathResponse**](PathResponse.md)
|
|
150
|
+
|
|
151
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
152
|
+
[[Back to README]](../../README.md)
|
|
153
|
+
## `create_dm_routing_config_rule()`
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
create_dm_routing_config_rule(opts): <RuleResponse> # Create a rule
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Add a new rule to a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version. A rule with an empty `conditions` array is a default (catch-all) rule and there can be at most one default rule per path.
|
|
160
|
+
|
|
161
|
+
### Examples
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
165
|
+
opts = {
|
|
166
|
+
config_id: 'config_id_example', # String |
|
|
167
|
+
path_id: 'path_id_example', # String |
|
|
168
|
+
rule_create: Fastly::RuleCreate.new({action: Fastly::Action.new({type: Fastly::ActionType::action_type_service, value: 'value_example'}), conditions: [Fastly::RoutingConfigCondition.new({type: Fastly::ConditionType::condition_type_header, operator: Fastly::ConditionOperator::condition_operator_equals, value: 'value_example'})]}), # RuleCreate |
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
begin
|
|
172
|
+
# Create a rule
|
|
173
|
+
result = api_instance.create_dm_routing_config_rule(opts)
|
|
174
|
+
p result
|
|
175
|
+
rescue Fastly::ApiError => e
|
|
176
|
+
puts "Error when calling DmRoutingConfigsApi->create_dm_routing_config_rule: #{e}"
|
|
177
|
+
end
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Options
|
|
181
|
+
|
|
182
|
+
| Name | Type | Description | Notes |
|
|
183
|
+
| ---- | ---- | ----------- | ----- |
|
|
184
|
+
| **config_id** | **String** | | |
|
|
185
|
+
| **path_id** | **String** | | |
|
|
186
|
+
| **rule_create** | [**RuleCreate**](RuleCreate.md) | | [optional] |
|
|
187
|
+
|
|
188
|
+
### Return type
|
|
189
|
+
|
|
190
|
+
[**RuleResponse**](RuleResponse.md)
|
|
191
|
+
|
|
192
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
193
|
+
[[Back to README]](../../README.md)
|
|
194
|
+
## `deactivate_dm_routing_config()`
|
|
195
|
+
|
|
196
|
+
```ruby
|
|
197
|
+
deactivate_dm_routing_config(opts): <RoutingConfigResponse> # Deactivate a routing config
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Clear the active version designation. This is a bookkeeping operation only — it does not stop edge traffic. Minerva continues serving the last-activated version until the domain association is removed in Spotless. Only removing the routing config from the domain (via Spotless) triggers Neptune to drop the reference, which causes Minerva to stop fetching and eventually clean up the cached config. Idempotent: returns 200 even if already deactivated.
|
|
201
|
+
|
|
202
|
+
### Examples
|
|
203
|
+
|
|
204
|
+
```ruby
|
|
205
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
206
|
+
opts = {
|
|
207
|
+
config_id: 'config_id_example', # String |
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
begin
|
|
211
|
+
# Deactivate a routing config
|
|
212
|
+
result = api_instance.deactivate_dm_routing_config(opts)
|
|
213
|
+
p result
|
|
214
|
+
rescue Fastly::ApiError => e
|
|
215
|
+
puts "Error when calling DmRoutingConfigsApi->deactivate_dm_routing_config: #{e}"
|
|
216
|
+
end
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Options
|
|
220
|
+
|
|
221
|
+
| Name | Type | Description | Notes |
|
|
222
|
+
| ---- | ---- | ----------- | ----- |
|
|
223
|
+
| **config_id** | **String** | | |
|
|
224
|
+
|
|
225
|
+
### Return type
|
|
226
|
+
|
|
227
|
+
[**RoutingConfigResponse**](RoutingConfigResponse.md)
|
|
228
|
+
|
|
229
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
230
|
+
[[Back to README]](../../README.md)
|
|
231
|
+
## `delete_dm_routing_config()`
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
delete_dm_routing_config(opts) # Delete a routing config
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Delete a routing config. By default, configs that have an active version cannot be deleted. Pass `force=true` to bypass the active-version check — this is destructive and will immediately stop traffic routing for any paths the config serves. The `force` parameter does **not** bypass the domain-association check; if domains are still associated, deletion is rejected with 409 regardless of `force`.
|
|
238
|
+
|
|
239
|
+
### Examples
|
|
240
|
+
|
|
241
|
+
```ruby
|
|
242
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
243
|
+
opts = {
|
|
244
|
+
config_id: 'config_id_example', # String |
|
|
245
|
+
force: true, # Boolean | When `true`, allows deleting a routing config that has an active version. This is destructive — traffic routing for any paths served by the config will stop immediately.
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
begin
|
|
249
|
+
# Delete a routing config
|
|
250
|
+
api_instance.delete_dm_routing_config(opts)
|
|
251
|
+
rescue Fastly::ApiError => e
|
|
252
|
+
puts "Error when calling DmRoutingConfigsApi->delete_dm_routing_config: #{e}"
|
|
253
|
+
end
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Options
|
|
257
|
+
|
|
258
|
+
| Name | Type | Description | Notes |
|
|
259
|
+
| ---- | ---- | ----------- | ----- |
|
|
260
|
+
| **config_id** | **String** | | |
|
|
261
|
+
| **force** | **Boolean** | When `true`, allows deleting a routing config that has an active version. This is destructive — traffic routing for any paths served by the config will stop immediately. | [optional][default to false] |
|
|
262
|
+
|
|
263
|
+
### Return type
|
|
264
|
+
|
|
265
|
+
nil (empty response body)
|
|
266
|
+
|
|
267
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
268
|
+
[[Back to README]](../../README.md)
|
|
269
|
+
## `delete_dm_routing_config_inactive_versions()`
|
|
270
|
+
|
|
271
|
+
```ruby
|
|
272
|
+
delete_dm_routing_config_inactive_versions(opts) # Delete inactive versions
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
Delete all inactive versions for a routing config. The currently active version, if any, is retained.
|
|
276
|
+
|
|
277
|
+
### Examples
|
|
278
|
+
|
|
279
|
+
```ruby
|
|
280
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
281
|
+
opts = {
|
|
282
|
+
config_id: 'config_id_example', # String |
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
begin
|
|
286
|
+
# Delete inactive versions
|
|
287
|
+
api_instance.delete_dm_routing_config_inactive_versions(opts)
|
|
288
|
+
rescue Fastly::ApiError => e
|
|
289
|
+
puts "Error when calling DmRoutingConfigsApi->delete_dm_routing_config_inactive_versions: #{e}"
|
|
290
|
+
end
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### Options
|
|
294
|
+
|
|
295
|
+
| Name | Type | Description | Notes |
|
|
296
|
+
| ---- | ---- | ----------- | ----- |
|
|
297
|
+
| **config_id** | **String** | | |
|
|
298
|
+
|
|
299
|
+
### Return type
|
|
300
|
+
|
|
301
|
+
nil (empty response body)
|
|
302
|
+
|
|
303
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
304
|
+
[[Back to README]](../../README.md)
|
|
305
|
+
## `delete_dm_routing_config_path()`
|
|
306
|
+
|
|
307
|
+
```ruby
|
|
308
|
+
delete_dm_routing_config_path(opts) # Delete a path
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
Delete a path from the config's draft version. If no draft exists, one is created automatically by cloning the active version.
|
|
312
|
+
|
|
313
|
+
### Examples
|
|
314
|
+
|
|
315
|
+
```ruby
|
|
316
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
317
|
+
opts = {
|
|
318
|
+
config_id: 'config_id_example', # String |
|
|
319
|
+
path_id: 'path_id_example', # String |
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
begin
|
|
323
|
+
# Delete a path
|
|
324
|
+
api_instance.delete_dm_routing_config_path(opts)
|
|
325
|
+
rescue Fastly::ApiError => e
|
|
326
|
+
puts "Error when calling DmRoutingConfigsApi->delete_dm_routing_config_path: #{e}"
|
|
327
|
+
end
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Options
|
|
331
|
+
|
|
332
|
+
| Name | Type | Description | Notes |
|
|
333
|
+
| ---- | ---- | ----------- | ----- |
|
|
334
|
+
| **config_id** | **String** | | |
|
|
335
|
+
| **path_id** | **String** | | |
|
|
336
|
+
|
|
337
|
+
### Return type
|
|
338
|
+
|
|
339
|
+
nil (empty response body)
|
|
340
|
+
|
|
341
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
342
|
+
[[Back to README]](../../README.md)
|
|
343
|
+
## `delete_dm_routing_config_rule()`
|
|
344
|
+
|
|
345
|
+
```ruby
|
|
346
|
+
delete_dm_routing_config_rule(opts) # Delete a rule
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
Delete a rule from the config's draft version. If no draft exists, one is created automatically by cloning the active version.
|
|
350
|
+
|
|
351
|
+
### Examples
|
|
352
|
+
|
|
353
|
+
```ruby
|
|
354
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
355
|
+
opts = {
|
|
356
|
+
config_id: 'config_id_example', # String |
|
|
357
|
+
path_id: 'path_id_example', # String |
|
|
358
|
+
rule_id: 'rule_id_example', # String |
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
begin
|
|
362
|
+
# Delete a rule
|
|
363
|
+
api_instance.delete_dm_routing_config_rule(opts)
|
|
364
|
+
rescue Fastly::ApiError => e
|
|
365
|
+
puts "Error when calling DmRoutingConfigsApi->delete_dm_routing_config_rule: #{e}"
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Options
|
|
370
|
+
|
|
371
|
+
| Name | Type | Description | Notes |
|
|
372
|
+
| ---- | ---- | ----------- | ----- |
|
|
373
|
+
| **config_id** | **String** | | |
|
|
374
|
+
| **path_id** | **String** | | |
|
|
375
|
+
| **rule_id** | **String** | | |
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
nil (empty response body)
|
|
380
|
+
|
|
381
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
382
|
+
[[Back to README]](../../README.md)
|
|
383
|
+
## `discard_dm_routing_config_draft()`
|
|
384
|
+
|
|
385
|
+
```ruby
|
|
386
|
+
discard_dm_routing_config_draft(opts) # Discard the draft
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
Delete the current draft version, reverting any unactivated changes.
|
|
390
|
+
|
|
391
|
+
### Examples
|
|
392
|
+
|
|
393
|
+
```ruby
|
|
394
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
395
|
+
opts = {
|
|
396
|
+
config_id: 'config_id_example', # String |
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
begin
|
|
400
|
+
# Discard the draft
|
|
401
|
+
api_instance.discard_dm_routing_config_draft(opts)
|
|
402
|
+
rescue Fastly::ApiError => e
|
|
403
|
+
puts "Error when calling DmRoutingConfigsApi->discard_dm_routing_config_draft: #{e}"
|
|
404
|
+
end
|
|
405
|
+
```
|
|
406
|
+
|
|
407
|
+
### Options
|
|
408
|
+
|
|
409
|
+
| Name | Type | Description | Notes |
|
|
410
|
+
| ---- | ---- | ----------- | ----- |
|
|
411
|
+
| **config_id** | **String** | | |
|
|
412
|
+
|
|
413
|
+
### Return type
|
|
414
|
+
|
|
415
|
+
nil (empty response body)
|
|
416
|
+
|
|
417
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
418
|
+
[[Back to README]](../../README.md)
|
|
419
|
+
## `get_dm_routing_config()`
|
|
420
|
+
|
|
421
|
+
```ruby
|
|
422
|
+
get_dm_routing_config(opts): <RoutingConfigResponse> # Get a routing config
|
|
423
|
+
```
|
|
424
|
+
|
|
425
|
+
Retrieve a single routing config by its identifier.
|
|
426
|
+
|
|
427
|
+
### Examples
|
|
428
|
+
|
|
429
|
+
```ruby
|
|
430
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
431
|
+
opts = {
|
|
432
|
+
config_id: 'config_id_example', # String |
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
begin
|
|
436
|
+
# Get a routing config
|
|
437
|
+
result = api_instance.get_dm_routing_config(opts)
|
|
438
|
+
p result
|
|
439
|
+
rescue Fastly::ApiError => e
|
|
440
|
+
puts "Error when calling DmRoutingConfigsApi->get_dm_routing_config: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Options
|
|
445
|
+
|
|
446
|
+
| Name | Type | Description | Notes |
|
|
447
|
+
| ---- | ---- | ----------- | ----- |
|
|
448
|
+
| **config_id** | **String** | | |
|
|
449
|
+
|
|
450
|
+
### Return type
|
|
451
|
+
|
|
452
|
+
[**RoutingConfigResponse**](RoutingConfigResponse.md)
|
|
453
|
+
|
|
454
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
455
|
+
[[Back to README]](../../README.md)
|
|
456
|
+
## `get_dm_routing_config_draft_diff()`
|
|
457
|
+
|
|
458
|
+
```ruby
|
|
459
|
+
get_dm_routing_config_draft_diff(opts): <DraftDiff> # Get the draft diff
|
|
460
|
+
```
|
|
461
|
+
|
|
462
|
+
Compare the current draft version against the active version and return the paths and rules that have been added, modified, or deleted.
|
|
463
|
+
|
|
464
|
+
### Examples
|
|
465
|
+
|
|
466
|
+
```ruby
|
|
467
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
468
|
+
opts = {
|
|
469
|
+
config_id: 'config_id_example', # String |
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
begin
|
|
473
|
+
# Get the draft diff
|
|
474
|
+
result = api_instance.get_dm_routing_config_draft_diff(opts)
|
|
475
|
+
p result
|
|
476
|
+
rescue Fastly::ApiError => e
|
|
477
|
+
puts "Error when calling DmRoutingConfigsApi->get_dm_routing_config_draft_diff: #{e}"
|
|
478
|
+
end
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Options
|
|
482
|
+
|
|
483
|
+
| Name | Type | Description | Notes |
|
|
484
|
+
| ---- | ---- | ----------- | ----- |
|
|
485
|
+
| **config_id** | **String** | | |
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
[**DraftDiff**](DraftDiff.md)
|
|
490
|
+
|
|
491
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
492
|
+
[[Back to README]](../../README.md)
|
|
493
|
+
## `get_dm_routing_config_path()`
|
|
494
|
+
|
|
495
|
+
```ruby
|
|
496
|
+
get_dm_routing_config_path(opts): <PathResponse> # Get a path
|
|
497
|
+
```
|
|
498
|
+
|
|
499
|
+
Retrieve a single path by its stable identifier.
|
|
500
|
+
|
|
501
|
+
### Examples
|
|
502
|
+
|
|
503
|
+
```ruby
|
|
504
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
505
|
+
opts = {
|
|
506
|
+
config_id: 'config_id_example', # String |
|
|
507
|
+
path_id: 'path_id_example', # String |
|
|
508
|
+
}
|
|
509
|
+
|
|
510
|
+
begin
|
|
511
|
+
# Get a path
|
|
512
|
+
result = api_instance.get_dm_routing_config_path(opts)
|
|
513
|
+
p result
|
|
514
|
+
rescue Fastly::ApiError => e
|
|
515
|
+
puts "Error when calling DmRoutingConfigsApi->get_dm_routing_config_path: #{e}"
|
|
516
|
+
end
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
### Options
|
|
520
|
+
|
|
521
|
+
| Name | Type | Description | Notes |
|
|
522
|
+
| ---- | ---- | ----------- | ----- |
|
|
523
|
+
| **config_id** | **String** | | |
|
|
524
|
+
| **path_id** | **String** | | |
|
|
525
|
+
|
|
526
|
+
### Return type
|
|
527
|
+
|
|
528
|
+
[**PathResponse**](PathResponse.md)
|
|
529
|
+
|
|
530
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
531
|
+
[[Back to README]](../../README.md)
|
|
532
|
+
## `get_dm_routing_config_rule()`
|
|
533
|
+
|
|
534
|
+
```ruby
|
|
535
|
+
get_dm_routing_config_rule(opts): <RuleResponse> # Get a rule
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
Retrieve a single rule by its stable identifier.
|
|
539
|
+
|
|
540
|
+
### Examples
|
|
541
|
+
|
|
542
|
+
```ruby
|
|
543
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
544
|
+
opts = {
|
|
545
|
+
config_id: 'config_id_example', # String |
|
|
546
|
+
path_id: 'path_id_example', # String |
|
|
547
|
+
rule_id: 'rule_id_example', # String |
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
begin
|
|
551
|
+
# Get a rule
|
|
552
|
+
result = api_instance.get_dm_routing_config_rule(opts)
|
|
553
|
+
p result
|
|
554
|
+
rescue Fastly::ApiError => e
|
|
555
|
+
puts "Error when calling DmRoutingConfigsApi->get_dm_routing_config_rule: #{e}"
|
|
556
|
+
end
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### Options
|
|
560
|
+
|
|
561
|
+
| Name | Type | Description | Notes |
|
|
562
|
+
| ---- | ---- | ----------- | ----- |
|
|
563
|
+
| **config_id** | **String** | | |
|
|
564
|
+
| **path_id** | **String** | | |
|
|
565
|
+
| **rule_id** | **String** | | |
|
|
566
|
+
|
|
567
|
+
### Return type
|
|
568
|
+
|
|
569
|
+
[**RuleResponse**](RuleResponse.md)
|
|
570
|
+
|
|
571
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
572
|
+
[[Back to README]](../../README.md)
|
|
573
|
+
## `list_dm_routing_config_paths()`
|
|
574
|
+
|
|
575
|
+
```ruby
|
|
576
|
+
list_dm_routing_config_paths(opts): <PathsResponse> # List paths
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
List paths for the config. Returns paths from the active version if one exists, otherwise from the draft.
|
|
580
|
+
|
|
581
|
+
### Examples
|
|
582
|
+
|
|
583
|
+
```ruby
|
|
584
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
585
|
+
opts = {
|
|
586
|
+
config_id: 'config_id_example', # String |
|
|
587
|
+
path: 'path_example', # String | Filter results by path pattern. The match strategy is controlled by the `match` parameter.
|
|
588
|
+
match: 'exact', # String | How to match the value of the `path` filter against existing path patterns. Has no effect unless `path` is also provided.
|
|
589
|
+
sort: 'created_at', # String | The order in which to list the results.
|
|
590
|
+
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.
|
|
591
|
+
limit: 56, # Integer | Limit how many results are returned.
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
begin
|
|
595
|
+
# List paths
|
|
596
|
+
result = api_instance.list_dm_routing_config_paths(opts)
|
|
597
|
+
p result
|
|
598
|
+
rescue Fastly::ApiError => e
|
|
599
|
+
puts "Error when calling DmRoutingConfigsApi->list_dm_routing_config_paths: #{e}"
|
|
600
|
+
end
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
### Options
|
|
604
|
+
|
|
605
|
+
| Name | Type | Description | Notes |
|
|
606
|
+
| ---- | ---- | ----------- | ----- |
|
|
607
|
+
| **config_id** | **String** | | |
|
|
608
|
+
| **path** | **String** | Filter results by path pattern. The match strategy is controlled by the `match` parameter. | [optional] |
|
|
609
|
+
| **match** | **String** | How to match the value of the `path` filter against existing path patterns. Has no effect unless `path` is also provided. | [optional][default to 'exact'] |
|
|
610
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to '-created_at'] |
|
|
611
|
+
| **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] |
|
|
612
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
613
|
+
|
|
614
|
+
### Return type
|
|
615
|
+
|
|
616
|
+
[**PathsResponse**](PathsResponse.md)
|
|
617
|
+
|
|
618
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
619
|
+
[[Back to README]](../../README.md)
|
|
620
|
+
## `list_dm_routing_config_rules()`
|
|
621
|
+
|
|
622
|
+
```ruby
|
|
623
|
+
list_dm_routing_config_rules(opts): <RulesResponse> # List rules
|
|
624
|
+
```
|
|
625
|
+
|
|
626
|
+
List all rules for a path in evaluation order.
|
|
627
|
+
|
|
628
|
+
### Examples
|
|
629
|
+
|
|
630
|
+
```ruby
|
|
631
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
632
|
+
opts = {
|
|
633
|
+
config_id: 'config_id_example', # String |
|
|
634
|
+
path_id: 'path_id_example', # String |
|
|
635
|
+
sort: 'created_at', # String | The order in which to list the results.
|
|
636
|
+
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.
|
|
637
|
+
limit: 56, # Integer | Limit how many results are returned.
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
begin
|
|
641
|
+
# List rules
|
|
642
|
+
result = api_instance.list_dm_routing_config_rules(opts)
|
|
643
|
+
p result
|
|
644
|
+
rescue Fastly::ApiError => e
|
|
645
|
+
puts "Error when calling DmRoutingConfigsApi->list_dm_routing_config_rules: #{e}"
|
|
646
|
+
end
|
|
647
|
+
```
|
|
648
|
+
|
|
649
|
+
### Options
|
|
650
|
+
|
|
651
|
+
| Name | Type | Description | Notes |
|
|
652
|
+
| ---- | ---- | ----------- | ----- |
|
|
653
|
+
| **config_id** | **String** | | |
|
|
654
|
+
| **path_id** | **String** | | |
|
|
655
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to 'position'] |
|
|
656
|
+
| **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] |
|
|
657
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
658
|
+
|
|
659
|
+
### Return type
|
|
660
|
+
|
|
661
|
+
[**RulesResponse**](RulesResponse.md)
|
|
662
|
+
|
|
663
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
664
|
+
[[Back to README]](../../README.md)
|
|
665
|
+
## `list_dm_routing_config_versions()`
|
|
666
|
+
|
|
667
|
+
```ruby
|
|
668
|
+
list_dm_routing_config_versions(opts): <VersionsResponse> # List versions
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
List all versions for a routing config.
|
|
672
|
+
|
|
673
|
+
### Examples
|
|
674
|
+
|
|
675
|
+
```ruby
|
|
676
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
677
|
+
opts = {
|
|
678
|
+
config_id: 'config_id_example', # String |
|
|
679
|
+
sort: 'activated_at', # String | The order in which to list the results.
|
|
680
|
+
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.
|
|
681
|
+
limit: 56, # Integer | Limit how many results are returned.
|
|
682
|
+
}
|
|
683
|
+
|
|
684
|
+
begin
|
|
685
|
+
# List versions
|
|
686
|
+
result = api_instance.list_dm_routing_config_versions(opts)
|
|
687
|
+
p result
|
|
688
|
+
rescue Fastly::ApiError => e
|
|
689
|
+
puts "Error when calling DmRoutingConfigsApi->list_dm_routing_config_versions: #{e}"
|
|
690
|
+
end
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
### Options
|
|
694
|
+
|
|
695
|
+
| Name | Type | Description | Notes |
|
|
696
|
+
| ---- | ---- | ----------- | ----- |
|
|
697
|
+
| **config_id** | **String** | | |
|
|
698
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to '-activated_at'] |
|
|
699
|
+
| **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] |
|
|
700
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
701
|
+
|
|
702
|
+
### Return type
|
|
703
|
+
|
|
704
|
+
[**VersionsResponse**](VersionsResponse.md)
|
|
705
|
+
|
|
706
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
707
|
+
[[Back to README]](../../README.md)
|
|
708
|
+
## `list_dm_routing_configs()`
|
|
709
|
+
|
|
710
|
+
```ruby
|
|
711
|
+
list_dm_routing_configs(opts): <RoutingConfigsResponse> # List routing configs
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
List all routing configs for the authenticated customer.
|
|
715
|
+
|
|
716
|
+
### Examples
|
|
717
|
+
|
|
718
|
+
```ruby
|
|
719
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
720
|
+
opts = {
|
|
721
|
+
state: ['draft-only'], # Array<String> | Filter configs by lifecycle state. Accepts a comma-separated list of state values (e.g. `?state=active,active-with-draft`). Returns only configs whose current state matches one of the provided values. Returns 400 if any value is not a recognised state.
|
|
722
|
+
sort: 'created_at', # String | The order in which to list the results.
|
|
723
|
+
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.
|
|
724
|
+
limit: 56, # Integer | Limit how many results are returned.
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
begin
|
|
728
|
+
# List routing configs
|
|
729
|
+
result = api_instance.list_dm_routing_configs(opts)
|
|
730
|
+
p result
|
|
731
|
+
rescue Fastly::ApiError => e
|
|
732
|
+
puts "Error when calling DmRoutingConfigsApi->list_dm_routing_configs: #{e}"
|
|
733
|
+
end
|
|
734
|
+
```
|
|
735
|
+
|
|
736
|
+
### Options
|
|
737
|
+
|
|
738
|
+
| Name | Type | Description | Notes |
|
|
739
|
+
| ---- | ---- | ----------- | ----- |
|
|
740
|
+
| **state** | [**Array<String>**](String.md) | Filter configs by lifecycle state. Accepts a comma-separated list of state values (e.g. `?state=active,active-with-draft`). Returns only configs whose current state matches one of the provided values. Returns 400 if any value is not a recognised state. | [optional] |
|
|
741
|
+
| **sort** | **String** | The order in which to list the results. | [optional][default to '-created_at'] |
|
|
742
|
+
| **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] |
|
|
743
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 20] |
|
|
744
|
+
|
|
745
|
+
### Return type
|
|
746
|
+
|
|
747
|
+
[**RoutingConfigsResponse**](RoutingConfigsResponse.md)
|
|
748
|
+
|
|
749
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
750
|
+
[[Back to README]](../../README.md)
|
|
751
|
+
## `reactivate_dm_routing_config_version()`
|
|
752
|
+
|
|
753
|
+
```ruby
|
|
754
|
+
reactivate_dm_routing_config_version(opts): <RoutingConfigVersionResponse> # Reactivate a version
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
Reactivate a previously-active version. The currently active version, if any, becomes inactive but is retained in version history.
|
|
758
|
+
|
|
759
|
+
### Examples
|
|
760
|
+
|
|
761
|
+
```ruby
|
|
762
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
763
|
+
opts = {
|
|
764
|
+
config_id: 'config_id_example', # String |
|
|
765
|
+
version_id: 'version_id_example', # String |
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
begin
|
|
769
|
+
# Reactivate a version
|
|
770
|
+
result = api_instance.reactivate_dm_routing_config_version(opts)
|
|
771
|
+
p result
|
|
772
|
+
rescue Fastly::ApiError => e
|
|
773
|
+
puts "Error when calling DmRoutingConfigsApi->reactivate_dm_routing_config_version: #{e}"
|
|
774
|
+
end
|
|
775
|
+
```
|
|
776
|
+
|
|
777
|
+
### Options
|
|
778
|
+
|
|
779
|
+
| Name | Type | Description | Notes |
|
|
780
|
+
| ---- | ---- | ----------- | ----- |
|
|
781
|
+
| **config_id** | **String** | | |
|
|
782
|
+
| **version_id** | **String** | | |
|
|
783
|
+
|
|
784
|
+
### Return type
|
|
785
|
+
|
|
786
|
+
[**RoutingConfigVersionResponse**](RoutingConfigVersionResponse.md)
|
|
787
|
+
|
|
788
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
789
|
+
[[Back to README]](../../README.md)
|
|
790
|
+
## `update_dm_routing_config_draft()`
|
|
791
|
+
|
|
792
|
+
```ruby
|
|
793
|
+
update_dm_routing_config_draft(opts): <RoutingConfigVersionResponse> # Update the draft
|
|
794
|
+
```
|
|
795
|
+
|
|
796
|
+
Update metadata on the draft version, such as its comment. If no draft exists, one is created automatically by cloning the active version.
|
|
797
|
+
|
|
798
|
+
### Examples
|
|
799
|
+
|
|
800
|
+
```ruby
|
|
801
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
802
|
+
opts = {
|
|
803
|
+
config_id: 'config_id_example', # String |
|
|
804
|
+
draft_update: Fastly::DraftUpdate.new, # DraftUpdate |
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
begin
|
|
808
|
+
# Update the draft
|
|
809
|
+
result = api_instance.update_dm_routing_config_draft(opts)
|
|
810
|
+
p result
|
|
811
|
+
rescue Fastly::ApiError => e
|
|
812
|
+
puts "Error when calling DmRoutingConfigsApi->update_dm_routing_config_draft: #{e}"
|
|
813
|
+
end
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### Options
|
|
817
|
+
|
|
818
|
+
| Name | Type | Description | Notes |
|
|
819
|
+
| ---- | ---- | ----------- | ----- |
|
|
820
|
+
| **config_id** | **String** | | |
|
|
821
|
+
| **draft_update** | [**DraftUpdate**](DraftUpdate.md) | | [optional] |
|
|
822
|
+
|
|
823
|
+
### Return type
|
|
824
|
+
|
|
825
|
+
[**RoutingConfigVersionResponse**](RoutingConfigVersionResponse.md)
|
|
826
|
+
|
|
827
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
828
|
+
[[Back to README]](../../README.md)
|
|
829
|
+
## `update_dm_routing_config_path()`
|
|
830
|
+
|
|
831
|
+
```ruby
|
|
832
|
+
update_dm_routing_config_path(opts): <PathResponse> # Update a path
|
|
833
|
+
```
|
|
834
|
+
|
|
835
|
+
Update a path on the config's draft version. If no draft exists, one is created automatically by cloning the active version.
|
|
836
|
+
|
|
837
|
+
### Examples
|
|
838
|
+
|
|
839
|
+
```ruby
|
|
840
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
841
|
+
opts = {
|
|
842
|
+
config_id: 'config_id_example', # String |
|
|
843
|
+
path_id: 'path_id_example', # String |
|
|
844
|
+
path_update: Fastly::PathUpdate.new, # PathUpdate |
|
|
845
|
+
}
|
|
846
|
+
|
|
847
|
+
begin
|
|
848
|
+
# Update a path
|
|
849
|
+
result = api_instance.update_dm_routing_config_path(opts)
|
|
850
|
+
p result
|
|
851
|
+
rescue Fastly::ApiError => e
|
|
852
|
+
puts "Error when calling DmRoutingConfigsApi->update_dm_routing_config_path: #{e}"
|
|
853
|
+
end
|
|
854
|
+
```
|
|
855
|
+
|
|
856
|
+
### Options
|
|
857
|
+
|
|
858
|
+
| Name | Type | Description | Notes |
|
|
859
|
+
| ---- | ---- | ----------- | ----- |
|
|
860
|
+
| **config_id** | **String** | | |
|
|
861
|
+
| **path_id** | **String** | | |
|
|
862
|
+
| **path_update** | [**PathUpdate**](PathUpdate.md) | | [optional] |
|
|
863
|
+
|
|
864
|
+
### Return type
|
|
865
|
+
|
|
866
|
+
[**PathResponse**](PathResponse.md)
|
|
867
|
+
|
|
868
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
869
|
+
[[Back to README]](../../README.md)
|
|
870
|
+
## `update_dm_routing_config_rule()`
|
|
871
|
+
|
|
872
|
+
```ruby
|
|
873
|
+
update_dm_routing_config_rule(opts): <RuleResponse> # Update a rule
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
Update a rule on the config's draft version. If no draft exists, one is created automatically by cloning the active version.
|
|
877
|
+
|
|
878
|
+
### Examples
|
|
879
|
+
|
|
880
|
+
```ruby
|
|
881
|
+
api_instance = Fastly::DmRoutingConfigsApi.new
|
|
882
|
+
opts = {
|
|
883
|
+
config_id: 'config_id_example', # String |
|
|
884
|
+
path_id: 'path_id_example', # String |
|
|
885
|
+
rule_id: 'rule_id_example', # String |
|
|
886
|
+
rule_update: Fastly::RuleUpdate.new, # RuleUpdate |
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
begin
|
|
890
|
+
# Update a rule
|
|
891
|
+
result = api_instance.update_dm_routing_config_rule(opts)
|
|
892
|
+
p result
|
|
893
|
+
rescue Fastly::ApiError => e
|
|
894
|
+
puts "Error when calling DmRoutingConfigsApi->update_dm_routing_config_rule: #{e}"
|
|
895
|
+
end
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
### Options
|
|
899
|
+
|
|
900
|
+
| Name | Type | Description | Notes |
|
|
901
|
+
| ---- | ---- | ----------- | ----- |
|
|
902
|
+
| **config_id** | **String** | | |
|
|
903
|
+
| **path_id** | **String** | | |
|
|
904
|
+
| **rule_id** | **String** | | |
|
|
905
|
+
| **rule_update** | [**RuleUpdate**](RuleUpdate.md) | | [optional] |
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
[**RuleResponse**](RuleResponse.md)
|
|
910
|
+
|
|
911
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
912
|
+
[[Back to README]](../../README.md)
|