fastly 17.2.0 → 18.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 +45 -1
- data/Gemfile.lock +1 -1
- data/README.md +73 -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/BotManagementAction.md +10 -0
- data/docs/BotManagementApi.md +433 -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/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 +1 -1
- data/docs/DdosProtectionRuleAllOf.md +1 -1
- data/docs/DdosProtectionRulePatch.md +1 -1
- data/docs/DdosProtectionRuleWithStats.md +1 -1
- data/docs/DictionaryItem.md +1 -1
- data/docs/DictionaryItemApi.md +14 -14
- data/docs/DictionaryItemResponse.md +1 -1
- 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 +16 -0
- data/docs/RealtimeEntryDatacenter.md +16 -0
- data/docs/RealtimeMeasurements.md +16 -0
- data/docs/Results.md +16 -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/bot_management_api.rb +787 -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/metrics_platform_api.rb +130 -23
- data/lib/fastly/api/network_protect_api.rb +1420 -0
- 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 +331 -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/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_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 +1 -1
- data/lib/fastly/models/ddos_protection_rule_all_of.rb +1 -1
- data/lib/fastly/models/ddos_protection_rule_patch.rb +1 -1
- data/lib/fastly/models/ddos_protection_rule_with_stats.rb +1 -1
- 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/realtime_entry_aggregated.rb +164 -4
- data/lib/fastly/models/realtime_entry_datacenter.rb +164 -4
- data/lib/fastly/models/realtime_measurements.rb +164 -4
- data/lib/fastly/models/results.rb +161 -1
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +143 -1
- data/sig.json +1 -1
- metadata +288 -4
- data/docs/AutomationTokenCreateRequestAttributes.md +0 -15
|
@@ -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,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
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementNotAllowedErrorExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementNotAuthenticatedError
|
|
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
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementNotAuthenticatedErrorExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementNotFoundError
|
|
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
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementNotFoundErrorExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementRateLimitError
|
|
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
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementRateLimitErrorExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **status** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspace
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The display name of the workspace. | [optional] |
|
|
8
|
+
| **description** | **String** | A description of the workspace. | [optional] |
|
|
9
|
+
| **protection_mode** | [**BotManagementProtectionMode**](BotManagementProtectionMode.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspaceBotResponse
|
|
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
|
+
| **category_id** | **String** | The ID of the category the bot belongs to. | [readonly] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspaceBotResponseExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **category_id** | **String** | The ID of the category the bot belongs to. | [readonly] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspaceBotsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**BotManagementMeta**](BotManagementMeta.md) | | |
|
|
8
|
+
| **data** | [**Array<BotManagementWorkspaceBotResponse>**](BotManagementWorkspaceBotResponse.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,16 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspaceResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The display name of the workspace. | |
|
|
8
|
+
| **protection_mode** | [**BotManagementProtectionMode**](BotManagementProtectionMode.md) | | |
|
|
9
|
+
| **id** | **String** | A UUID used to uniquely identify the workspace. | [readonly] |
|
|
10
|
+
| **created_at** | **Time** | The date and time the workspace was created, in RFC 3339 format. | [readonly] |
|
|
11
|
+
| **updated_at** | **Time** | The date and time the workspace was last updated, in RFC 3339 format. | [readonly] |
|
|
12
|
+
| **description** | **String** | A description of the workspace. | [optional] |
|
|
13
|
+
| **services** | **Array<String>** | The IDs of the services attached to this workspace. | [optional][readonly] |
|
|
14
|
+
|
|
15
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
16
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspaceResponseExtra
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A UUID used to uniquely identify the workspace. | [readonly] |
|
|
8
|
+
| **created_at** | **Time** | The date and time the workspace was created, in RFC 3339 format. | [readonly] |
|
|
9
|
+
| **updated_at** | **Time** | The date and time the workspace was last updated, in RFC 3339 format. | [readonly] |
|
|
10
|
+
| **services** | **Array<String>** | The IDs of the services attached to this workspace. | [optional][readonly] |
|
|
11
|
+
|
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
13
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotManagementWorkspacesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **meta** | [**BotManagementMeta**](BotManagementMeta.md) | | |
|
|
8
|
+
| **data** | [**Array<BotManagementWorkspaceResponse>**](BotManagementWorkspaceResponse.md) | The workspaces returned by the request. | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Fastly::BotRequestMetricsDataItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **timestamp** | **Time** | Timestamp for the time series being reported. | [optional] |
|
|
8
|
+
| **bot** | **String** | Bot identifier for which data was recorded. Present only when grouped by bot. | [optional] |
|
|
9
|
+
| **datacenter** | **String** | Datacenter (POP) for which data was recorded. Present only when grouped by datacenter. | [optional] |
|
|
10
|
+
| **bot_edge_requests_allowed_count** | **Integer** | Count of edge requests where a bot was detected and the request was allowed by the configured policy. | [optional] |
|
|
11
|
+
| **bot_edge_requests_challenged_count** | **Integer** | Count of edge requests where a bot was detected and a client challenge was issued for the request by the configured policy. | [optional] |
|
|
12
|
+
| **bot_edge_requests_blocked_count** | **Integer** | Count of edge requests where a bot was detected and the request was blocked by the configured policy. | [optional] |
|
|
13
|
+
| **bot_edge_requests_challenge_token_valid_count** | **Integer** | Count of edge requests where a bot was detected and the client making the request has already solved a challenge issued by the configured policy. | [optional] |
|
|
14
|
+
|
|
15
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
16
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Fastly::BotRequestMetricsMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **from** | **Time** | An RFC-8339-formatted date and time string indicating the inclusive start of the query time range. | [optional] |
|
|
8
|
+
| **to** | **Time** | An RFC-8339-formatted date and time indicating the exclusive end of the query time range. | [optional] |
|
|
9
|
+
| **group_by** | **String** | List of dimensions (comma-separated) being summed over in the results. | [optional] |
|
|
10
|
+
| **next_cursor** | **String** | Optional string that can be used to request the next page of results, if any. | [optional] |
|
|
11
|
+
| **limit** | **Integer** | The maximum number of results to return. Defaults to 1000. | [optional] |
|
|
12
|
+
|
|
13
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::BotRequestMetricsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<BotRequestMetricsDataItem>**](BotRequestMetricsDataItem.md) | An array of time series data items containing metric counts. Items are grouped by `timestamp` by default, or by a combination of `timestamp` and `bot` or `datacenter` or `region` when the `group_by` parameter is set. This dataset is sparse: only keys with non-zero values are included. | [optional] |
|
|
8
|
+
| **meta** | [**BotRequestMetricsMetadata**](BotRequestMetricsMetadata.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Fastly::BotRequestsMetricsApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::BotRequestsMetricsApi.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
|
+
[**get_bot_request_metrics_service_historical**](BotRequestsMetricsApi.md#get_bot_request_metrics_service_historical) | **GET** /metrics/bots/entities/{service_id}/{granularity} | Get per-service historical time series metrics for bot requests broken down by bot-type.
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
## `get_bot_request_metrics_service_historical()`
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
get_bot_request_metrics_service_historical(opts): <BotRequestMetricsResponse> # Get per-service historical time series metrics for bot requests broken down by bot-type.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Return historical time series metrics for bot requests broken down by bot-type.
|
|
26
|
+
|
|
27
|
+
### Examples
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
api_instance = Fastly::BotRequestsMetricsApi.new
|
|
31
|
+
opts = {
|
|
32
|
+
granularity: 'minutely', # String | Duration of sample windows.
|
|
33
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
34
|
+
from: '2025-06-08T00:00:00.000Z', # String | A valid RFC-8339-formatted date and time indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `granularity` value.
|
|
35
|
+
to: '2025-08-02T00:00:00.000Z', # String | A valid RFC-8339-formatted date and time indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `granularity` value.
|
|
36
|
+
group_by: 'datacenter', # String | Field to group by in the query. For example, `group_by=bot_id` will return entries grouped by `timestamp` and `bot_id`.
|
|
37
|
+
datacenter: 'SJC,STP', # String | Limit query to one or more specific POPs. Values should be comma-separated.
|
|
38
|
+
bot: 'bot_example', # String | Filter results based by Bot ID.
|
|
39
|
+
region: 'africa_std', # String | Limit query to one or more specific geographic regions. Values should be comma-separated.
|
|
40
|
+
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.
|
|
41
|
+
metric: 'status_4xx,status_5xx,ipv6,http3', # String | One or more metrics to retrieve. Multiple values should be comma-separated.
|
|
42
|
+
metric_set: 'content_guard', # String | The metric set to retrieve.
|
|
43
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 10000.
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
# Get per-service historical time series metrics for bot requests broken down by bot-type.
|
|
48
|
+
result = api_instance.get_bot_request_metrics_service_historical(opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue Fastly::ApiError => e
|
|
51
|
+
puts "Error when calling BotRequestsMetricsApi->get_bot_request_metrics_service_historical: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Options
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
| ---- | ---- | ----------- | ----- |
|
|
59
|
+
| **granularity** | **String** | Duration of sample windows. | |
|
|
60
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
61
|
+
| **from** | **String** | A valid RFC-8339-formatted date and time indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `granularity` value. | [optional] |
|
|
62
|
+
| **to** | **String** | A valid RFC-8339-formatted date and time indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `granularity` value. | [optional] |
|
|
63
|
+
| **group_by** | **String** | Field to group by in the query. For example, `group_by=bot_id` will return entries grouped by `timestamp` and `bot_id`. | [optional] |
|
|
64
|
+
| **datacenter** | **String** | Limit query to one or more specific POPs. Values should be comma-separated. | [optional] |
|
|
65
|
+
| **bot** | **String** | Filter results based by Bot ID. | [optional] |
|
|
66
|
+
| **region** | **String** | Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] |
|
|
67
|
+
| **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] |
|
|
68
|
+
| **metric** | **String** | One or more metrics to retrieve. Multiple values should be comma-separated. | [optional] |
|
|
69
|
+
| **metric_set** | **String** | The metric set to retrieve. | [optional] |
|
|
70
|
+
| **limit** | **String** | Number of results per page. The maximum is 10000. | [optional][default to '1000'] |
|
|
71
|
+
|
|
72
|
+
### Return type
|
|
73
|
+
|
|
74
|
+
[**BotRequestMetricsResponse**](BotRequestMetricsResponse.md)
|
|
75
|
+
|
|
76
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
77
|
+
[[Back to README]](../../README.md)
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **item_key** | **String** | Item key, maximum
|
|
7
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
8
8
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
9
9
|
| **op** | **String** | | [optional] |
|
|
10
10
|
|
data/docs/DdosProtectionRule.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
9
9
|
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
10
10
|
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
11
|
-
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
11
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off, client_challenge. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
12
12
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
13
13
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
14
14
|
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
8
8
|
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
9
|
-
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
9
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off, client_challenge. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
10
10
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
11
11
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
12
12
|
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
7
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off, client_challenge. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
8
8
|
|
|
9
9
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
10
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
9
9
|
| **id** | **String** | Unique ID of the rule. | [optional] |
|
|
10
10
|
| **name** | **String** | A human-readable name for the rule. | [optional] |
|
|
11
|
-
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
11
|
+
| **action** | **String** | Action types for a rule. Supported action values are default, block, log, off, client_challenge. The default action value follows the current protection mode of the associated service. | [optional][default to 'default'] |
|
|
12
12
|
| **customer_id** | **String** | Alphanumeric string identifying the customer. | [optional] |
|
|
13
13
|
| **service_id** | **String** | Alphanumeric string identifying the service. | [optional] |
|
|
14
14
|
| **source_ip** | **String** | Source IP address attribute. | [optional] |
|
data/docs/DictionaryItem.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **item_key** | **String** | Item key, maximum
|
|
7
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
8
8
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
9
9
|
|
|
10
10
|
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
data/docs/DictionaryItemApi.md
CHANGED
|
@@ -78,7 +78,7 @@ api_instance = Fastly::DictionaryItemApi.new
|
|
|
78
78
|
opts = {
|
|
79
79
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
80
80
|
dictionary_id: 'dictionary_id_example', # String | Alphanumeric string identifying a Dictionary.
|
|
81
|
-
item_key: 'item_key_example', # String | Item key, maximum
|
|
81
|
+
item_key: 'item_key_example', # String | Item key, maximum 255 characters.
|
|
82
82
|
item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
|
|
83
83
|
}
|
|
84
84
|
|
|
@@ -97,7 +97,7 @@ end
|
|
|
97
97
|
| ---- | ---- | ----------- | ----- |
|
|
98
98
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
99
99
|
| **dictionary_id** | **String** | Alphanumeric string identifying a Dictionary. | |
|
|
100
|
-
| **item_key** | **String** | Item key, maximum
|
|
100
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
101
101
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
102
102
|
|
|
103
103
|
### Return type
|
|
@@ -121,7 +121,7 @@ api_instance = Fastly::DictionaryItemApi.new
|
|
|
121
121
|
opts = {
|
|
122
122
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
123
123
|
dictionary_id: 'dictionary_id_example', # String | Alphanumeric string identifying a Dictionary.
|
|
124
|
-
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum
|
|
124
|
+
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum 255 characters.
|
|
125
125
|
}
|
|
126
126
|
|
|
127
127
|
begin
|
|
@@ -139,7 +139,7 @@ end
|
|
|
139
139
|
| ---- | ---- | ----------- | ----- |
|
|
140
140
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
141
141
|
| **dictionary_id** | **String** | Alphanumeric string identifying a Dictionary. | |
|
|
142
|
-
| **dictionary_item_key** | **String** | Item key, maximum
|
|
142
|
+
| **dictionary_item_key** | **String** | Item key, maximum 255 characters. | |
|
|
143
143
|
|
|
144
144
|
### Return type
|
|
145
145
|
|
|
@@ -162,7 +162,7 @@ api_instance = Fastly::DictionaryItemApi.new
|
|
|
162
162
|
opts = {
|
|
163
163
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
164
164
|
dictionary_id: 'dictionary_id_example', # String | Alphanumeric string identifying a Dictionary.
|
|
165
|
-
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum
|
|
165
|
+
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum 255 characters.
|
|
166
166
|
}
|
|
167
167
|
|
|
168
168
|
begin
|
|
@@ -180,7 +180,7 @@ end
|
|
|
180
180
|
| ---- | ---- | ----------- | ----- |
|
|
181
181
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
182
182
|
| **dictionary_id** | **String** | Alphanumeric string identifying a Dictionary. | |
|
|
183
|
-
| **dictionary_item_key** | **String** | Item key, maximum
|
|
183
|
+
| **dictionary_item_key** | **String** | Item key, maximum 255 characters. | |
|
|
184
184
|
|
|
185
185
|
### Return type
|
|
186
186
|
|
|
@@ -250,8 +250,8 @@ api_instance = Fastly::DictionaryItemApi.new
|
|
|
250
250
|
opts = {
|
|
251
251
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
252
252
|
dictionary_id: 'dictionary_id_example', # String | Alphanumeric string identifying a Dictionary.
|
|
253
|
-
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum
|
|
254
|
-
item_key: 'item_key_example', # String | Item key, maximum
|
|
253
|
+
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum 255 characters.
|
|
254
|
+
item_key: 'item_key_example', # String | Item key, maximum 255 characters.
|
|
255
255
|
item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
|
|
256
256
|
}
|
|
257
257
|
|
|
@@ -270,8 +270,8 @@ end
|
|
|
270
270
|
| ---- | ---- | ----------- | ----- |
|
|
271
271
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
272
272
|
| **dictionary_id** | **String** | Alphanumeric string identifying a Dictionary. | |
|
|
273
|
-
| **dictionary_item_key** | **String** | Item key, maximum
|
|
274
|
-
| **item_key** | **String** | Item key, maximum
|
|
273
|
+
| **dictionary_item_key** | **String** | Item key, maximum 255 characters. | |
|
|
274
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
275
275
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
276
276
|
|
|
277
277
|
### Return type
|
|
@@ -295,8 +295,8 @@ api_instance = Fastly::DictionaryItemApi.new
|
|
|
295
295
|
opts = {
|
|
296
296
|
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
|
297
297
|
dictionary_id: 'dictionary_id_example', # String | Alphanumeric string identifying a Dictionary.
|
|
298
|
-
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum
|
|
299
|
-
item_key: 'item_key_example', # String | Item key, maximum
|
|
298
|
+
dictionary_item_key: 'dictionary_item_key_example', # String | Item key, maximum 255 characters.
|
|
299
|
+
item_key: 'item_key_example', # String | Item key, maximum 255 characters.
|
|
300
300
|
item_value: 'item_value_example', # String | Item value, maximum 8000 characters.
|
|
301
301
|
}
|
|
302
302
|
|
|
@@ -315,8 +315,8 @@ end
|
|
|
315
315
|
| ---- | ---- | ----------- | ----- |
|
|
316
316
|
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
|
317
317
|
| **dictionary_id** | **String** | Alphanumeric string identifying a Dictionary. | |
|
|
318
|
-
| **dictionary_item_key** | **String** | Item key, maximum
|
|
319
|
-
| **item_key** | **String** | Item key, maximum
|
|
318
|
+
| **dictionary_item_key** | **String** | Item key, maximum 255 characters. | |
|
|
319
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
320
320
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
321
321
|
|
|
322
322
|
### Return type
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **item_key** | **String** | Item key, maximum
|
|
7
|
+
| **item_key** | **String** | Item key, maximum 255 characters. | [optional] |
|
|
8
8
|
| **item_value** | **String** | Item value, maximum 8000 characters. | [optional] |
|
|
9
9
|
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
|
10
10
|
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|