fastly 17.2.0 → 18.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +74 -0
- data/Gemfile.lock +4 -4
- data/README.md +76 -2
- data/docs/AiRuntimeControlProviderConnectionsApi.md +210 -0
- data/docs/AiRuntimeControlProvidersApi.md +121 -0
- data/docs/AiRuntimeControlResponseBodyEnable.md +12 -0
- data/docs/AiRuntimeControlResponseCustomer.md +10 -0
- data/docs/AiRuntimeControlResponseLinks.md +10 -0
- data/docs/AiRuntimeControlResponseLinksLinks.md +10 -0
- data/docs/AiRuntimeControlResponseProduct.md +10 -0
- data/docs/AiRuntimeControlResponseProductProduct.md +11 -0
- data/docs/AiRuntimeControlSessionsApi.md +69 -0
- data/docs/AiRuntimeControlUsageMetricsApi.md +113 -0
- data/docs/AiRuntimeControlVirtualKeysApi.md +334 -0
- data/docs/ArcBedrockSetupResponse.md +11 -0
- data/docs/ArcCreateVirtualKeyResponse.md +19 -0
- data/docs/ArcError.md +12 -0
- data/docs/ArcFailoverTarget.md +10 -0
- data/docs/ArcGetProviderConnectionResponse.md +19 -0
- data/docs/ArcGetProviderConnectionResponseExtra.md +10 -0
- data/docs/ArcModel.md +12 -0
- data/docs/ArcModelsMeta.md +10 -0
- data/docs/ArcModelsResponse.md +11 -0
- data/docs/ArcProvider.md +13 -0
- data/docs/ArcProviderConnectionApiKey.md +14 -0
- data/docs/ArcProviderConnectionAwsIam.md +14 -0
- data/docs/ArcProviderConnectionListItemResponse.md +19 -0
- data/docs/ArcProviderConnectionListItemResponseExtra.md +10 -0
- data/docs/ArcProviderConnectionRequest.md +49 -0
- data/docs/ArcProviderConnectionResponse.md +18 -0
- data/docs/ArcProviderConnectionsMeta.md +11 -0
- data/docs/ArcProviderConnectionsResponse.md +11 -0
- data/docs/ArcProvidersMeta.md +10 -0
- data/docs/ArcProvidersResponse.md +11 -0
- data/docs/ArcRotateVirtualKeyRequest.md +10 -0
- data/docs/ArcRotateVirtualKeyResponse.md +17 -0
- data/docs/ArcSession.md +28 -0
- data/docs/ArcSessionLogEntry.md +12 -0
- data/docs/ArcSessionsMeta.md +14 -0
- data/docs/ArcSessionsResponse.md +11 -0
- data/docs/ArcUpdateProviderConnectionRequest.md +14 -0
- data/docs/ArcUpdateVirtualKeyRequest.md +16 -0
- data/docs/ArcUpdateVirtualKeyResponse.md +20 -0
- data/docs/ArcUsageMetric.md +18 -0
- data/docs/ArcUsageMetricsMeta.md +11 -0
- data/docs/ArcUsageMetricsResponse.md +11 -0
- data/docs/ArcVirtualKey.md +15 -0
- data/docs/ArcVirtualKeyFailoverRequest.md +13 -0
- data/docs/ArcVirtualKeyFailoverResponse.md +13 -0
- data/docs/ArcVirtualKeyListItemResponse.md +26 -0
- data/docs/ArcVirtualKeyListItemResponseExtra.md +20 -0
- data/docs/ArcVirtualKeyResponse.md +25 -0
- data/docs/ArcVirtualKeyResponseExtra.md +19 -0
- data/docs/ArcVirtualKeysMeta.md +14 -0
- data/docs/ArcVirtualKeysResponse.md +11 -0
- data/docs/AutomationToken.md +6 -2
- data/docs/AutomationTokenCreateRequest.md +10 -1
- data/docs/AutomationTokenCreateResponse.md +6 -2
- data/docs/AutomationTokenResponse.md +5 -1
- data/docs/AutomationTokenRole.md +11 -0
- data/docs/AutomationTokenUnversionedError.md +11 -0
- data/docs/AutomationTokenUnversionedErrorResponse.md +10 -0
- data/docs/AutomationTokenWorkspace.md +11 -0
- data/docs/AutomationTokenWorkspacesMeta.md +12 -0
- data/docs/AutomationTokenWorkspacesResponse.md +12 -0
- data/docs/AutomationTokensApi.md +43 -1
- data/docs/Backend.md +5 -0
- data/docs/BackendApi.md +20 -0
- data/docs/BackendResponse.md +5 -0
- data/docs/BotManagementAction.md +10 -0
- data/docs/BotManagementApi.md +475 -0
- data/docs/BotManagementBot.md +10 -0
- data/docs/BotManagementBotAction.md +10 -0
- data/docs/BotManagementBotResponse.md +12 -0
- data/docs/BotManagementBotResponseExtra.md +11 -0
- data/docs/BotManagementBotsResponse.md +11 -0
- data/docs/BotManagementCategoriesResponse.md +11 -0
- data/docs/BotManagementCategory.md +10 -0
- data/docs/BotManagementCategoryBots.md +10 -0
- data/docs/BotManagementCategoryBotsAction.md +10 -0
- data/docs/BotManagementCategoryResponse.md +13 -0
- data/docs/BotManagementCategoryResponseExtra.md +12 -0
- data/docs/BotManagementError.md +12 -0
- data/docs/BotManagementInvalidRequestError.md +12 -0
- data/docs/BotManagementInvalidRequestErrorExtra.md +12 -0
- data/docs/BotManagementMeta.md +12 -0
- data/docs/BotManagementNotAllowedError.md +12 -0
- data/docs/BotManagementNotAllowedErrorExtra.md +11 -0
- data/docs/BotManagementNotAuthenticatedError.md +12 -0
- data/docs/BotManagementNotAuthenticatedErrorExtra.md +11 -0
- data/docs/BotManagementNotFoundError.md +12 -0
- data/docs/BotManagementNotFoundErrorExtra.md +11 -0
- data/docs/BotManagementProtectionMode.md +9 -0
- data/docs/BotManagementRateLimitError.md +12 -0
- data/docs/BotManagementRateLimitErrorExtra.md +11 -0
- data/docs/BotManagementWorkspace.md +12 -0
- data/docs/BotManagementWorkspaceBotResponse.md +13 -0
- data/docs/BotManagementWorkspaceBotResponseExtra.md +10 -0
- data/docs/BotManagementWorkspaceBotsResponse.md +11 -0
- data/docs/BotManagementWorkspaceResponse.md +16 -0
- data/docs/BotManagementWorkspaceResponseExtra.md +13 -0
- data/docs/BotManagementWorkspacesResponse.md +11 -0
- data/docs/BotRequestMetricsDataItem.md +16 -0
- data/docs/BotRequestMetricsMetadata.md +14 -0
- data/docs/BotRequestMetricsResponse.md +11 -0
- data/docs/BotRequestsMetricsApi.md +77 -0
- data/docs/BulkUpdateDictionaryItem.md +1 -1
- data/docs/DdosProtectionRule.md +2 -1
- data/docs/DdosProtectionRuleAllOf.md +2 -1
- data/docs/DdosProtectionRulePatch.md +1 -1
- data/docs/DdosProtectionRuleWithStats.md +2 -1
- data/docs/DictionaryItem.md +1 -1
- data/docs/DictionaryItemApi.md +14 -14
- data/docs/DictionaryItemResponse.md +1 -1
- data/docs/HistoricalApi.md +10 -10
- data/docs/MetricsPlatformApi.md +69 -13
- data/docs/NetworkProtectApi.md +789 -0
- data/docs/NetworkProtectConflict.md +13 -0
- data/docs/NetworkProtectConflictError.md +11 -0
- data/docs/NetworkProtectEndpoint.md +11 -0
- data/docs/NetworkProtectEndpointCreate.md +11 -0
- data/docs/NetworkProtectEndpointPolicy.md +11 -0
- data/docs/NetworkProtectEndpointResponse.md +14 -0
- data/docs/NetworkProtectEndpointResponseFields.md +12 -0
- data/docs/NetworkProtectEndpointUpdate.md +10 -0
- data/docs/NetworkProtectEndpointsResponse.md +11 -0
- data/docs/NetworkProtectErrorDetail.md +11 -0
- data/docs/NetworkProtectInvalidRequest.md +13 -0
- data/docs/NetworkProtectListMeta.md +11 -0
- data/docs/NetworkProtectLoaStatus.md +9 -0
- data/docs/NetworkProtectNetwork.md +15 -0
- data/docs/NetworkProtectNetworkCreate.md +14 -0
- data/docs/NetworkProtectNetworkResponse.md +22 -0
- data/docs/NetworkProtectNetworkResponseFields.md +16 -0
- data/docs/NetworkProtectNetworkUpdate.md +14 -0
- data/docs/NetworkProtectNetworksResponse.md +11 -0
- data/docs/NetworkProtectPolicyEndpoint.md +13 -0
- data/docs/NetworkProtectPrefixList.md +12 -0
- data/docs/NetworkProtectPrefixListCreate.md +12 -0
- data/docs/NetworkProtectPrefixListFamily.md +9 -0
- data/docs/NetworkProtectPrefixListResponse.md +15 -0
- data/docs/NetworkProtectPrefixListResponseFields.md +12 -0
- data/docs/NetworkProtectPrefixListUpdate.md +11 -0
- data/docs/NetworkProtectPrefixListsResponse.md +11 -0
- data/docs/NetworkProtectRegion.md +9 -0
- data/docs/NetworkProtectRoaStatus.md +9 -0
- data/docs/NetworkProtectRule.md +16 -0
- data/docs/NetworkProtectRuleAction.md +9 -0
- data/docs/NetworkProtectRuleDestinationPorts.md +9 -0
- data/docs/NetworkProtectRuleIpProtocol.md +9 -0
- data/docs/NetworkProtectRuleMatchDestinationIp.md +10 -0
- data/docs/NetworkProtectRuleMatchDestinationPorts.md +10 -0
- data/docs/NetworkProtectRuleMatchIpProtocol.md +10 -0
- data/docs/NetworkProtectRuleMatchSourcePorts.md +10 -0
- data/docs/NetworkProtectRuleMatchSourcePrefixList.md +10 -0
- data/docs/NetworkProtectRuleResponse.md +16 -0
- data/docs/NetworkProtectRuleSet.md +11 -0
- data/docs/NetworkProtectRuleSetCreate.md +11 -0
- data/docs/NetworkProtectRuleSetDefaultAction.md +9 -0
- data/docs/NetworkProtectRuleSetResponse.md +14 -0
- data/docs/NetworkProtectRuleSetResponseFields.md +12 -0
- data/docs/NetworkProtectRuleSetUpdate.md +11 -0
- data/docs/NetworkProtectRuleSetsResponse.md +11 -0
- data/docs/NetworkProtectRuleSourcePorts.md +9 -0
- data/docs/NetworkProtectRuleTimestamps.md +11 -0
- data/docs/PlatformValues.md +359 -16
- data/docs/ProductAiRuntimeControlApi.md +115 -0
- data/docs/PurgeApi.md +6 -0
- data/docs/RealtimeEntryAggregated.md +18 -0
- data/docs/RealtimeEntryDatacenter.md +18 -0
- data/docs/RealtimeMeasurements.md +18 -0
- data/docs/Results.md +18 -0
- data/lib/fastly/api/ai_runtime_control_provider_connections_api.rb +355 -0
- data/lib/fastly/api/ai_runtime_control_providers_api.rb +195 -0
- data/lib/fastly/api/ai_runtime_control_sessions_api.rb +112 -0
- data/lib/fastly/api/ai_runtime_control_usage_metrics_api.rb +176 -0
- data/lib/fastly/api/ai_runtime_control_virtual_keys_api.rb +580 -0
- data/lib/fastly/api/automation_tokens_api.rb +78 -1
- data/lib/fastly/api/backend_api.rb +38 -0
- data/lib/fastly/api/bot_management_api.rb +869 -0
- data/lib/fastly/api/bot_requests_metrics_api.rb +137 -0
- data/lib/fastly/api/dictionary_item_api.rb +14 -14
- data/lib/fastly/api/domain_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/historical_api.rb +15 -15
- data/lib/fastly/api/metrics_platform_api.rb +131 -24
- data/lib/fastly/api/network_protect_api.rb +1420 -0
- data/lib/fastly/api/origin_inspector_historical_api.rb +1 -1
- data/lib/fastly/api/product_ai_runtime_control_api.rb +186 -0
- data/lib/fastly/api/purge_api.rb +21 -0
- data/lib/fastly/configuration.rb +337 -1
- data/lib/fastly/models/ai_runtime_control_response_body_enable.rb +243 -0
- data/lib/fastly/models/ai_runtime_control_response_customer.rb +216 -0
- data/lib/fastly/models/ai_runtime_control_response_links.rb +216 -0
- data/lib/fastly/models/ai_runtime_control_response_links_links.rb +217 -0
- data/lib/fastly/models/ai_runtime_control_response_product.rb +216 -0
- data/lib/fastly/models/ai_runtime_control_response_product_product.rb +227 -0
- data/lib/fastly/models/arc_bedrock_setup_response.rb +237 -0
- data/lib/fastly/models/arc_create_virtual_key_response.rb +346 -0
- data/lib/fastly/models/arc_error.rb +238 -0
- data/lib/fastly/models/arc_failover_target.rb +223 -0
- data/lib/fastly/models/arc_get_provider_connection_response.rb +393 -0
- data/lib/fastly/models/arc_get_provider_connection_response_extra.rb +224 -0
- data/lib/fastly/models/arc_model.rb +253 -0
- data/lib/fastly/models/arc_models_meta.rb +217 -0
- data/lib/fastly/models/arc_models_response.rb +238 -0
- data/lib/fastly/models/arc_provider.rb +270 -0
- data/lib/fastly/models/arc_provider_connection_api_key.rb +335 -0
- data/lib/fastly/models/arc_provider_connection_aws_iam.rb +350 -0
- data/lib/fastly/models/arc_provider_connection_list_item_response.rb +386 -0
- data/lib/fastly/models/arc_provider_connection_list_item_response_extra.rb +217 -0
- data/lib/fastly/models/arc_provider_connection_request.rb +103 -0
- data/lib/fastly/models/arc_provider_connection_response.rb +369 -0
- data/lib/fastly/models/arc_provider_connections_meta.rb +228 -0
- data/lib/fastly/models/arc_provider_connections_response.rb +238 -0
- data/lib/fastly/models/arc_providers_meta.rb +217 -0
- data/lib/fastly/models/arc_providers_response.rb +238 -0
- data/lib/fastly/models/arc_rotate_virtual_key_request.rb +218 -0
- data/lib/fastly/models/arc_rotate_virtual_key_response.rb +324 -0
- data/lib/fastly/models/arc_session.rb +465 -0
- data/lib/fastly/models/arc_session_log_entry.rb +240 -0
- data/lib/fastly/models/arc_sessions_meta.rb +260 -0
- data/lib/fastly/models/arc_sessions_response.rb +238 -0
- data/lib/fastly/models/arc_update_provider_connection_request.rb +275 -0
- data/lib/fastly/models/arc_update_virtual_key_request.rb +345 -0
- data/lib/fastly/models/arc_update_virtual_key_response.rb +352 -0
- data/lib/fastly/models/arc_usage_metric.rb +347 -0
- data/lib/fastly/models/arc_usage_metrics_meta.rb +228 -0
- data/lib/fastly/models/arc_usage_metrics_response.rb +238 -0
- data/lib/fastly/models/arc_virtual_key.rb +342 -0
- data/lib/fastly/models/arc_virtual_key_failover_request.rb +255 -0
- data/lib/fastly/models/arc_virtual_key_failover_response.rb +270 -0
- data/lib/fastly/models/arc_virtual_key_list_item_response.rb +492 -0
- data/lib/fastly/models/arc_virtual_key_list_item_response_extra.rb +350 -0
- data/lib/fastly/models/arc_virtual_key_response.rb +477 -0
- data/lib/fastly/models/arc_virtual_key_response_extra.rb +335 -0
- data/lib/fastly/models/arc_virtual_keys_meta.rb +260 -0
- data/lib/fastly/models/arc_virtual_keys_response.rb +238 -0
- data/lib/fastly/models/automation_token.rb +49 -5
- data/lib/fastly/models/automation_token_create_request.rb +161 -7
- data/lib/fastly/models/automation_token_create_response.rb +49 -5
- data/lib/fastly/models/automation_token_error_response.rb +1 -0
- data/lib/fastly/models/automation_token_response.rb +46 -2
- data/lib/fastly/models/automation_token_role.rb +227 -0
- data/lib/fastly/models/automation_token_unversioned_error.rb +225 -0
- data/lib/fastly/models/automation_token_unversioned_error_response.rb +219 -0
- data/lib/fastly/models/automation_token_workspace.rb +237 -0
- data/lib/fastly/models/automation_token_workspaces_meta.rb +242 -0
- data/lib/fastly/models/automation_token_workspaces_response.rb +253 -0
- data/lib/fastly/models/backend.rb +90 -1
- data/lib/fastly/models/backend_response.rb +90 -1
- data/lib/fastly/models/bot_management_action.rb +257 -0
- data/lib/fastly/models/bot_management_bot.rb +222 -0
- data/lib/fastly/models/bot_management_bot_action.rb +257 -0
- data/lib/fastly/models/bot_management_bot_response.rb +259 -0
- data/lib/fastly/models/bot_management_bot_response_extra.rb +237 -0
- data/lib/fastly/models/bot_management_bots_response.rb +238 -0
- data/lib/fastly/models/bot_management_categories_response.rb +238 -0
- data/lib/fastly/models/bot_management_category.rb +222 -0
- data/lib/fastly/models/bot_management_category_bots.rb +222 -0
- data/lib/fastly/models/bot_management_category_bots_action.rb +257 -0
- data/lib/fastly/models/bot_management_category_response.rb +269 -0
- data/lib/fastly/models/bot_management_category_response_extra.rb +247 -0
- data/lib/fastly/models/bot_management_error.rb +248 -0
- data/lib/fastly/models/bot_management_invalid_request_error.rb +291 -0
- data/lib/fastly/models/bot_management_invalid_request_error_extra.rb +283 -0
- data/lib/fastly/models/bot_management_meta.rb +239 -0
- data/lib/fastly/models/bot_management_not_allowed_error.rb +287 -0
- data/lib/fastly/models/bot_management_not_allowed_error_extra.rb +259 -0
- data/lib/fastly/models/bot_management_not_authenticated_error.rb +287 -0
- data/lib/fastly/models/bot_management_not_authenticated_error_extra.rb +259 -0
- data/lib/fastly/models/bot_management_not_found_error.rb +287 -0
- data/lib/fastly/models/bot_management_not_found_error_extra.rb +259 -0
- data/lib/fastly/models/bot_management_protection_mode.rb +36 -0
- data/lib/fastly/models/bot_management_rate_limit_error.rb +287 -0
- data/lib/fastly/models/bot_management_rate_limit_error_extra.rb +259 -0
- data/lib/fastly/models/bot_management_workspace.rb +276 -0
- data/lib/fastly/models/bot_management_workspace_bot_response.rb +275 -0
- data/lib/fastly/models/bot_management_workspace_bot_response_extra.rb +222 -0
- data/lib/fastly/models/bot_management_workspace_bots_response.rb +238 -0
- data/lib/fastly/models/bot_management_workspace_response.rb +354 -0
- data/lib/fastly/models/bot_management_workspace_response_extra.rb +264 -0
- data/lib/fastly/models/bot_management_workspaces_response.rb +238 -0
- data/lib/fastly/models/bot_request_metrics_data_item.rb +278 -0
- data/lib/fastly/models/bot_request_metrics_metadata.rb +258 -0
- data/lib/fastly/models/bot_request_metrics_response.rb +228 -0
- data/lib/fastly/models/bulk_update_dictionary_item.rb +1 -1
- data/lib/fastly/models/ddos_protection_request_enable_mode.rb +2 -2
- data/lib/fastly/models/ddos_protection_request_update_configuration.rb +2 -2
- data/lib/fastly/models/ddos_protection_rule.rb +13 -2
- data/lib/fastly/models/ddos_protection_rule_all_of.rb +13 -2
- data/lib/fastly/models/ddos_protection_rule_patch.rb +1 -1
- data/lib/fastly/models/ddos_protection_rule_with_stats.rb +13 -2
- data/lib/fastly/models/dictionary_item.rb +1 -1
- data/lib/fastly/models/dictionary_item_response.rb +1 -1
- data/lib/fastly/models/event_attributes.rb +2 -2
- data/lib/fastly/models/network_protect_conflict.rb +299 -0
- data/lib/fastly/models/network_protect_conflict_error.rb +228 -0
- data/lib/fastly/models/network_protect_endpoint.rb +266 -0
- data/lib/fastly/models/network_protect_endpoint_create.rb +266 -0
- data/lib/fastly/models/network_protect_endpoint_policy.rb +255 -0
- data/lib/fastly/models/network_protect_endpoint_response.rb +340 -0
- data/lib/fastly/models/network_protect_endpoint_response_fields.rb +274 -0
- data/lib/fastly/models/network_protect_endpoint_update.rb +251 -0
- data/lib/fastly/models/network_protect_endpoints_response.rb +239 -0
- data/lib/fastly/models/network_protect_error_detail.rb +238 -0
- data/lib/fastly/models/{automation_token_create_request_attributes.rb → network_protect_invalid_request.rb} +63 -75
- data/lib/fastly/models/network_protect_list_meta.rb +263 -0
- data/lib/fastly/models/network_protect_loa_status.rb +36 -0
- data/lib/fastly/models/network_protect_network.rb +363 -0
- data/lib/fastly/models/network_protect_network_create.rb +340 -0
- data/lib/fastly/models/network_protect_network_response.rb +477 -0
- data/lib/fastly/models/network_protect_network_response_fields.rb +314 -0
- data/lib/fastly/models/network_protect_network_update.rb +329 -0
- data/lib/fastly/models/network_protect_networks_response.rb +239 -0
- data/lib/fastly/models/network_protect_policy_endpoint.rb +307 -0
- data/lib/fastly/models/network_protect_prefix_list.rb +282 -0
- data/lib/fastly/models/network_protect_prefix_list_create.rb +301 -0
- data/lib/fastly/models/network_protect_prefix_list_family.rb +35 -0
- data/lib/fastly/models/network_protect_prefix_list_response.rb +356 -0
- data/lib/fastly/models/network_protect_prefix_list_response_fields.rb +274 -0
- data/lib/fastly/models/network_protect_prefix_list_update.rb +269 -0
- data/lib/fastly/models/network_protect_prefix_lists_response.rb +239 -0
- data/lib/fastly/models/network_protect_region.rb +34 -0
- data/lib/fastly/models/network_protect_roa_status.rb +37 -0
- data/lib/fastly/models/network_protect_rule.rb +372 -0
- data/lib/fastly/models/network_protect_rule_action.rb +35 -0
- data/lib/fastly/models/network_protect_rule_destination_ports.rb +208 -0
- data/lib/fastly/models/network_protect_rule_ip_protocol.rb +37 -0
- data/lib/fastly/models/network_protect_rule_match_destination_ip.rb +223 -0
- data/lib/fastly/models/network_protect_rule_match_destination_ports.rb +222 -0
- data/lib/fastly/models/network_protect_rule_match_ip_protocol.rb +222 -0
- data/lib/fastly/models/network_protect_rule_match_source_ports.rb +222 -0
- data/lib/fastly/models/network_protect_rule_match_source_prefix_list.rb +244 -0
- data/lib/fastly/models/network_protect_rule_response.rb +329 -0
- data/lib/fastly/models/network_protect_rule_set.rb +258 -0
- data/lib/fastly/models/network_protect_rule_set_create.rb +249 -0
- data/lib/fastly/models/network_protect_rule_set_default_action.rb +35 -0
- data/lib/fastly/models/network_protect_rule_set_response.rb +332 -0
- data/lib/fastly/models/network_protect_rule_set_response_fields.rb +274 -0
- data/lib/fastly/models/network_protect_rule_set_update.rb +244 -0
- data/lib/fastly/models/network_protect_rule_sets_response.rb +239 -0
- data/lib/fastly/models/network_protect_rule_source_ports.rb +208 -0
- data/lib/fastly/models/network_protect_rule_timestamps.rb +228 -0
- data/lib/fastly/models/platform_values.rb +3568 -137
- data/lib/fastly/models/pop.rb +6 -6
- data/lib/fastly/models/realtime_entry_aggregated.rb +184 -4
- data/lib/fastly/models/realtime_entry_datacenter.rb +184 -4
- data/lib/fastly/models/realtime_measurements.rb +184 -4
- data/lib/fastly/models/results.rb +181 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +145 -1
- data/sig.json +1 -1
- metadata +2502 -2214
- data/docs/AutomationTokenCreateRequestAttributes.md +0 -15
|
@@ -0,0 +1,475 @@
|
|
|
1
|
+
# Fastly::BotManagementApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::BotManagementApi.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
|
+
[**bot_management_get_bot**](BotManagementApi.md#bot_management_get_bot) | **GET** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots/{bot_id} | Get a bot
|
|
17
|
+
[**bot_management_get_category**](BotManagementApi.md#bot_management_get_category) | **GET** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id} | Get a category
|
|
18
|
+
[**bot_management_get_workspace**](BotManagementApi.md#bot_management_get_workspace) | **GET** /bot-management/v1/workspaces/{workspace_id} | Get a workspace
|
|
19
|
+
[**bot_management_list_bots**](BotManagementApi.md#bot_management_list_bots) | **GET** /bot-management/v1/workspaces/{workspace_id}/policy/bots | List all bots in a workspace
|
|
20
|
+
[**bot_management_list_categories**](BotManagementApi.md#bot_management_list_categories) | **GET** /bot-management/v1/workspaces/{workspace_id}/policy/categories | List categories
|
|
21
|
+
[**bot_management_list_category_bots**](BotManagementApi.md#bot_management_list_category_bots) | **GET** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots | List bots in a category
|
|
22
|
+
[**bot_management_list_workspaces**](BotManagementApi.md#bot_management_list_workspaces) | **GET** /bot-management/v1/workspaces | List workspaces
|
|
23
|
+
[**bot_management_update_bot**](BotManagementApi.md#bot_management_update_bot) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots/{bot_id} | Set a bot action
|
|
24
|
+
[**bot_management_update_category**](BotManagementApi.md#bot_management_update_category) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id} | Set a category action
|
|
25
|
+
[**bot_management_update_category_bots**](BotManagementApi.md#bot_management_update_category_bots) | **PATCH** /bot-management/v1/workspaces/{workspace_id}/policy/categories/{category_id}/bots | Set the action for all bots in a category
|
|
26
|
+
[**bot_management_update_workspace**](BotManagementApi.md#bot_management_update_workspace) | **PATCH** /bot-management/v1/workspaces/{workspace_id} | Update a workspace
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## `bot_management_get_bot()`
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
bot_management_get_bot(opts): <BotManagementBotResponse> # Get a bot
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Get the attributes of a bot in a category.
|
|
36
|
+
|
|
37
|
+
### Examples
|
|
38
|
+
|
|
39
|
+
```ruby
|
|
40
|
+
api_instance = Fastly::BotManagementApi.new
|
|
41
|
+
opts = {
|
|
42
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
43
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
44
|
+
bot_id: 'gptbot', # String | The ID of the bot.
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
# Get a bot
|
|
49
|
+
result = api_instance.bot_management_get_bot(opts)
|
|
50
|
+
p result
|
|
51
|
+
rescue Fastly::ApiError => e
|
|
52
|
+
puts "Error when calling BotManagementApi->bot_management_get_bot: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Options
|
|
57
|
+
|
|
58
|
+
| Name | Type | Description | Notes |
|
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
|
60
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
61
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
62
|
+
| **bot_id** | **String** | The ID of the bot. | |
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**BotManagementBotResponse**](BotManagementBotResponse.md)
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
69
|
+
[[Back to README]](../../README.md)
|
|
70
|
+
## `bot_management_get_category()`
|
|
71
|
+
|
|
72
|
+
```ruby
|
|
73
|
+
bot_management_get_category(opts): <BotManagementCategoryResponse> # Get a category
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Get the attributes of a bot category.
|
|
77
|
+
|
|
78
|
+
### Examples
|
|
79
|
+
|
|
80
|
+
```ruby
|
|
81
|
+
api_instance = Fastly::BotManagementApi.new
|
|
82
|
+
opts = {
|
|
83
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
84
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
# Get a category
|
|
89
|
+
result = api_instance.bot_management_get_category(opts)
|
|
90
|
+
p result
|
|
91
|
+
rescue Fastly::ApiError => e
|
|
92
|
+
puts "Error when calling BotManagementApi->bot_management_get_category: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Options
|
|
97
|
+
|
|
98
|
+
| Name | Type | Description | Notes |
|
|
99
|
+
| ---- | ---- | ----------- | ----- |
|
|
100
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
101
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**BotManagementCategoryResponse**](BotManagementCategoryResponse.md)
|
|
106
|
+
|
|
107
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
108
|
+
[[Back to README]](../../README.md)
|
|
109
|
+
## `bot_management_get_workspace()`
|
|
110
|
+
|
|
111
|
+
```ruby
|
|
112
|
+
bot_management_get_workspace(opts): <BotManagementWorkspaceResponse> # Get a workspace
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Retrieve a bot management workspace.
|
|
116
|
+
|
|
117
|
+
### Examples
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
api_instance = Fastly::BotManagementApi.new
|
|
121
|
+
opts = {
|
|
122
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
begin
|
|
126
|
+
# Get a workspace
|
|
127
|
+
result = api_instance.bot_management_get_workspace(opts)
|
|
128
|
+
p result
|
|
129
|
+
rescue Fastly::ApiError => e
|
|
130
|
+
puts "Error when calling BotManagementApi->bot_management_get_workspace: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Options
|
|
135
|
+
|
|
136
|
+
| Name | Type | Description | Notes |
|
|
137
|
+
| ---- | ---- | ----------- | ----- |
|
|
138
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
139
|
+
|
|
140
|
+
### Return type
|
|
141
|
+
|
|
142
|
+
[**BotManagementWorkspaceResponse**](BotManagementWorkspaceResponse.md)
|
|
143
|
+
|
|
144
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
145
|
+
[[Back to README]](../../README.md)
|
|
146
|
+
## `bot_management_list_bots()`
|
|
147
|
+
|
|
148
|
+
```ruby
|
|
149
|
+
bot_management_list_bots(opts): <BotManagementWorkspaceBotsResponse> # List all bots in a workspace
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
List all bots in a workspace's policy across all categories.
|
|
153
|
+
|
|
154
|
+
### Examples
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
api_instance = Fastly::BotManagementApi.new
|
|
158
|
+
opts = {
|
|
159
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
160
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
161
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
begin
|
|
165
|
+
# List all bots in a workspace
|
|
166
|
+
result = api_instance.bot_management_list_bots(opts)
|
|
167
|
+
p result
|
|
168
|
+
rescue Fastly::ApiError => e
|
|
169
|
+
puts "Error when calling BotManagementApi->bot_management_list_bots: #{e}"
|
|
170
|
+
end
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Options
|
|
174
|
+
|
|
175
|
+
| Name | Type | Description | Notes |
|
|
176
|
+
| ---- | ---- | ----------- | ----- |
|
|
177
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
178
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
179
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
[**BotManagementWorkspaceBotsResponse**](BotManagementWorkspaceBotsResponse.md)
|
|
184
|
+
|
|
185
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
186
|
+
[[Back to README]](../../README.md)
|
|
187
|
+
## `bot_management_list_categories()`
|
|
188
|
+
|
|
189
|
+
```ruby
|
|
190
|
+
bot_management_list_categories(opts): <BotManagementCategoriesResponse> # List categories
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
List all bot categories in a workspace's policy. Each category has an action that applies to every bot in the category that is set to `inherit`. To list the bots themselves, use [list all bots in a workspace](#bot-management-list-bots) or [list bots in a category](#bot-management-list-category-bots).
|
|
194
|
+
|
|
195
|
+
### Examples
|
|
196
|
+
|
|
197
|
+
```ruby
|
|
198
|
+
api_instance = Fastly::BotManagementApi.new
|
|
199
|
+
opts = {
|
|
200
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
201
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
202
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
begin
|
|
206
|
+
# List categories
|
|
207
|
+
result = api_instance.bot_management_list_categories(opts)
|
|
208
|
+
p result
|
|
209
|
+
rescue Fastly::ApiError => e
|
|
210
|
+
puts "Error when calling BotManagementApi->bot_management_list_categories: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Options
|
|
215
|
+
|
|
216
|
+
| Name | Type | Description | Notes |
|
|
217
|
+
| ---- | ---- | ----------- | ----- |
|
|
218
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
219
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
220
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
[**BotManagementCategoriesResponse**](BotManagementCategoriesResponse.md)
|
|
225
|
+
|
|
226
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
227
|
+
[[Back to README]](../../README.md)
|
|
228
|
+
## `bot_management_list_category_bots()`
|
|
229
|
+
|
|
230
|
+
```ruby
|
|
231
|
+
bot_management_list_category_bots(opts): <BotManagementBotsResponse> # List bots in a category
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
List all bots in a bot category.
|
|
235
|
+
|
|
236
|
+
### Examples
|
|
237
|
+
|
|
238
|
+
```ruby
|
|
239
|
+
api_instance = Fastly::BotManagementApi.new
|
|
240
|
+
opts = {
|
|
241
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
242
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
243
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
244
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
begin
|
|
248
|
+
# List bots in a category
|
|
249
|
+
result = api_instance.bot_management_list_category_bots(opts)
|
|
250
|
+
p result
|
|
251
|
+
rescue Fastly::ApiError => e
|
|
252
|
+
puts "Error when calling BotManagementApi->bot_management_list_category_bots: #{e}"
|
|
253
|
+
end
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Options
|
|
257
|
+
|
|
258
|
+
| Name | Type | Description | Notes |
|
|
259
|
+
| ---- | ---- | ----------- | ----- |
|
|
260
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
261
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
262
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
263
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
[**BotManagementBotsResponse**](BotManagementBotsResponse.md)
|
|
268
|
+
|
|
269
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
270
|
+
[[Back to README]](../../README.md)
|
|
271
|
+
## `bot_management_list_workspaces()`
|
|
272
|
+
|
|
273
|
+
```ruby
|
|
274
|
+
bot_management_list_workspaces(opts): <BotManagementWorkspacesResponse> # List workspaces
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
List bot management workspaces.
|
|
278
|
+
|
|
279
|
+
### Examples
|
|
280
|
+
|
|
281
|
+
```ruby
|
|
282
|
+
api_instance = Fastly::BotManagementApi.new
|
|
283
|
+
opts = {
|
|
284
|
+
service_id: '6oMkSHsKCMBjQJPLHgMxu1', # String | Filter results to the workspace attached to this service. Returns an empty list if the service is not attached to a workspace.
|
|
285
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
286
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
begin
|
|
290
|
+
# List workspaces
|
|
291
|
+
result = api_instance.bot_management_list_workspaces(opts)
|
|
292
|
+
p result
|
|
293
|
+
rescue Fastly::ApiError => e
|
|
294
|
+
puts "Error when calling BotManagementApi->bot_management_list_workspaces: #{e}"
|
|
295
|
+
end
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Options
|
|
299
|
+
|
|
300
|
+
| Name | Type | Description | Notes |
|
|
301
|
+
| ---- | ---- | ----------- | ----- |
|
|
302
|
+
| **service_id** | **String** | Filter results to the workspace attached to this service. Returns an empty list if the service is not attached to a workspace. | [optional] |
|
|
303
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
304
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
[**BotManagementWorkspacesResponse**](BotManagementWorkspacesResponse.md)
|
|
309
|
+
|
|
310
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
311
|
+
[[Back to README]](../../README.md)
|
|
312
|
+
## `bot_management_update_bot()`
|
|
313
|
+
|
|
314
|
+
```ruby
|
|
315
|
+
bot_management_update_bot(opts): <BotManagementBotResponse> # Set a bot action
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
Set the action for a bot. Set the action to 'inherit' to apply the category's action or to a specific value to override the category's action.
|
|
319
|
+
|
|
320
|
+
### Examples
|
|
321
|
+
|
|
322
|
+
```ruby
|
|
323
|
+
api_instance = Fastly::BotManagementApi.new
|
|
324
|
+
opts = {
|
|
325
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
326
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
327
|
+
bot_id: 'gptbot', # String | The ID of the bot.
|
|
328
|
+
bot_management_bot: Fastly::BotManagementBot.new({action: Fastly::BotManagementBotAction.new({type: 'allow'})}), # BotManagementBot |
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Set a bot action
|
|
333
|
+
result = api_instance.bot_management_update_bot(opts)
|
|
334
|
+
p result
|
|
335
|
+
rescue Fastly::ApiError => e
|
|
336
|
+
puts "Error when calling BotManagementApi->bot_management_update_bot: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### Options
|
|
341
|
+
|
|
342
|
+
| Name | Type | Description | Notes |
|
|
343
|
+
| ---- | ---- | ----------- | ----- |
|
|
344
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
345
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
346
|
+
| **bot_id** | **String** | The ID of the bot. | |
|
|
347
|
+
| **bot_management_bot** | [**BotManagementBot**](BotManagementBot.md) | | |
|
|
348
|
+
|
|
349
|
+
### Return type
|
|
350
|
+
|
|
351
|
+
[**BotManagementBotResponse**](BotManagementBotResponse.md)
|
|
352
|
+
|
|
353
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
354
|
+
[[Back to README]](../../README.md)
|
|
355
|
+
## `bot_management_update_category()`
|
|
356
|
+
|
|
357
|
+
```ruby
|
|
358
|
+
bot_management_update_category(opts): <BotManagementCategoryResponse> # Set a category action
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
Set the default action for a bot category. Bots set to `inherit` follow this action. Bots with their own action keep it. To remove every bot's own action in the category, use [set the action for all bots in a category](#bot-management-update-category-bots).
|
|
362
|
+
|
|
363
|
+
### Examples
|
|
364
|
+
|
|
365
|
+
```ruby
|
|
366
|
+
api_instance = Fastly::BotManagementApi.new
|
|
367
|
+
opts = {
|
|
368
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
369
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
370
|
+
bot_management_category: Fastly::BotManagementCategory.new({action: Fastly::BotManagementAction.new({type: 'allow'})}), # BotManagementCategory |
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
begin
|
|
374
|
+
# Set a category action
|
|
375
|
+
result = api_instance.bot_management_update_category(opts)
|
|
376
|
+
p result
|
|
377
|
+
rescue Fastly::ApiError => e
|
|
378
|
+
puts "Error when calling BotManagementApi->bot_management_update_category: #{e}"
|
|
379
|
+
end
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Options
|
|
383
|
+
|
|
384
|
+
| Name | Type | Description | Notes |
|
|
385
|
+
| ---- | ---- | ----------- | ----- |
|
|
386
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
387
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
388
|
+
| **bot_management_category** | [**BotManagementCategory**](BotManagementCategory.md) | | |
|
|
389
|
+
|
|
390
|
+
### Return type
|
|
391
|
+
|
|
392
|
+
[**BotManagementCategoryResponse**](BotManagementCategoryResponse.md)
|
|
393
|
+
|
|
394
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
395
|
+
[[Back to README]](../../README.md)
|
|
396
|
+
## `bot_management_update_category_bots()`
|
|
397
|
+
|
|
398
|
+
```ruby
|
|
399
|
+
bot_management_update_category_bots(opts): <BotManagementBotsResponse> # Set the action for all bots in a category
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
Set the action for every bot in a category. Setting `inherit` removes each bot's own action, so every bot follows the category's action. The category's own action is unchanged. The update applies to every bot in the category or to none, and repeating it gives the same result. The response lists every bot in the category, including bots that already inherited, and is not paginated.
|
|
403
|
+
|
|
404
|
+
### Examples
|
|
405
|
+
|
|
406
|
+
```ruby
|
|
407
|
+
api_instance = Fastly::BotManagementApi.new
|
|
408
|
+
opts = {
|
|
409
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
410
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
411
|
+
bot_management_category_bots: Fastly::BotManagementCategoryBots.new({action: Fastly::BotManagementCategoryBotsAction.new({type: 'inherit'})}), # BotManagementCategoryBots |
|
|
412
|
+
}
|
|
413
|
+
|
|
414
|
+
begin
|
|
415
|
+
# Set the action for all bots in a category
|
|
416
|
+
result = api_instance.bot_management_update_category_bots(opts)
|
|
417
|
+
p result
|
|
418
|
+
rescue Fastly::ApiError => e
|
|
419
|
+
puts "Error when calling BotManagementApi->bot_management_update_category_bots: #{e}"
|
|
420
|
+
end
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
### Options
|
|
424
|
+
|
|
425
|
+
| Name | Type | Description | Notes |
|
|
426
|
+
| ---- | ---- | ----------- | ----- |
|
|
427
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
428
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
429
|
+
| **bot_management_category_bots** | [**BotManagementCategoryBots**](BotManagementCategoryBots.md) | | |
|
|
430
|
+
|
|
431
|
+
### Return type
|
|
432
|
+
|
|
433
|
+
[**BotManagementBotsResponse**](BotManagementBotsResponse.md)
|
|
434
|
+
|
|
435
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
436
|
+
[[Back to README]](../../README.md)
|
|
437
|
+
## `bot_management_update_workspace()`
|
|
438
|
+
|
|
439
|
+
```ruby
|
|
440
|
+
bot_management_update_workspace(opts): <BotManagementWorkspaceResponse> # Update a workspace
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
Update the attributes of a bot management workspace.
|
|
444
|
+
|
|
445
|
+
### Examples
|
|
446
|
+
|
|
447
|
+
```ruby
|
|
448
|
+
api_instance = Fastly::BotManagementApi.new
|
|
449
|
+
opts = {
|
|
450
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
451
|
+
bot_management_workspace: Fastly::BotManagementWorkspace.new, # BotManagementWorkspace |
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
begin
|
|
455
|
+
# Update a workspace
|
|
456
|
+
result = api_instance.bot_management_update_workspace(opts)
|
|
457
|
+
p result
|
|
458
|
+
rescue Fastly::ApiError => e
|
|
459
|
+
puts "Error when calling BotManagementApi->bot_management_update_workspace: #{e}"
|
|
460
|
+
end
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
### Options
|
|
464
|
+
|
|
465
|
+
| Name | Type | Description | Notes |
|
|
466
|
+
| ---- | ---- | ----------- | ----- |
|
|
467
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
468
|
+
| **bot_management_workspace** | [**BotManagementWorkspace**](BotManagementWorkspace.md) | | |
|
|
469
|
+
|
|
470
|
+
### Return type
|
|
471
|
+
|
|
472
|
+
[**BotManagementWorkspaceResponse**](BotManagementWorkspaceResponse.md)
|
|
473
|
+
|
|
474
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
475
|
+
[[Back to README]](../../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementBot
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementBotAction**](BotManagementBotAction.md) | | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementBotAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of action to apply. | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementBotResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementBotAction**](BotManagementBotAction.md) | | |
|
|
8
|
+
| **bot_id** | **String** | The unique identifier of the bot. | [readonly] |
|
|
9
|
+
| **name** | **String** | The display name of the bot. | [readonly] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementBotResponseExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bot_id** | **String** | The unique identifier of the bot. | [readonly] |
|
|
8
|
+
| **name** | **String** | The display name of the bot. | [readonly] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementBotsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**BotManagementMeta**](BotManagementMeta.md) | | |
|
|
8
|
+
| **data** | [**Array<BotManagementBotResponse>**](BotManagementBotResponse.md) | The bots returned by the request. | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoriesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**BotManagementMeta**](BotManagementMeta.md) | | |
|
|
8
|
+
| **data** | [**Array<BotManagementCategoryResponse>**](BotManagementCategoryResponse.md) | The categories returned by the request. | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementCategory
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementAction**](BotManagementAction.md) | | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryBots
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementCategoryBotsAction**](BotManagementCategoryBotsAction.md) | | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryBotsAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of action to apply. Only `inherit` is supported. | |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **action** | [**BotManagementAction**](BotManagementAction.md) | | |
|
|
8
|
+
| **category_id** | **String** | The unique identifier of the category. | [readonly] |
|
|
9
|
+
| **name** | **String** | The display name of the category. | [readonly] |
|
|
10
|
+
| **description** | **String** | A description of the bots the category contains. | [optional][readonly] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementCategoryResponseExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **category_id** | **String** | The unique identifier of the category. | [readonly] |
|
|
8
|
+
| **name** | **String** | The display name of the category. | [readonly] |
|
|
9
|
+
| **description** | **String** | A description of the bots the category contains. | [optional][readonly] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | A short summary of the problem. | |
|
|
8
|
+
| **status** | **Integer** | The HTTP status code of the response. | |
|
|
9
|
+
| **detail** | **String** | An explanation of the problem, specific to this occurrence. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementInvalidRequestError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | |
|
|
8
|
+
| **status** | **Integer** | | |
|
|
9
|
+
| **detail** | **String** | | |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementInvalidRequestErrorExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | |
|
|
8
|
+
| **status** | **Integer** | | |
|
|
9
|
+
| **detail** | **String** | | |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **limit** | **Integer** | The `limit` value used when making the request. | [optional] |
|
|
8
|
+
| **total** | **Integer** | The count of results matching the request. | [optional] |
|
|
9
|
+
| **next_cursor** | **String** | The cursor to use to request the next page of results. Set to `null` when there are no more results. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementNotAllowedError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | |
|
|
8
|
+
| **status** | **Integer** | | |
|
|
9
|
+
| **detail** | **String** | An explanation of the problem, specific to this occurrence. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|