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
|
@@ -6,7 +6,11 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **name** | **String** | The name of the token. | [optional] |
|
|
8
8
|
| **role** | **String** | | [optional] |
|
|
9
|
-
| **
|
|
9
|
+
| **roles** | [**Array<AutomationTokenRole>**](AutomationTokenRole.md) | All roles assigned to the token. Each role includes an `id` and `name`. | [optional] |
|
|
10
|
+
| **services** | **Array<String>** | The service IDs of the services the token has access to. Empty when `limit_services` is `false` (full access) or when the token has no service access. | [optional] |
|
|
11
|
+
| **limit_services** | **Boolean** | When `true`, the token is restricted to only the services in the `services` array. When `false`, the token has access to all services. | [optional] |
|
|
12
|
+
| **limit_workspaces** | **Boolean** | When `true`, the token is restricted to only the workspaces in the `workspaces` array. When `false`, the token has access to all workspaces. Only applies to roles that support workspace access. | [optional] |
|
|
13
|
+
| **workspaces** | **Array<String>** | The workspace IDs of the workspaces the token has access to. Returns an empty array for tokens without workspace access. | [optional] |
|
|
10
14
|
| **scope** | **String** | A space-delimited list of authorization scope. | [optional][default to 'global'] |
|
|
11
15
|
| **expires_at** | **String** | (optional) A UTC timestamp of when the token will expire. | [optional] |
|
|
12
16
|
| **id** | [**ReadOnlyId**](ReadOnlyId.md) | | [optional] |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::AutomationTokenRole
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique identifier of the role. | [optional] |
|
|
8
|
+
| **name** | **String** | The name of the role. | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::AutomationTokenUnversionedError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | | [optional] |
|
|
8
|
+
| **detail** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::AutomationTokenUnversionedErrorResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **errors** | [**Array<AutomationTokenUnversionedError>**](AutomationTokenUnversionedError.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Fastly::AutomationTokenWorkspace
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier for the workspace. | |
|
|
8
|
+
| **name** | **String** | Human-readable workspace name. | |
|
|
9
|
+
|
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::AutomationTokenWorkspacesMeta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **limit** | **Integer** | Number of results requested. | |
|
|
8
|
+
| **next_cursor** | **String** | Cursor for the next page. Empty string when there are no more results. | [optional] |
|
|
9
|
+
| **previous_cursor** | **String** | Cursor for the previous page. Empty string when on the first page. | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::AutomationTokenWorkspacesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<AutomationTokenWorkspace>**](AutomationTokenWorkspace.md) | Workspaces the token can access. Empty if the token has no workspace-specific permissions or if `limit_workspaces` is `false` (unrestricted access). | |
|
|
8
|
+
| **meta** | [**AutomationTokenWorkspacesMeta**](AutomationTokenWorkspacesMeta.md) | | |
|
|
9
|
+
| **limit_workspaces** | **Boolean** | Indicates whether workspace access is restricted: - `true`: Token can only access workspaces listed in `data` - `false`: Token has unrestricted access to all workspaces | |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
data/docs/AutomationTokensApi.md
CHANGED
|
@@ -16,6 +16,7 @@ Method | HTTP request | Description
|
|
|
16
16
|
[**create_automation_token**](AutomationTokensApi.md#create_automation_token) | **POST** /automation-tokens | Create Automation Token
|
|
17
17
|
[**get_automation_token_id**](AutomationTokensApi.md#get_automation_token_id) | **GET** /automation-tokens/{id} | Retrieve an Automation Token by ID
|
|
18
18
|
[**get_automation_tokens_id_services**](AutomationTokensApi.md#get_automation_tokens_id_services) | **GET** /automation-tokens/{id}/services | List Automation Token Services
|
|
19
|
+
[**get_automation_tokens_id_workspaces**](AutomationTokensApi.md#get_automation_tokens_id_workspaces) | **GET** /automation-tokens/{id}/workspaces | List Automation Token Workspaces
|
|
19
20
|
[**list_automation_tokens**](AutomationTokensApi.md#list_automation_tokens) | **GET** /automation-tokens | List Customer Automation Tokens
|
|
20
21
|
[**revoke_automation_token_id**](AutomationTokensApi.md#revoke_automation_token_id) | **DELETE** /automation-tokens/{id} | Revoke an Automation Token by ID
|
|
21
22
|
|
|
@@ -33,7 +34,7 @@ Creates a new automation token.
|
|
|
33
34
|
```ruby
|
|
34
35
|
api_instance = Fastly::AutomationTokensApi.new
|
|
35
36
|
opts = {
|
|
36
|
-
automation_token_create_request: Fastly::AutomationTokenCreateRequest.new, # AutomationTokenCreateRequest |
|
|
37
|
+
automation_token_create_request: Fastly::AutomationTokenCreateRequest.new({name: 'name_example', expires_at: Time.now}), # AutomationTokenCreateRequest |
|
|
37
38
|
}
|
|
38
39
|
|
|
39
40
|
begin
|
|
@@ -133,6 +134,47 @@ end
|
|
|
133
134
|
|
|
134
135
|
[**InlineResponse2004**](InlineResponse2004.md)
|
|
135
136
|
|
|
137
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
138
|
+
[[Back to README]](../../README.md)
|
|
139
|
+
## `get_automation_tokens_id_workspaces()`
|
|
140
|
+
|
|
141
|
+
```ruby
|
|
142
|
+
get_automation_tokens_id_workspaces(opts): <AutomationTokenWorkspacesResponse> # List Automation Token Workspaces
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Lists the Next-Gen WAF workspaces accessible by an automation token. Only applicable for tokens with roles that support workspace access (such as Next-Gen WAF roles).
|
|
146
|
+
|
|
147
|
+
### Examples
|
|
148
|
+
|
|
149
|
+
```ruby
|
|
150
|
+
api_instance = Fastly::AutomationTokensApi.new
|
|
151
|
+
opts = {
|
|
152
|
+
id: 'id_example', # String | The alphanumeric string identifying the automation token.
|
|
153
|
+
limit: 56, # Integer | Maximum number of workspaces to return per page.
|
|
154
|
+
cursor: 'cursor_example', # String | Pagination cursor from a previous response. Pass the `next_cursor` value to retrieve the next page, or `previous_cursor` to go back.
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
begin
|
|
158
|
+
# List Automation Token Workspaces
|
|
159
|
+
result = api_instance.get_automation_tokens_id_workspaces(opts)
|
|
160
|
+
p result
|
|
161
|
+
rescue Fastly::ApiError => e
|
|
162
|
+
puts "Error when calling AutomationTokensApi->get_automation_tokens_id_workspaces: #{e}"
|
|
163
|
+
end
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Options
|
|
167
|
+
|
|
168
|
+
| Name | Type | Description | Notes |
|
|
169
|
+
| ---- | ---- | ----------- | ----- |
|
|
170
|
+
| **id** | **String** | The alphanumeric string identifying the automation token. | |
|
|
171
|
+
| **limit** | **Integer** | Maximum number of workspaces to return per page. | [optional][default to 20] |
|
|
172
|
+
| **cursor** | **String** | Pagination cursor from a previous response. Pass the `next_cursor` value to retrieve the next page, or `previous_cursor` to go back. | [optional] |
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
[**AutomationTokenWorkspacesResponse**](AutomationTokenWorkspacesResponse.md)
|
|
177
|
+
|
|
136
178
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
137
179
|
[[Back to README]](../../README.md)
|
|
138
180
|
## `list_automation_tokens()`
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::BotManagementAction
|
|
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,433 @@
|
|
|
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_workspace**](BotManagementApi.md#bot_management_update_workspace) | **PATCH** /bot-management/v1/workspaces/{workspace_id} | Update a workspace
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## `bot_management_get_bot()`
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
bot_management_get_bot(opts): <BotManagementBotResponse> # Get a bot
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Get the attributes of a bot in a category.
|
|
35
|
+
|
|
36
|
+
### Examples
|
|
37
|
+
|
|
38
|
+
```ruby
|
|
39
|
+
api_instance = Fastly::BotManagementApi.new
|
|
40
|
+
opts = {
|
|
41
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
42
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
43
|
+
bot_id: 'gptbot', # String | The ID of the bot.
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
# Get a bot
|
|
48
|
+
result = api_instance.bot_management_get_bot(opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue Fastly::ApiError => e
|
|
51
|
+
puts "Error when calling BotManagementApi->bot_management_get_bot: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Options
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
| ---- | ---- | ----------- | ----- |
|
|
59
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
60
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
61
|
+
| **bot_id** | **String** | The ID of the bot. | |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
[**BotManagementBotResponse**](BotManagementBotResponse.md)
|
|
66
|
+
|
|
67
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
68
|
+
[[Back to README]](../../README.md)
|
|
69
|
+
## `bot_management_get_category()`
|
|
70
|
+
|
|
71
|
+
```ruby
|
|
72
|
+
bot_management_get_category(opts): <BotManagementCategoryResponse> # Get a category
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Get the attributes of a bot category.
|
|
76
|
+
|
|
77
|
+
### Examples
|
|
78
|
+
|
|
79
|
+
```ruby
|
|
80
|
+
api_instance = Fastly::BotManagementApi.new
|
|
81
|
+
opts = {
|
|
82
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
83
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
begin
|
|
87
|
+
# Get a category
|
|
88
|
+
result = api_instance.bot_management_get_category(opts)
|
|
89
|
+
p result
|
|
90
|
+
rescue Fastly::ApiError => e
|
|
91
|
+
puts "Error when calling BotManagementApi->bot_management_get_category: #{e}"
|
|
92
|
+
end
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Options
|
|
96
|
+
|
|
97
|
+
| Name | Type | Description | Notes |
|
|
98
|
+
| ---- | ---- | ----------- | ----- |
|
|
99
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
100
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**BotManagementCategoryResponse**](BotManagementCategoryResponse.md)
|
|
105
|
+
|
|
106
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
107
|
+
[[Back to README]](../../README.md)
|
|
108
|
+
## `bot_management_get_workspace()`
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
bot_management_get_workspace(opts): <BotManagementWorkspaceResponse> # Get a workspace
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Retrieve a bot management workspace.
|
|
115
|
+
|
|
116
|
+
### Examples
|
|
117
|
+
|
|
118
|
+
```ruby
|
|
119
|
+
api_instance = Fastly::BotManagementApi.new
|
|
120
|
+
opts = {
|
|
121
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
begin
|
|
125
|
+
# Get a workspace
|
|
126
|
+
result = api_instance.bot_management_get_workspace(opts)
|
|
127
|
+
p result
|
|
128
|
+
rescue Fastly::ApiError => e
|
|
129
|
+
puts "Error when calling BotManagementApi->bot_management_get_workspace: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Options
|
|
134
|
+
|
|
135
|
+
| Name | Type | Description | Notes |
|
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
|
137
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**BotManagementWorkspaceResponse**](BotManagementWorkspaceResponse.md)
|
|
142
|
+
|
|
143
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
144
|
+
[[Back to README]](../../README.md)
|
|
145
|
+
## `bot_management_list_bots()`
|
|
146
|
+
|
|
147
|
+
```ruby
|
|
148
|
+
bot_management_list_bots(opts): <BotManagementWorkspaceBotsResponse> # List all bots in a workspace
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
List all bots in a workspace's policy across all categories.
|
|
152
|
+
|
|
153
|
+
### Examples
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
api_instance = Fastly::BotManagementApi.new
|
|
157
|
+
opts = {
|
|
158
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
159
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
160
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
begin
|
|
164
|
+
# List all bots in a workspace
|
|
165
|
+
result = api_instance.bot_management_list_bots(opts)
|
|
166
|
+
p result
|
|
167
|
+
rescue Fastly::ApiError => e
|
|
168
|
+
puts "Error when calling BotManagementApi->bot_management_list_bots: #{e}"
|
|
169
|
+
end
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Options
|
|
173
|
+
|
|
174
|
+
| Name | Type | Description | Notes |
|
|
175
|
+
| ---- | ---- | ----------- | ----- |
|
|
176
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
177
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
178
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
[**BotManagementWorkspaceBotsResponse**](BotManagementWorkspaceBotsResponse.md)
|
|
183
|
+
|
|
184
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
185
|
+
[[Back to README]](../../README.md)
|
|
186
|
+
## `bot_management_list_categories()`
|
|
187
|
+
|
|
188
|
+
```ruby
|
|
189
|
+
bot_management_list_categories(opts): <BotManagementCategoriesResponse> # List categories
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
List all bot categories in a workspace's policy. Each category has an action that applies to every bot in the category. 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).
|
|
193
|
+
|
|
194
|
+
### Examples
|
|
195
|
+
|
|
196
|
+
```ruby
|
|
197
|
+
api_instance = Fastly::BotManagementApi.new
|
|
198
|
+
opts = {
|
|
199
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
200
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
201
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
begin
|
|
205
|
+
# List categories
|
|
206
|
+
result = api_instance.bot_management_list_categories(opts)
|
|
207
|
+
p result
|
|
208
|
+
rescue Fastly::ApiError => e
|
|
209
|
+
puts "Error when calling BotManagementApi->bot_management_list_categories: #{e}"
|
|
210
|
+
end
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Options
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
|
217
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
218
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
219
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**BotManagementCategoriesResponse**](BotManagementCategoriesResponse.md)
|
|
224
|
+
|
|
225
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
226
|
+
[[Back to README]](../../README.md)
|
|
227
|
+
## `bot_management_list_category_bots()`
|
|
228
|
+
|
|
229
|
+
```ruby
|
|
230
|
+
bot_management_list_category_bots(opts): <BotManagementBotsResponse> # List bots in a category
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
List all bots in a bot category.
|
|
234
|
+
|
|
235
|
+
### Examples
|
|
236
|
+
|
|
237
|
+
```ruby
|
|
238
|
+
api_instance = Fastly::BotManagementApi.new
|
|
239
|
+
opts = {
|
|
240
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
241
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
242
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
243
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
begin
|
|
247
|
+
# List bots in a category
|
|
248
|
+
result = api_instance.bot_management_list_category_bots(opts)
|
|
249
|
+
p result
|
|
250
|
+
rescue Fastly::ApiError => e
|
|
251
|
+
puts "Error when calling BotManagementApi->bot_management_list_category_bots: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Options
|
|
256
|
+
|
|
257
|
+
| Name | Type | Description | Notes |
|
|
258
|
+
| ---- | ---- | ----------- | ----- |
|
|
259
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
260
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
261
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
262
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
263
|
+
|
|
264
|
+
### Return type
|
|
265
|
+
|
|
266
|
+
[**BotManagementBotsResponse**](BotManagementBotsResponse.md)
|
|
267
|
+
|
|
268
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
269
|
+
[[Back to README]](../../README.md)
|
|
270
|
+
## `bot_management_list_workspaces()`
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
bot_management_list_workspaces(opts): <BotManagementWorkspacesResponse> # List workspaces
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
List bot management workspaces.
|
|
277
|
+
|
|
278
|
+
### Examples
|
|
279
|
+
|
|
280
|
+
```ruby
|
|
281
|
+
api_instance = Fastly::BotManagementApi.new
|
|
282
|
+
opts = {
|
|
283
|
+
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.
|
|
284
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
285
|
+
cursor: 'MTAwOjA', # String | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results.
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
begin
|
|
289
|
+
# List workspaces
|
|
290
|
+
result = api_instance.bot_management_list_workspaces(opts)
|
|
291
|
+
p result
|
|
292
|
+
rescue Fastly::ApiError => e
|
|
293
|
+
puts "Error when calling BotManagementApi->bot_management_list_workspaces: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Options
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **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] |
|
|
302
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
303
|
+
| **cursor** | **String** | Cursor for pagination. Use the `next_cursor` value from a previous response to request the next page of results. | [optional] |
|
|
304
|
+
|
|
305
|
+
### Return type
|
|
306
|
+
|
|
307
|
+
[**BotManagementWorkspacesResponse**](BotManagementWorkspacesResponse.md)
|
|
308
|
+
|
|
309
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
310
|
+
[[Back to README]](../../README.md)
|
|
311
|
+
## `bot_management_update_bot()`
|
|
312
|
+
|
|
313
|
+
```ruby
|
|
314
|
+
bot_management_update_bot(opts): <BotManagementBotResponse> # Set a bot action
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
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.
|
|
318
|
+
|
|
319
|
+
### Examples
|
|
320
|
+
|
|
321
|
+
```ruby
|
|
322
|
+
api_instance = Fastly::BotManagementApi.new
|
|
323
|
+
opts = {
|
|
324
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
325
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
326
|
+
bot_id: 'gptbot', # String | The ID of the bot.
|
|
327
|
+
bot_management_bot: Fastly::BotManagementBot.new({action: Fastly::BotManagementBotAction.new({type: 'allow'})}), # BotManagementBot |
|
|
328
|
+
}
|
|
329
|
+
|
|
330
|
+
begin
|
|
331
|
+
# Set a bot action
|
|
332
|
+
result = api_instance.bot_management_update_bot(opts)
|
|
333
|
+
p result
|
|
334
|
+
rescue Fastly::ApiError => e
|
|
335
|
+
puts "Error when calling BotManagementApi->bot_management_update_bot: #{e}"
|
|
336
|
+
end
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Options
|
|
340
|
+
|
|
341
|
+
| Name | Type | Description | Notes |
|
|
342
|
+
| ---- | ---- | ----------- | ----- |
|
|
343
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
344
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
345
|
+
| **bot_id** | **String** | The ID of the bot. | |
|
|
346
|
+
| **bot_management_bot** | [**BotManagementBot**](BotManagementBot.md) | | |
|
|
347
|
+
|
|
348
|
+
### Return type
|
|
349
|
+
|
|
350
|
+
[**BotManagementBotResponse**](BotManagementBotResponse.md)
|
|
351
|
+
|
|
352
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
353
|
+
[[Back to README]](../../README.md)
|
|
354
|
+
## `bot_management_update_category()`
|
|
355
|
+
|
|
356
|
+
```ruby
|
|
357
|
+
bot_management_update_category(opts): <BotManagementCategoryResponse> # Set a category action
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
Set the action for a bot category. Every bot in the category configured with the 'inherit' action uses the action set for the category.
|
|
361
|
+
|
|
362
|
+
### Examples
|
|
363
|
+
|
|
364
|
+
```ruby
|
|
365
|
+
api_instance = Fastly::BotManagementApi.new
|
|
366
|
+
opts = {
|
|
367
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
368
|
+
category_id: 'ai_crawlers', # String | The ID of the bot category.
|
|
369
|
+
bot_management_category: Fastly::BotManagementCategory.new({action: Fastly::BotManagementAction.new({type: 'allow'})}), # BotManagementCategory |
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
begin
|
|
373
|
+
# Set a category action
|
|
374
|
+
result = api_instance.bot_management_update_category(opts)
|
|
375
|
+
p result
|
|
376
|
+
rescue Fastly::ApiError => e
|
|
377
|
+
puts "Error when calling BotManagementApi->bot_management_update_category: #{e}"
|
|
378
|
+
end
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
### Options
|
|
382
|
+
|
|
383
|
+
| Name | Type | Description | Notes |
|
|
384
|
+
| ---- | ---- | ----------- | ----- |
|
|
385
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
386
|
+
| **category_id** | **String** | The ID of the bot category. | |
|
|
387
|
+
| **bot_management_category** | [**BotManagementCategory**](BotManagementCategory.md) | | |
|
|
388
|
+
|
|
389
|
+
### Return type
|
|
390
|
+
|
|
391
|
+
[**BotManagementCategoryResponse**](BotManagementCategoryResponse.md)
|
|
392
|
+
|
|
393
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
394
|
+
[[Back to README]](../../README.md)
|
|
395
|
+
## `bot_management_update_workspace()`
|
|
396
|
+
|
|
397
|
+
```ruby
|
|
398
|
+
bot_management_update_workspace(opts): <BotManagementWorkspaceResponse> # Update a workspace
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
Update the attributes of a bot management workspace.
|
|
402
|
+
|
|
403
|
+
### Examples
|
|
404
|
+
|
|
405
|
+
```ruby
|
|
406
|
+
api_instance = Fastly::BotManagementApi.new
|
|
407
|
+
opts = {
|
|
408
|
+
workspace_id: 'SU1Z0isxPaozGVKXdv0eY', # String | The ID of the bot management workspace.
|
|
409
|
+
bot_management_workspace: Fastly::BotManagementWorkspace.new, # BotManagementWorkspace |
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
begin
|
|
413
|
+
# Update a workspace
|
|
414
|
+
result = api_instance.bot_management_update_workspace(opts)
|
|
415
|
+
p result
|
|
416
|
+
rescue Fastly::ApiError => e
|
|
417
|
+
puts "Error when calling BotManagementApi->bot_management_update_workspace: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Options
|
|
422
|
+
|
|
423
|
+
| Name | Type | Description | Notes |
|
|
424
|
+
| ---- | ---- | ----------- | ----- |
|
|
425
|
+
| **workspace_id** | **String** | The ID of the bot management workspace. | |
|
|
426
|
+
| **bot_management_workspace** | [**BotManagementWorkspace**](BotManagementWorkspace.md) | | |
|
|
427
|
+
|
|
428
|
+
### Return type
|
|
429
|
+
|
|
430
|
+
[**BotManagementWorkspaceResponse**](BotManagementWorkspaceResponse.md)
|
|
431
|
+
|
|
432
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
433
|
+
[[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
|
+
|