@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0212.public.ves.io.schema.shape.bot_defense.reporting.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.reporting","description":"Use this API to generate reports for Shape Bot Defense","version":""},"paths":{"/api/shape/bot/namespaces/system/reporting/peers/check":{"post":{"summary":"Check Peer Status","description":"\nCheck if the tenant has the peer or not","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeerStatusCheck","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerStatusRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-peerstatuscheck"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeerStatusCheck"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/atb":{"get":{"summary":"ATB Status","description":"ATB Status","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATBStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingATBResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"virtual_host","description":"x-required\nx-example: \"myapp-vh-1\"\nName of Virtual Host to scope traffic overview query","in":"query","required":false,"x-displayname":"Virtual Host Name","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-atbstatus"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATBStatus"},"post":{"summary":"ATB","description":"Enable/disable ATB","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATB","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingATBResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingATBRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-atb"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATB"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/consumption/summary":{"get":{"summary":"Consumption Summary","description":"Get Consumption summary","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ConsumptionSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingConsumptionSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic usage query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"start","description":"x-example: \"2022-08\" or \"2022-08-01\"\nThe start date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD","in":"query","required":false,"x-displayname":"Start Date (YYYY-MM or YYYY-MM-DD)","schema":{"type":"string"}},{"name":"end","description":"x-example: \"2022-09\" or \"2022-09-30\"\nThe end date of the query period. \nFormat: YYYY-MM or YYYY-MM-DD","in":"query","required":false,"x-displayname":"End Date (YYYY-MM or YYYY-MM-DD)","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-consumptionsummary"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ConsumptionSummary"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories":{"post":{"summary":"Endpoint Categories","description":"Get Endpoint Category Breakdown","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategories","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingEndpointCategoryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-endpointcategories"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategories"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories/{category}":{"post":{"summary":"Endpoint Categories Label","description":"Get Endpoint Category Breakdown","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategoriesLabel","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingEndpointCategoryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"category","description":"Category\n\n\nx-example: \"Login\"\nendpoint category label.","in":"path","required":true,"x-displayname":"Category","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-endpointcategorieslabel"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategoriesLabel"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/endpoint/list":{"post":{"summary":"All Protected Endpoints","description":"Get All Protected Endpoints","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointList","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingEndpointListResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewExpandedRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-endpointlist"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointList"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/endpoint/summary":{"post":{"summary":"Endpoint Summary","description":"Get Endpoint Summary","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingEndpointSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-endpointsummary"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummary"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/endpoints":{"post":{"summary":"Report Endpoints","description":"Report Endpoints","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ReportEndpoints","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingReportEndpointsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-reportendpoints"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ReportEndpoints"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/insight/credential-stuffing-attack":{"post":{"summary":"Insight Event: Credential Stuffing Attack","description":"Get Insight Credential Stuffing Attack","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.CredentialStuffingAttack","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingCredentialStuffingAttackResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingInsightRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-credentialstuffingattack"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.CredentialStuffingAttack"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/insight/event/bad-bot-reduction":{"post":{"summary":"Insight Bad Bot Reduction","description":"Insight Bad Bot Reduction","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightBadBotReduction","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingInsightBadBotReductionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingInsightRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-insightbadbotreduction"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightBadBotReduction"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/insight/event/unaddressed-automations":{"post":{"summary":"Insight Unaddressed Automations","description":"Insight Unaddressed Automations","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightUnaddressedAutomations","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingInsightUnaddressedAutomationsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingInsightRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-insightunaddressedautomations"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightUnaddressedAutomations"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/insight/personal-stats":{"post":{"summary":"Insight Personal Stats","description":"Insight Personal Stats","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightPersonalStats","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingInsightPersonalStatsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingInsightRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-insightpersonalstats"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightPersonalStats"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/insight/total-automation":{"post":{"summary":"Insight Event: Total Automation","description":"Get Insight Totol Automation data","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TotalAutomation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTotalAutomationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"default\"\nNamespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingInsightRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-totalautomation"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TotalAutomation"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/endpoints":{"post":{"summary":"Malicious Report Endpoints","description":"Malicious Report Endpoints","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpoints","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportEndpointsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreportendpoints"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpoints"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/asn":{"post":{"summary":"Malicious Report Transactions ASN","description":"Malicious Report Transactions ASN","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASN","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsasn"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASN"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/browser":{"post":{"summary":"Malicious Report Transactions Browser","description":"Malicious Report Transactions Browser","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowser","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsbrowser"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowser"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ip":{"post":{"summary":"Malicious Report Transactions IP","description":"Malicious Report Transactions IP","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsip"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIP"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/os":{"post":{"summary":"Malicious Report Transactions OS","description":"Malicious Report Transactions OS","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOS","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsos"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOS"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ua":{"post":{"summary":"Malicious Report Transactions UA","description":"Malicious Report Transactions UA","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUA","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsua"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUA"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/endpoints":{"post":{"summary":"Top Attacked Endpoints","description":"Get top attacked application endpoints","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpoints","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedEndpointsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedendpoints"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpoints"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview":{"post":{"summary":"Top Latency Overview","description":"Get top latency overview","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverview","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopLatencyOverviewResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-toplatencyoverview"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverview"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview/apps":{"post":{"summary":"Top Latency Overview Apps","description":"Get top latency overview apps","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverviewApps","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopLatencyOverviewAppsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-toplatencyoverviewapps"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverviewApps"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/asorg":{"post":{"summary":"Top Malicious Bots by ASOrg","description":"Get top malicious bots by AS Organization","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrg","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByASOrgResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyasorg"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrg"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/automation":{"post":{"summary":"Top Malicious Bot Automation Types","description":"Get top malicious bots automation types","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAutomationTypesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topautomationtypes"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypes"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ip":{"post":{"summary":"Top Malicious Bots by IP address","description":"Get Top Malicious Bots by source IP address","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByIPResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyip"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIP"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ua":{"post":{"summary":"Top Malicious Bots by User Agent String","description":"Get top malicious bots by user agent string","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUA","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByUAResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyua"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUA"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/app":{"post":{"summary":"Top Transactions by Application","description":"Get Top Transactions by Application","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopTransactionsByApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopTransactionsByAppResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-toptransactionsbyapp"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopTransactionsByApp"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/categories":{"post":{"summary":"Top Categories","description":"Get top flow label categories","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopCategories","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopCategoriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topcategories"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopCategories"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/endpointlabels":{"post":{"summary":"Top Endpoint Labels","description":"Get top Endpoint labels","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopEndpointLabels","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopEndpointLabelsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topendpointlabels"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopEndpointLabels"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/good":{"post":{"summary":"Top Good Bots","description":"Get top good bots","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBots","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopGoodBotsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topgoodbots"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBots"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/browser":{"post":{"summary":"Top Human Browser","description":"Get top human browser","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowser","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanBrowserResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumanbrowser"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowser"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/device":{"post":{"summary":"Top Human Device","description":"Get top human device","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDevice","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanDeviceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumandevice"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDevice"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/geolocation":{"post":{"summary":"Top Human Geolocation","description":"Get top human geolocation","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanGeolocationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumangeolocation"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocation"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/platform":{"post":{"summary":"Top Human Platform","description":"Get top human platform","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatform","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanPlatformResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumanplatform"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatform"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/app":{"post":{"summary":"Top Malicious Bots by Application","description":"Get Top Malicious Bots by Application","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByApp","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByAppResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyapp"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByApp"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/apps/timeseries":{"post":{"summary":"Malicious Report APP Time Series","description":"Malicious Report APP Time Series","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportAPPTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreportapptimeseries"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeries"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg":{"post":{"summary":"Top Malicious Bots by ASOrg v2","description":"Get top malicious bots by AS Organization v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByASOrgResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyasorgv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg/{attack_type}":{"post":{"summary":"Top ASN of Attack Intent","description":"Get Top Malicious Bot Event by ASN of Attack Intent Type","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrg","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByASOrgResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyasorg"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrg"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/attackintent":{"post":{"summary":"Top Malicious Bots by Attack Intent","description":"Top Malicious Bots by Attack Intent","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackIntentResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotbyattackintent"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntent"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/automation":{"post":{"summary":"Top Malicious Bot Automation Types v2","description":"Get top malicious bots automation types v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAutomationTypesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topautomationtypesv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/bfp":{"post":{"summary":"Top Attacked BFP","description":"Top Attacked BFP","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedBFP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedBFPResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedbfp"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedBFP"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/endpoints":{"post":{"summary":"Top Attacked Endpoints v2","description":"Get top attacked application endpoints v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedEndpointsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedendpointsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip":{"post":{"summary":"Top Malicious Bots by IP address v2","description":"Get Top Malicious Bots by source IP address v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByIPResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyipv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip/{attack_type}":{"post":{"summary":"Top Souce IP of Attack Intent","description":"Get Top Malicious Bot Event by Source IP of Attack Intent Type","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIP","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByIPResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyip"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIP"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua":{"post":{"summary":"Top Malicious Bots by User Agent String v2","description":"Get top malicious bots by user agent string v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByUAResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyuav2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua/{attack_type}":{"post":{"summary":"Top User Agent of Attack Intent","description":"Get Top Malicious Bot Event by UA of Attack Intent Type","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUA","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByUAResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyua"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUA"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/attackintent/timeseries":{"post":{"summary":"Attack Intent Time Series For All Traffic","description":"Attack Intent Time Series For All Traffic","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.AttackIntentTimeSeries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingAttackIntentTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-attackintenttimeseries"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.AttackIntentTimeSeries"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/categories/timeseries":{"post":{"summary":"Categories Time Series For All Traffic","description":"Categories Time Series For All Traffic\nGet TimeSeries data list for all traffic breaking down by endpoint category","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.CategoriesTimeSeries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingCategoriesTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-categoriestimeseries"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.CategoriesTimeSeries"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/dimension/attackintent/timeseries":{"post":{"summary":"Malicious Bot Attack Intent Time Series","description":"Malicious Bot Attack Intent Time Series","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingAttackIntentTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousattackintenttimeseries"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeries"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/actions":{"post":{"summary":"Malicious Traffic Overview in actions","description":"Get Malicious Traffic Overview in Actions","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficOverviewActionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustrafficoverviewactions"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActions"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/metrics":{"post":{"summary":"Malicious Traffic Overview Metrics","description":"Malicious Traffic Overview Metrics","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetrics","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficOverviewMetricsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustrafficoverviewmetrics"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetrics"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/timeseries/actions":{"post":{"summary":"Malicious Traffic Overview Timeseries in Actions","description":"Get Malicious Traffic Overview Timeseries in Actions","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficTimeseriesActionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustraffictimeseriesactions"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActions"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview":{"post":{"summary":"Traffic Overview","description":"Get traffic overview","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverview","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverview"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverview"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/expanded":{"post":{"summary":"Expanded Traffic Overview","description":"Get expanded traffic overview","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpanded","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewExpandedRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewexpanded"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpanded"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/timeseries":{"post":{"summary":"Traffic Overview Timeseries","description":"Get Traffic Overview Timeseries","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseries","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewtimeseries"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseries"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/reporting/usage/summary":{"get":{"summary":"Usage Summary","description":"Get transactions usage summary","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TransactionUsageSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTransactionUsageSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic usage query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"start","description":"x-example: \"2022-08\" or \"2022-08-01\"\nThe start date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD","in":"query","required":false,"x-displayname":"Start Date (YYYY-MM or YYYY-MM-DD)","schema":{"type":"string"}},{"name":"end","description":"x-example: \"2022-09\" or \"2022-09-30\"\nThe end date of the query period. \nFormat: YYYY-MM or YYYY-MM-DD","in":"query","required":false,"x-displayname":"End Date (YYYY-MM or YYYY-MM-DD)","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-transactionusagesummary"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TransactionUsageSummary"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v1/reporting/forensic/fields":{"post":{"summary":"Forensic Fields","description":"Get","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ForensicFields","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingForensicFieldsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"namespace1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingForensicFieldsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-forensicfields"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.ForensicFields"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/automated/overview/actions":{"post":{"summary":"Automated Traffic Overview in actions","description":"Get All Automated Traffic Actions","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.AutomatedTrafficActions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingAutomatedTrafficActionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-automatedtrafficactions"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.AutomatedTrafficActions"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/endpoint/summary":{"post":{"summary":"Endpoint Summary V2","description":"Get Endpoint Summary V2 with Unevaluated Transactions","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummaryV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingEndpointSummaryResponseV2"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-endpointsummaryv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummaryV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/endpoints":{"post":{"summary":"Malicious Report Endpoints V2","description":"Malicious Report Endpoints V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpointsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportEndpointsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreportendpointsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpointsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/asn":{"post":{"summary":"Malicious Report Transactions ASN V2","description":"Malicious Report Transactions ASN V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASNV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsasnv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASNV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/browser":{"post":{"summary":"Malicious Report Transactions Browser V2","description":"Malicious Report Transactions Browser V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowserV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsbrowserv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowserV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ip":{"post":{"summary":"Malicious Report Transactions IP V2","description":"Malicious Report Transactions IP V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIPV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsipv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIPV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/os":{"post":{"summary":"Malicious Report Transactions OS V2","description":"Malicious Report Transactions OS V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOSV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsosv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOSV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ua":{"post":{"summary":"Malicious Report Transactions UA V2","description":"Malicious Report Transactions UA V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUAV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreporttransactionsuav2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUAV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/good":{"post":{"summary":"Top Good Bots V2","description":"Get top good bots V2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopGoodBotsResponseV2"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topgoodbotsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/browser":{"post":{"summary":"Top Human Browser V2","description":"Get top human browser v2 with sub-categories","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowserV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanBrowserResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumanbrowserv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowserV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/device":{"post":{"summary":"Top Human Device V2","description":"Get top human device v2 with sub-categories","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDeviceV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanDeviceResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumandevicev2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDeviceV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/geolocation":{"post":{"summary":"Top Human Geolocation V2","description":"Get top human geolocation v2 with sub-categories","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocationV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanGeolocationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumangeolocationv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocationV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/platform":{"post":{"summary":"Top Human Platform V2","description":"Get top human platform v2 with sub-categories","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatformV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopHumanPlatformResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-tophumanplatformv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatformV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/apps/timeseries":{"post":{"summary":"Malicious Report APP Time Series V2","description":"Malicious Report APP Time Series V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeriesV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousReportAPPTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousreportapptimeseriesv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeriesV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/asorg/{attack_type}":{"post":{"summary":"Top ASN of Attack Intent V2","description":"Get Top Malicious Bot Event by ASN of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrgV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByASOrgResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyasorgv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrgV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/attackintent":{"post":{"summary":"Top Malicious Bots by Attack Intent V2","description":"Top Malicious Bots by Attack Intent V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntentV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackIntentResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotbyattackintentv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntentV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/endpoints":{"post":{"summary":"Top Attacked Endpoints v3","description":"Get top attacked application endpoints v3","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedEndpointsResponseV2"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedendpointsv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ip/{attack_type}":{"post":{"summary":"Top Souce IP of Attack Intent V2","description":"Get Top Malicious Bot Event by Source IP of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIPV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByIPResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyipv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIPV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ua/{attack_type}":{"post":{"summary":"Top User Agent of Attack Intent V2","description":"Get Top Malicious Bot Event by UA of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUAV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsAttackIntentByUAResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"attack_type","description":"Attack Intent Type\n\n\nx-example: \"AccountCreation\"\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3","in":"path","required":true,"x-displayname":"Attack Intent Type","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequestAttackIntent"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsattackintentbyuav2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUAV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/dimension/attackintent/timeseries":{"post":{"summary":"Malicious Bot Attack Intent Time Series V2","description":"Malicious Bot Attack Intent Time Series V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeriesV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingAttackIntentTimeSeriesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-maliciousattackintenttimeseriesv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeriesV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/actions":{"post":{"summary":"Malicious Traffic Overview in actions V2","description":"Get Malicious Traffic Overview in Actions","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActionsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficOverviewActionsV2Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustrafficoverviewactionsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActionsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/metrics":{"post":{"summary":"Malicious Traffic Overview Metrics V2","description":"Malicious Traffic Overview Metrics V2, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetricsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficOverviewMetricsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustrafficoverviewmetricsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetricsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/timeseries/actions":{"post":{"summary":"Malicious Traffic Overview Timeseries in Actions V2","description":"Get Malicious Traffic Overview Timeseries in Actions\nGet the malicious traffic action details like Blocked, Challenged, Flagged, Redirected, Transformed, Undefined, etc.\nover a chosen period. It can cater to the need to support dynamic malicious traffic action types,\nunlike supporting fixed action types in v1.","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActionsV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingMaliciousTrafficTimeseriesActionsResponseV2"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-malicioustraffictimeseriesactionsv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActionsV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview":{"post":{"summary":"Traffic Overview V2","description":"Get traffic overview v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewV2Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/expanded":{"post":{"summary":"Expanded Traffic Overview V2","description":"Get expanded traffic overview v2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewExpandedRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewexpandedv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/timeseries":{"post":{"summary":"Traffic Overview Timeseries V2","description":"Get Traffic Overview Timeseries V2","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesV2Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewtimeseriesv2"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV2"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/good":{"post":{"summary":"Top Good Bots V3","description":"Get top good bots V3, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopGoodBotsResponseV2"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topgoodbotsv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/asorg":{"post":{"summary":"Top Malicious Bots by ASOrg v3","description":"Get top malicious bots by AS Organization v3, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByASOrgResponseV3"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyasorgv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/automation":{"post":{"summary":"Top Malicious Bot Automation Types v3","description":"Get top malicious bots automation types v3, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAutomationTypesResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topautomationtypesv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ip":{"post":{"summary":"Top Malicious Bots by IP address v3","description":"Get Top Malicious Bots by source IP address v3, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByIPResponseV3"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyipv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ua":{"post":{"summary":"Top Malicious Bots by User Agent String v3","description":"Get top malicious bots by user agent string v3","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByUAResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyuav3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview":{"post":{"summary":"Traffic Overview V3","description":"Get traffic overview v3, v3response uses a dynamic structure and has traffic types of human, good bot, bad bot, trusted, untrusted and interstitual, also removed the percentage","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewV3Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/expanded":{"post":{"summary":"Expanded Traffic Overview V3","description":"Get expanded traffic overview v3","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewExpandedRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewexpandedv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/timeseries":{"post":{"summary":"Traffic Overview Timeseries V3","description":"Get the traffic count details based on types like \"Humans, Automated, Allow listed, etc. over a chosen period.\nIt can cater to the need to support dynamic traffic types, unlike supporting fixed types in v1 or v2.","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV3","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesV3Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewtimeseriesv3"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV3"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/endpoints":{"post":{"summary":"Top Attacked Endpoints v4","description":"Get top attacked application endpoints v4","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV4","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedEndpointsResponseV4"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedendpointsv4"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV4"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/ua":{"post":{"summary":"Top Malicious Bots by User Agent String v4","description":"Get top malicious bots by user agent string v4, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV4","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopMaliciousBotsByUAResponseV4"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topmaliciousbotsbyuav4"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV4"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/expanded":{"post":{"summary":"Expanded Traffic Overview in Traffic Analyzer","description":"Get expanded Traffic overview in Traffic Analyzer. This version adds support for traffic types, and its subtypes,\naction taken. In addition, it will show additional traffic types for advanced customers.","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV4","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTrafficOverviewExpandedRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewexpandedv4"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV4"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/timeseries":{"post":{"summary":"Traffic Overview Timeseries V4","description":"Get the traffic count details based on types like Humans, Automated, Allow listed, etc. over a chosen period.","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV4","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesV3Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewV2Request"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewtimeseriesv4"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV4"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v5/reporting/top/type/malicious/dimension/endpoints":{"post":{"summary":"Top Attacked Endpoints v5","description":"Get top attacked application endpoints v5, with the new definition of malicious bot for sub categories feature","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV5","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopAttackedEndpointsResponseV4"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"payment-app-namespace-1\"\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/reportingTopRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-topattackedendpointsv5"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV5"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/v5/reporting/traffic/overview/expanded":{"post":{"summary":"Expanded Traffic Overview V5","description":"Get expanded traffic overview v5 with global filters supported","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV5","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedV5Response"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-required\nx-example: \"namespace1\"\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedV5Request"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-trafficoverviewexpandedv5"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV5"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/reporting/peers/threat-types":{"post":{"summary":"Peergroup By Threat Types","description":"GetThreat Types traffic count for Peergroup Benchmarking","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersThreatTypes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerGroupResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/reportingPeerGroupRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-peersthreattypes"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersThreatTypes"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/reporting/peers/top-good-bots":{"post":{"summary":"Peer Group Top Good Bots","description":"Get Peer Group Top Good Bots","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopGoodBots","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerGroupResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/reportingPeerGroupRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-peerstopgoodbots"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopGoodBots"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/reporting/peers/top-reason-codes":{"post":{"summary":"Peergroup Top Reason Codes","description":"Get Top Reason Codes","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopReasonCodes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerGroupResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/reportingPeerGroupRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-peerstopreasoncodes"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopReasonCodes"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/reporting/peers/traffic/overview":{"post":{"summary":"Peer Group Traffic Overview","description":"Get traffic overview","operationId":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTrafficOverview","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerGroupTrafficOverviewResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"$ref":"#/components/requestBodies/reportingPeerGroupRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-reporting-customapi-peerstrafficoverview"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTrafficOverview"},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-service":"ves.io.schema.shape.bot_defense.reporting.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Shape Bot Defense Reporting API","x-ves-proto-package":"ves.io.schema.shape.bot_defense.reporting","components":{"requestBodies":{"reportingTrafficOverviewRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewRequest"}}},"required":true},"reportingTopRequestAttackIntent":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopRequestAttackIntent"}}},"required":true},"reportingInsightRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingInsightRequest"}}},"required":true},"reportingPeerGroupRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingPeerGroupRequest"}}},"required":true},"reportingTrafficOverviewExpandedRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTrafficOverviewExpandedRequest"}}},"required":true},"reportingTopRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/reportingTopRequest"}}},"required":true}},"schemas":{"protected_applicationBotDefenseRegion":{"type":"string","description":"Defines a selection for Bot Defense region\n\n - US: US\n\nUnited States of America\n - EU: EU\n\nEuropean Union\n - ASIA: ASIA\n\nAsia\n - CA: CA\n\nCanada","title":"BotDefenseRegion","enum":["US","EU","ASIA","CA"],"default":"US","x-displayname":"Bot Defense Region","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.protected_application.BotDefenseRegion"},"report_configReportFreqDaily":{"type":"object","description":"create report daily","title":"Report Frequency Daily","x-displayname":"Report Frequency Daily","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqDaily","properties":{"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportFreqMonthly":{"type":"object","description":"create report monthly","title":"Report Frequency Monthly","x-displayname":"Report Frequency Monthly","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqMonthly","properties":{"date":{"$ref":"#/components/schemas/report_configReportGenerationDate"},"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"time report is generated","x-displayname":"Time Report is Generated","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportFreqWeekly":{"type":"object","description":"create report weekly","title":"Report Frequency Weekly","x-displayname":"Report Frequency Weekly","x-ves-displayorder":"2,1","x-ves-proto-message":"ves.io.schema.report_config.ReportFreqWeekly","properties":{"day":{"$ref":"#/components/schemas/report_configReportGenerationWeekday"},"report_generation_time":{"type":"string","description":" Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.\n\nExample: ` \"08:30:00 PM\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.pattern: (((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)\n","title":"report generation time","x-displayname":"Report Generation Time","x-ves-example":"08:30:00 PM","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.pattern":"(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)"}}}},"report_configReportGenerationDate":{"type":"string","description":"report generation date\n\nIndicates field not being set\nCreate report on Last day of month","title":"Report Generation Date","enum":["DATE_NONE","DATE_ONE","DATE_TWO","DATE_THREE","DATE_FOUR","DATE_FIVE","DATE_SIX","DATE_SEVEN","DATE_EIGHT","DATE_NINE","DATE_TEN","DATE_ELEVEN","DATE_TWELVE","DATE_THIRTEEN","DATE_FOURTEEN","DATE_FIFTEEN","DATE_SIXTEEN","DATE_SEVENTEEN","DATE_EIGHTEEN","DATE_NINETEEN","DATE_TWENTY","DATE_TWENTYONE","DATE_TWENTYTWO","DATE_TWENTYTHREE","DATE_TWENTYFOUR","DATE_TWENTYFIVE","DATE_TWENTYSIX","DATE_TWENTYSEVEN","DATE_TWENTYEIGHT","DATE_LAST"],"default":"DATE_NONE","x-displayname":"Report Generation Date","x-ves-proto-enum":"ves.io.schema.report_config.ReportGenerationDate"},"report_configReportGenerationWeekday":{"type":"string","description":"report generation weekday\n\nIndicates field not being set","title":"Report Generation Weekday","enum":["WEEKDAY_NONE","WEEKDAY_MONDAY","WEEKDAY_TUESDAY","WEEKDAY_WEDNESDAY","WEEKDAY_THURSDAY","WEEKDAY_FRIDAY","WEEKDAY_SATURDAY","WEEKDAY_SUNDAY"],"default":"WEEKDAY_NONE","x-displayname":"Report Generation Weekday","x-ves-proto-enum":"ves.io.schema.report_config.ReportGenerationWeekday"},"reportingASOrgFilter":{"type":"object","description":"Query Filter by AS Organizations","title":"ASOrg Filter","x-displayname":"AS Organization Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ASOrgFilter","properties":{"as_orgs":{"type":"array","description":" An unordered list of as org strings\n\nExample: ` \"['Google LLC', 'Facebook, Inc']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 1024\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"AS Organizations","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":1024},"x-displayname":"AS Organizations","x-ves-example":"['Google LLC', 'Facebook, Inc']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"1024","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingATBRequest":{"type":"object","description":"Request for ATB","title":"ATBRequest","x-displayname":"Request for ATB","x-ves-oneof-field-frequency":"[\"daily\",\"monthly\",\"weekly\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ATBRequest","properties":{"daily":{"$ref":"#/components/schemas/report_configReportFreqDaily"},"enable":{"type":"boolean","description":" Enable ATB or not.\n\nExample: ` \"true\"`","title":"Enable","format":"boolean","x-displayname":"Enable","x-ves-example":"true"},"monthly":{"$ref":"#/components/schemas/report_configReportFreqMonthly"},"namespace":{"type":"string","description":" namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"resource_id":{"type":"string","description":" Resource ID of ATB report configuration object.\n\nExample: ` \"1234567\"`","title":"Resource ID","x-displayname":"Resource ID","x-ves-example":"1234567"},"virtual_host":{"type":"string","description":" Name of Virtual Host to scope traffic overview query\n\nExample: ` \"myapp-vh-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host Name","x-displayname":"Virtual Host Name","x-ves-example":"myapp-vh-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"weekly":{"$ref":"#/components/schemas/report_configReportFreqWeekly"}}},"reportingATBResponse":{"type":"object","description":"Response for ATB","title":"ATBResponse","x-displayname":"Response for ATB","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ATBResponse","properties":{"enable":{"type":"boolean","description":" Enable ATB or not.\n\nExample: ` \"true\"`","title":"Enable","format":"boolean","x-displayname":"enable","x-ves-example":"true"}}},"reportingActionData":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ActionData","properties":{"action_taken":{"type":"string","description":" The Action Taken for automated bot traffic\n\nExample: ` \"blocked\"`","title":"Item Name","x-displayname":"Action Taken","x-ves-example":"blocked"},"count":{"type":"string","description":" The total count of the action taken\n\nExample: ` \"70\"`","title":"Current Total Count for the action","format":"uint64","x-displayname":"Total Count","x-ves-example":"70"}}},"reportingActionTakenData":{"type":"object","title":"Action Taken Data","x-displayname":"Action Taken Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ActionTakenData","properties":{"action_taken":{"type":"string","description":" The Action Taken for the malicious traffic\n\nExample: ` \"blocked\"`","title":"Item Name","x-displayname":"Action Taken","x-ves-example":"blocked"},"current_total":{"type":"string","description":" The total count of the action taken\n\nExample: ` \"100\"`","title":"Current Total Count for the action","format":"uint64","x-displayname":"Total Count","x-ves-example":"100"},"previous_total":{"type":"string","description":" The total number of malicious bot traffic in the action taken within the previous specified time interval.\n\nExample: ` 34`","title":"Total count of Action Taken in the previous time interval","format":"uint64","x-displayname":"Previous Count in last X days"},"sentiment":{"type":"string","description":" The sentiment for the trend of malicious traffic in the Action Taken\n\nExample: ` \"false\"`","title":"Sentiment for the Action Taken","x-displayname":"Action Taken Sentiment","x-ves-example":"false"},"trend":{"type":"number","description":" Trend of the number of malicious bot traffic in the Action Taken\n\nExample: ` 0.4 or null`","title":"Trend for the Action Taken","format":"double","x-displayname":"Action Taken Trend"}}},"reportingActionTakenFilter":{"type":"object","description":"Query Filter by action taken","title":"Action Taken Filter","x-displayname":"Action Taken Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ActionTakenFilter","properties":{"actions_taken":{"type":"array","description":" A list of strings\n\nExample: ` \"['Block', 'Continue']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Action Taken","maxItems":64,"items":{"type":"string"},"x-displayname":"Actions Taken","x-ves-example":"['Block', 'Continue']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingAppIDFilter":{"type":"object","description":"Query Filter by app id filter strings","title":"App ID Filter","x-displayname":"App ID Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AppIDFilter","properties":{"app_id_strings":{"type":"array","description":" An unordered list of App ID strings\n\nExample: ` \"['05e6f9399cbb4e18b5775fb206d37312']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"App ID Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"App ID Strings","x-ves-example":"['05e6f9399cbb4e18b5775fb206d37312']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingApplicationNameFilter":{"type":"object","description":"Query Filter by application name","title":"Application Name Filter","x-displayname":"Application Name Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ApplicationNameFilter","properties":{"application_names":{"type":"array","description":" A list of strings\n\nExample: ` \"['app1', 'app2']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Application Name","maxItems":64,"items":{"type":"string"},"x-displayname":"Application Names","x-ves-example":"['app1', 'app2']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingAttackIntentData":{"type":"object","description":"Attack Intent Data","title":"Attack Intent Data","x-displayname":"Attack Intent Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackIntentData","properties":{"count":{"type":"string","description":" The Number of Each Attack Intent Type\n\nExample: ` \"100\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"100"},"name":{"type":"string","description":" The Name of Attack Intent Type\n\nExample: ` \"Carding\"`","title":"Attack Intent Type Name","x-displayname":"Name","x-ves-example":"Carding"},"percentage":{"type":"number","description":" The Percentage of the number of each attack intent type / the total traffic or bad bot\n\nExample: ` 50.0`","title":"Attack Intent Type Percentage","format":"double","x-displayname":"Percentage"},"time_series":{"type":"array","description":" Time Series Data for Each Attack Intent Type","title":"Attack Intent Time Series","items":{"$ref":"#/components/schemas/reportingTimeSeriesDataV2"},"x-displayname":"Attack Intent Time Series"}}},"reportingAttackIntentFilter":{"type":"object","description":"Query Filter by attack intent filter strings","title":"Attack Intent Filter","x-displayname":"Attack Intent Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackIntentFilter","properties":{"attack_intent_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['Credential Stuffing', 'Carding']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Attack Intent Strings","minItems":1,"maxItems":64,"items":{"type":"string"},"x-displayname":"Attack Intent Strings","x-ves-example":"['Credential Stuffing', 'Carding']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingAttackIntentTimeSeriesResponse":{"type":"object","description":"The Response of Attack Intent Time Series API","title":"Attack Intent Time Series Response","x-displayname":"Attack Intent Time Series Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackIntentTimeSeriesResponse","properties":{"attack_intent_data":{"type":"array","title":"Attack Intent Data","items":{"$ref":"#/components/schemas/reportingAttackIntentData"},"x-displayname":"Attack Intent Data"}}},"reportingAttackedBFPData":{"type":"object","description":"Attacked BFP Data","title":"Attacked BFP Data","x-displayname":"Attacked BFP Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackedBFPData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"100\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"100"},"name":{"type":"string","description":" Name\n\nExample: ` \"testbfp\"`","title":"Name","x-displayname":"Name","x-ves-example":"testbfp"},"percentage":{"type":"number","description":" Percentage\n\nExample: ` \"10\"`","title":"Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"10"}}},"reportingAttackedEndpointData":{"type":"object","description":"Attacked application endpoint data","title":"Attacked Endpoint Data","x-displayname":"Attacked Endpoint Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackedEndpointData","properties":{"app_name":{"type":"string","description":" The data for the application name column shown on the top bot endpoints panel on the traffic page.\n\nExample: ` \"test-bigip-app\"`","title":"Application Name","x-displayname":"Application Name","x-ves-example":"test-bigip-app"},"hostname":{"type":"string","description":" Hostname of attacked app endpoint\n\nExample: ` \"xyz.foo.com\"`","title":"Hostname","x-displayname":"Hostname","x-ves-example":"xyz.foo.com"},"human_request_count":{"type":"string","description":" Number of HTTP requests identified as human\n\nExample: ` \"20000\"`","title":"Human Request Count","format":"uint64","x-displayname":"Human Request Count","x-ves-example":"20000"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"method":{"type":"string","description":" HTTP method of attacked app endpoint\n\nExample: ` \"POST\"`","title":"HTTP Method","x-displayname":"HTTP Method","x-ves-example":"POST"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"0.9\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"0.9"},"uri":{"type":"string","description":" URI of attacked app endpoint\n\nExample: ` \"/index.php\"`","title":"URI","x-displayname":"URI","x-ves-example":"/index.php"}}},"reportingAttackedEndpointDataV2":{"type":"object","description":"Attacked application endpoint data V2","title":"Attacked Endpoint Data V2","x-displayname":"Attacked Endpoint Data V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackedEndpointDataV2","properties":{"endpoint_traffic_details":{"type":"array","description":" Endpoint Traffic Details","title":"Endpoint Traffic Details","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Endpoint Traffic Details"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"total_count":{"type":"string","description":" Number of Total Traffic Count for Each Endpoints\n\nExample: ` \"2000\"`","title":"Total Traffic Count for Each Endpoints","format":"uint64","x-displayname":"Total Traffic Count for Each Endpoints","x-ves-example":"2000"},"uri":{"type":"string","description":" URI of attacked app endpoint\n\nExample: ` \"/index.php\"`","title":"URI","x-displayname":"URI","x-ves-example":"/index.php"}}},"reportingAttackedEndpointDataV4":{"type":"object","description":"Attacked application endpoint data V4","title":"Attacked Endpoint Data V4","x-displayname":"Attacked Endpoint Data V4","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AttackedEndpointDataV4","properties":{"category":{"type":"string","description":" Category\n\nExample: ` \"Shopping\"`","title":"Category","x-displayname":"Category","x-ves-example":"Shopping"},"endpoint_traffic_details":{"type":"array","description":" Endpoint Traffic Details","title":"Endpoint Traffic Details","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Endpoint Traffic Details"},"flow_label":{"type":"string","description":" Flow Label\n\nExample: ` \"Login\"`","title":"Flow Label","x-displayname":"Flow Label","x-ves-example":"Login"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"total_count":{"type":"string","description":" Number of Total Traffic Count for Each Endpoints\n\nExample: ` \"2000\"`","title":"Total Traffic Count for Each Endpoints","format":"uint64","x-displayname":"Total Traffic Count for Each Endpoints","x-ves-example":"2000"},"uri":{"type":"string","description":" URI of attacked app endpoint\n\nExample: ` \"/index.php\"`","title":"URI","x-displayname":"URI","x-ves-example":"/index.php"}}},"reportingAutomatedTrafficActionsResponse":{"type":"object","description":"Automated Bot Taffic in Actions Response","title":"AutomatedTrafficActionsResponse","x-displayname":"Automated Bot Taffic Overview in Actions","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AutomatedTrafficActionsResponse","properties":{"actions":{"type":"array","title":"x-displayName: \"Action taken Details\"","items":{"$ref":"#/components/schemas/reportingActionData"}},"current_total":{"type":"string","description":" The total count of all the action taken\n\nExample: ` \"100\"`","title":"Current Total Count for the action","format":"uint64","x-displayname":"Total Count","x-ves-example":"100"},"previous_total":{"type":"string","description":" The total number of automated bot traffic in the action taken within the previous specified time interval.\n\nExample: ` 31`","title":"Total count of All the Action Taken in the previous time interval","format":"uint64","x-displayname":"Previous Count in last X days"},"sentiment":{"type":"string","description":" The sentiment for the total automated bot traffic Actions\n\nExample: ` \"false\"`","title":"Sentiment for the total automated bot traffic Actions","x-displayname":"Action Taken Sentiment","x-ves-example":"false"},"trend":{"type":"number","description":" Trend of the number of automated bot traffic in the Action Taken\n\nExample: ` 0.4 or null`","title":"Trend for the total automated bot traffic Actions","format":"double","x-displayname":"Action Taken Trend"}}},"reportingAutomationTypeData":{"type":"object","description":"Malicious bot automation type","title":"Automation Type Data","x-displayname":"Malicious Bot Automation Type Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AutomationTypeData","properties":{"automation_type":{"type":"string","description":" Malicious Bot Automation Type\n\nExample: ` \"Token Expired\"`","title":"Malicious Bot Automation Type","x-displayname":"Malicious Bot Automation Type","x-ves-example":"Token Expired"},"previous_reqeust_count":{"type":"string","description":" Previous Request Count\n\nExample: ` \"2000\"`","title":"Previous Request Count","format":"uint64","x-displayname":"Previous Request Count","x-ves-example":"2000"},"request_count":{"type":"string","description":" Number of requests with the specified automation type\n\nExample: ` \"2000\"`","title":"Request Count","format":"uint64","x-displayname":"Request Count","x-ves-example":"2000"},"request_percentage":{"type":"number","description":" Request Percentage\n\nExample: ` \"0.9\"`","title":"Request Percentage","format":"double","x-displayname":"Request Percentage","x-ves-example":"0.9"},"request_sentiment":{"type":"string","description":" Request Sentiment\n\nExample: ` \"false\"`","title":"Request Sentiment","x-displayname":"Request Sentiment","x-ves-example":"false"},"trend":{"type":"number","description":" Trend\n\nExample: ` 0.3 or null`","title":"Trend","format":"double","x-displayname":"Trend"}}},"reportingAutomationTypeFilter":{"type":"object","description":"Query Filter by automation type filter strings","title":"Automation Type Filter","x-displayname":"Automation Type Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.AutomationTypeFilter","properties":{"automation_type_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['Aggregator']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Automation Type Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Automation Type Strings","x-ves-example":"['Aggregator']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingBrowserFilter":{"type":"object","description":"Query Filter by browser filter strings","title":"Browser Filter","x-displayname":"Browser Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.BrowserFilter","properties":{"browser_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['chrome', 'firefox']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Browser Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Browser Strings","x-ves-example":"['chrome', 'firefox']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingCategoriesData":{"type":"object","description":"Flow label categories data. Includes total number of requests and requests time series","title":"Flow Label Categories","x-displayname":"Categories","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.CategoriesData","properties":{"category":{"type":"string","description":" Flow label category name\n\nExample: ` \"Authentication\"`","title":"Category Name","x-displayname":"Category","x-ves-example":"Authentication"},"percentage":{"type":"number","description":" The request for each category / the total traffic\n\nExample: ` 23.5`","title":"The request percentage of each category","format":"double","x-displayname":"Percentage"},"requests":{"type":"string","description":" Number of requests labeled as a specific flow label category\n\nExample: ` 342`","title":"Number of Requests","format":"uint64","x-displayname":"Number of Requests"}}},"reportingCategoriesTimeSeriesResponse":{"type":"object","description":"The Response contains the time series data list for each endpoint category","title":"Categories Time Series Response","x-displayname":"Response for Categories TimeSeries","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.CategoriesTimeSeriesResponse","properties":{"category_time_series_data":{"type":"array","title":"Response for Category TimeSeries","items":{"$ref":"#/components/schemas/reportingCategoryTimeSeriesData"},"x-displayname":"Category TimeSeries Data"}}},"reportingCategoryTimeSeriesData":{"type":"object","title":"Category Time Series Data","x-displayname":"Category Timeseries Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.CategoryTimeSeriesData","properties":{"count":{"type":"string","description":" The Number of Each Category\n\nExample: ` \"100\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"100"},"name":{"type":"string","description":" The Name of Category\n\nExample: ` \"Authentication\"`","title":"Category Name","x-displayname":"Name","x-ves-example":"Authentication"},"time_series":{"type":"array","description":" Time Series Data for Each Category Type","title":"Category Time Series","items":{"$ref":"#/components/schemas/reportingTimeSeriesDataV2"},"x-displayname":"Category Time Series"}}},"reportingConsumptionData":{"type":"object","title":"Consumption Summary Data","x-displayname":"Consumption Summary Data","x-ves-oneof-field-aggregation_level":"[\"day\",\"month\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ConsumptionData","properties":{"all":{"type":"string","description":" all traffic count\n\nExample: ` \"100\"`","title":"All Traffic","format":"uint64","x-displayname":"All","x-ves-example":"100"},"day":{"type":"string","description":"Exclusive with [month]\n Day Identifier, format: YYYYMMDD\n\nExample: ` \"20240701\"`","title":"Day of the traffic Consumption Summary","x-displayname":"Day","x-ves-example":"20240701"},"month":{"type":"string","description":"Exclusive with [day]\n Month Identifier, format: YYYYMM\n\nExample: ` \"202407\"`","title":"Month of the traffic Consumption Summary","x-displayname":"Month","x-ves-example":"202407"},"telemetry_client":{"type":"string","description":" counts of telemetry client\n\nExample: ` \"21\"`","title":"Telemetry Client Count","format":"uint64","x-displayname":"Telemetry Client","x-ves-example":"21"}}},"reportingConsumptionSummaryResponse":{"type":"object","description":"Response for Consumption Summary","title":"Consumption Summary Response","x-displayname":"Response for Consumption Summary","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ConsumptionSummaryResponse","properties":{"sums":{"type":"array","description":" Consumption summary data","title":"Consumption Summary","items":{"$ref":"#/components/schemas/reportingConsumptionData"},"x-displayname":"Consumption Summary Data"}}},"reportingCountryFilter":{"type":"object","description":"Query Filter by country filter strings","title":"Country Filter","x-displayname":"Country Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.CountryFilter","properties":{"country_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['US']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Country Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Country Strings","x-ves-example":"['US']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingCredentialStuffingAttackResponse":{"type":"object","description":"Response for Credential Stuffing Attack","title":"InsightEvent: Credential Stuffing Attack","x-displayname":"Credential Stuffing Attack Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.CredentialStuffingAttackResponse","properties":{"bad_bot_login":{"type":"string","description":" The Number of Bad Bot Activity with Login Endpoint\n\nExample: ` \"13\"`","title":"Bad Bot Login endpoint","format":"uint64","x-displayname":"The Number of Bad Bot Login endpoint","x-ves-example":"13"},"bad_bot_login_percentage":{"type":"number","description":" The Percentage for Bad Bot Activity with Login Endpoint\n\nExample: ` \"78.9\"`","title":"Bad Bot Login endpoint Percentage","format":"double","x-displayname":"Bad Bot Login endpoint Percentage","x-ves-example":"78.9"},"create_date":{"type":"number","description":" UTC Create Date in seconds\n\nExample: ` \"1569528992\"`","title":"Create_Date","format":"double","x-displayname":"Create Date","x-ves-example":"1569528992"},"mitigated_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count\n\nExample: ` 25.7`","title":"Mitigated Count Percentage","format":"double","x-displayname":"Mitigated Count Percentage"},"time_series":{"type":"array","description":" Time Series Graph Data\n\nExample: ` \"\"`","title":"Time Series Graph Data","items":{"$ref":"#/components/schemas/reportingTimeSeriesGraphData"},"x-displayname":"Time Series Graph Data"},"trend":{"type":"number","description":" The Trend of Creadential Stuffing Attack\n\nExample: ` \"13.4\" or null`","title":"Trend","format":"double","x-displayname":"Trend of Creadential Stuffing Attack"}}},"reportingDistributionData":{"type":"object","description":"Distribution Data","title":"DistributionData","x-displayname":"Distribution Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.DistributionData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"},"name":{"type":"string","description":" Name\n\nExample: ` \"WIN\"`","title":"Name","x-displayname":"Name","x-ves-example":"WIN"},"percentage":{"type":"number","description":" Percentage\n\nExample: ` \"10.1\"`","title":"Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"10.1"}}},"reportingEndpointCategoryData":{"type":"object","description":"Response that contains Endpoint Category Data","title":"Endpoint Category Data","x-displayname":"Endpoint Category Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointCategoryData","properties":{"action_distribution":{"type":"array","items":{"$ref":"#/components/schemas/reportingDistributionData"}},"category_label":{"type":"string","description":" Flow Label or Flow Category ","title":"x-displayName: \"Flow Label or Flow Category\"\nx-example: \"Login\"\nFlow Label or Flow Category","x-displayname":"Flow Label or Flow Category","x-ves-example":"Login"},"endpoint_count":{"type":"string","description":" count\n\nExample: ` \"100\"`","title":"x-displayName: \"Endpoint Count\"","format":"uint64","x-displayname":"Endpoint Count","x-ves-example":"100"},"event_count":{"type":"string","description":" count\n\nExample: ` \"100\"`","title":"x-displayName: \"Event Count\"","format":"uint64","x-displayname":"Event Count","x-ves-example":"100"},"event_percentage":{"type":"number","description":"\n event percentage\n\nExample: ` \"10.7\"`","title":"percentage of total event","format":"double","x-displayname":"% of Total Events","x-ves-example":"10.7"},"traffic_channel":{"type":"array","items":{"$ref":"#/components/schemas/reportingDistributionData"}},"traffic_distribution":{"type":"array","items":{"$ref":"#/components/schemas/reportingDistributionData"}}}},"reportingEndpointCategoryResponse":{"type":"object","description":"Response that contains Endpoint Data","title":"EndpointCategoryResponse","x-displayname":"Endpoint Category Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointCategoryResponse","properties":{"endpoint_categories":{"type":"array","description":" Endpoint Category Data","title":"x-displayName: \"Endpoint Category  Data\"\nx-example: \"\"\nEndpoint Category Data","items":{"$ref":"#/components/schemas/reportingEndpointCategoryData"},"x-displayname":"Endpoint Category  Data"},"endpoint_count":{"type":"string","description":" count\n\nExample: ` \"100\"`","title":"x-displayName: \"Total Endpoint Count\"","format":"uint64","x-displayname":"Total Endpoint Count","x-ves-example":"100"},"event_count":{"type":"string","description":" count\n\nExample: ` \"100\"`","title":"x-displayName: \"Total Event Count\"","format":"uint64","x-displayname":"Total Event Count","x-ves-example":"100"}}},"reportingEndpointLabelsData":{"type":"object","description":"Endpoint Labels Data","title":"Endpoint Labels Data","x-displayname":"Endpoint Labels Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointLabelsData","properties":{"endpointLabel":{"type":"string","description":" Endpoint Label\n\nExample: ` \"Logout\"`","title":"Endpoint Label","x-displayname":"EndpointLabel","x-ves-example":"Logout"},"requests":{"type":"string","description":" Requests number for top Endpoint Labels\n\nExample: ` 342`","title":"Requests","format":"uint64","x-displayname":"Requests"}}},"reportingEndpointListData":{"type":"object","description":"Response that contains All Protected Endpoints Data","title":"EndpointListData","x-displayname":"Endpoints Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointListData","properties":{"application":{"type":"string","description":" Application","title":"x-displayName: \"Application\"\nx-example: \"AppA\"\nApplication","x-displayname":"Application","x-ves-example":"AppA"},"category":{"type":"string","description":" Flow Category","title":"x-displayName: \"Flow Category\"\nx-example: \"Authentication\"\nFlow Category","x-displayname":"Flow Category","x-ves-example":"Authentication"},"count":{"type":"string","description":" count\n\nExample: ` \"100\"`","title":"x-displayName: \"Count\"","format":"uint64","x-displayname":"Count","x-ves-example":"100"},"count_percentage":{"type":"number","description":"\n traffic percentage\n\nExample: ` \"10.7\"`","title":"percentage of total traffic","format":"double","x-displayname":"% of Total Traffic","x-ves-example":"10.7"},"domain":{"type":"string","description":" domain\n\nExample: ` \"target-us.com\"`","title":"x-displayName: \"Domain\"","x-displayname":"Domain","x-ves-example":"target-us.com"},"endpoint":{"type":"string","description":" Endpoint","title":"x-displayName: \"Endpoint\"\nx-example: \"/media-resource/abcdef\"\nEndpoint","x-displayname":"Endpoint","x-ves-example":"/media-resource/abcdef"},"label":{"type":"string","description":" Flow Label","title":"x-displayName: \"Flow Label\"\nx-example: \"Login\"\nFlow Label","x-displayname":"Flow Label","x-ves-example":"Login"}}},"reportingEndpointListResponse":{"type":"object","description":"Response that contains Endpoint Data","title":"EndpointListResponse","x-displayname":"Endpoints Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointListResponse","properties":{"endpoints":{"type":"array","description":" Endpoints Response","title":"x-displayName: \"Endpoints Response\"\nx-example: \"\"\nEndpoints Response","items":{"$ref":"#/components/schemas/reportingEndpointListData"},"x-displayname":"Endpoints Response"}}},"reportingEndpointSummaryResponse":{"type":"object","description":"Response that contains Endpoint Summary","title":"EndpointSummaryResponse","x-displayname":"Endpoint Summary Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointSummaryResponse","properties":{"total_applications":{"type":"string","description":"\n\nExample: `8`","title":"Total number of Applications","format":"uint64","x-displayname":"The Total Number of Applications"},"total_distinct_endpoints":{"type":"string","description":" The number of distinct endpoints\n\nExample: `100`","title":"Total number of distinct Endpoints","format":"uint64","x-displayname":"The Total Number of distinct endpoints"}}},"reportingEndpointSummaryResponseV2":{"type":"object","description":"Response that contains Endpoint Summary with Unevaluated Transactions","title":"EndpointSummaryResponseV2","x-displayname":"Endpoint Summary Response V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.EndpointSummaryResponseV2","properties":{"total_applications":{"type":"string","description":"\n\nExample: `8`","title":"Total number of Applications","format":"uint64","x-displayname":"The Total Number of Applications"},"total_distinct_endpoints":{"type":"string","description":" The number of distinct endpoints\n\nExample: `100`","title":"Total number of distinct Endpoints","format":"uint64","x-displayname":"The Total Number of distinct endpoints"},"total_unevaluated_transactions":{"type":"string","description":"\n\nExample: `8`","title":"Total number of Unevaluated Transactions","format":"uint64","x-displayname":"The Total Number of Unevaluated Transactions"}}},"reportingFilterKey":{"type":"string","description":"x-example: \"TIMESTAMP\"\nKey for query filter\n\n - TIMESTAMP: Timestamp Filter Key\n\nUse Timestamp as key to query","title":"Filter Key","enum":["TIMESTAMP","USERNAME","CLIENT_TOKEN","IP_ADDRESS","ASN","AS_ORGANIZATION","COUNTRY","METHOD","HOST","PATH","URL","REFERER","TRAFFIC_CHANNEL","IS_ATTACK","BOT_REASON","TRAFFIC_TYPE","THREAT_TYPE","SDK_VERSION","ACTION_TAKEN","COOKIE_AGE","BOT_COOKIE","USER_AGENT","USER_AGENT_OS_FAMILY","USER_AGENT_FAMILY","BROWSER_FINGERPRINT","USER_FINGERPRINT","HEADER_FINGERPRINT","DEVICE_ID","FLOW","AGENT","APPLICATION_NAME","PROTECTED_APPLICATION","RESPONSE_CODE","SERVER_RESPONSE_CODE","TRANSACTION_RESULT","MOBILE_TRANSACTION_INSIGHT","WEB_TRANSACTION_INSIGHT","TRIGGERED_RULE"],"default":"TIMESTAMP","x-displayname":"Filter Key","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.reporting.FilterKey"},"reportingFilterOperator":{"type":"string","description":"x-example: \"IN or NOT_IN\"\nOperator for query filter\n\n - IN: Filter Operator\n\nSpecifies that query result includes filter values\n - NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n - MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n - DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n - INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n - DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n - STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n - ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values","title":"Filter Operator","enum":["IN","NOT_IN","MATCHES_REGEX","DOES_NOT_MATCH_REGEX","INCLUDES","DOES_NOT_INCLUDE","STARTS_WITH","ENDS_WITH"],"default":"IN","x-displayname":"Filter Operator","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.reporting.FilterOperator"},"reportingFilters":{"type":"object","description":"Reporting API query filters","title":"Filters","x-displayname":"Filters","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.Filters","properties":{"action_taken":{"$ref":"#/components/schemas/reportingActionTakenFilter"},"app_id_filter":{"$ref":"#/components/schemas/reportingAppIDFilter"},"application_name":{"$ref":"#/components/schemas/reportingApplicationNameFilter"},"as_org_filter":{"$ref":"#/components/schemas/reportingASOrgFilter"},"attack_intent_filter":{"$ref":"#/components/schemas/reportingAttackIntentFilter"},"automation_type_filter":{"$ref":"#/components/schemas/reportingAutomationTypeFilter"},"browser_filter":{"$ref":"#/components/schemas/reportingBrowserFilter"},"country_filter":{"$ref":"#/components/schemas/reportingCountryFilter"},"host_filter":{"$ref":"#/components/schemas/reportingHostFilter"},"inference_filter":{"$ref":"#/components/schemas/reportingInferenceFilter"},"ip_filter":{"$ref":"#/components/schemas/reportingIPFilter"},"method_filter":{"$ref":"#/components/schemas/reportingMethodFilter"},"os_filter":{"$ref":"#/components/schemas/reportingOSFilter"},"referer_filter":{"$ref":"#/components/schemas/reportingRefererFilter"},"region_filter":{"$ref":"#/components/schemas/protected_applicationBotDefenseRegion"},"traffic_type_filter":{"$ref":"#/components/schemas/reportingTrafficTypeFilter"},"ua_filter":{"$ref":"#/components/schemas/reportingUserAgentFilter"},"uri_filter":{"$ref":"#/components/schemas/reportingURIFilter"}}},"reportingForensicAggregateType":{"type":"object","description":"Forensic AggregateType fields","title":"ForensicAggregateType","x-displayname":"Forensic AggregateType","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicAggregateType","properties":{"count":{"type":"string","description":" Forensic Aggregate Count\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Count","format":"uint64","x-displayname":"Count","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"percent":{"type":"number","description":" Forensic Aggregate Percent\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Percent","format":"double","x-displayname":"Percent","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"value":{"type":"string","description":" Forensic Aggregate Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Value","x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingForensicData":{"type":"object","description":"Forensic Data","title":"ForensicData","x-displayname":"Forensic Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicData","properties":{"aggregate":{"type":"array","description":" Optional\n Forensic Aggregate Type","title":"Forensic Aggregate","items":{"$ref":"#/components/schemas/reportingForensicAggregateType"},"x-displayname":"Forensic Aggregate"},"errors":{"$ref":"#/components/schemas/reportingForensicErrorType"},"key":{"$ref":"#/components/schemas/reportingFilterKey"},"mode":{"$ref":"#/components/schemas/reportingForensicModeTypes"},"suggest":{"type":"array","description":" Optional\n Forensic Suggest Type","title":"Forensic Suggest","items":{"$ref":"#/components/schemas/reportingForensicSuggestType"},"x-displayname":"Forensic Suggest"}}},"reportingForensicErrorType":{"type":"object","description":"Forensic ErrorType","title":"ForensicErrorType","x-displayname":"Forensic ErrorType","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicErrorType","properties":{"code":{"type":"string","description":" Forensic Error Code\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Forensic Error Code","format":"uint64","x-displayname":"Forensic Error Code","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"message":{"type":"string","description":" Forensic Error Message\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Forensic Error Message","x-displayname":"Forensic Error Message","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingForensicField":{"type":"object","description":"Forensic query field","title":"ForensicField","x-displayname":"Forensic Field","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicField","properties":{"key":{"$ref":"#/components/schemas/reportingFilterKey"},"limit":{"type":"integer","description":" limits the number of transactions returned in the response\n Optional: If not specified, the first 500 transactions that matches the query will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"100","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"500"}},"mode":{"$ref":"#/components/schemas/reportingForensicModeTypes"},"sort":{"$ref":"#/components/schemas/reportingForensicSortOption"}}},"reportingForensicFieldsRequest":{"type":"object","description":"Request for Shape Bot Defense Forensic Fields","title":"ForensicFieldsRequest","x-displayname":"Forensic Fields Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicFieldsRequest","properties":{"end_time":{"type":"string","description":" end time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"fields":{"type":"array","description":" Additional fields for the query\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Fields","items":{"$ref":"#/components/schemas/reportingForensicField"},"x-displayname":"Fields","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"filters":{"$ref":"#/components/schemas/reportingGlobalFilters"},"namespace":{"type":"string","description":" namespace is used to scope the query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"namespace1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"namespace1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"}}},"reportingForensicFieldsResponse":{"type":"object","description":"Response for Shape Bot Defense Forensic Fields","title":"ForensicFieldsResponse","x-displayname":"Forensic Fields Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicFieldsResponse","properties":{"fields":{"type":"array","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Response for Forensic Fields","items":{"$ref":"#/components/schemas/reportingForensicData"},"x-displayname":"Forensic Fields Details","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingForensicModeTypes":{"type":"string","description":"x-example: \"aggregate\"\nForensic Mode Types\n\n - AGGREGATE: Aggregate Mode\n\nUse Aggregate Mode as key to query\n - SUGGEST: Suggest Mode\n\nUse Suggest Mode as key to query","title":"Forensic Mode Types","enum":["AGGREGATE","SUGGEST"],"default":"AGGREGATE","x-displayname":"Forensic Mode Types","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.reporting.ForensicModeTypes"},"reportingForensicSortOption":{"type":"object","description":"Query Result Forensic Sort Option","title":"Forensic Sort Option","x-displayname":"Forensic Sort Option","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicSortOption","properties":{"key":{"type":"string","description":" Key to sort\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Sort Key","x-displayname":"Sort Key","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"order":{"$ref":"#/components/schemas/schemaSortOrder"}}},"reportingForensicSuggestType":{"type":"object","description":"Forensic SuggestType fields","title":"ForensicSuggestType","x-displayname":"Forensic SuggestType","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ForensicSuggestType","properties":{"value":{"type":"string","description":" Forensic Suggest Value\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Value","x-displayname":"Value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingGlobalFilter":{"type":"object","description":"Query Global Filter","title":"Global Filter","x-displayname":"Global Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.GlobalFilter","properties":{"key":{"$ref":"#/components/schemas/reportingFilterKey"},"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"values":{"type":"array","description":" An unordered list of filter strings\n\nExample: ` \"['Google LLC', 'Facebook, Inc']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.max_len: 1024\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Values","minItems":1,"maxItems":64,"items":{"type":"string","maxLength":1024},"x-displayname":"Values","x-ves-example":"['Google LLC', 'Facebook, Inc']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.max_len":"1024","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"reportingGlobalFilters":{"type":"object","description":"Query Global Filters","title":"Global Filters","x-displayname":"Global Filters","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.GlobalFilters","properties":{"global_filters":{"type":"array","description":" list of global filters\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Filters","items":{"$ref":"#/components/schemas/reportingGlobalFilter"},"x-displayname":"Global Filters","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"region_filter":{"$ref":"#/components/schemas/protected_applicationBotDefenseRegion"}}},"reportingHostFilter":{"type":"object","description":"Query Filter by host filter strings","title":"Host Filter","x-displayname":"Host Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.HostFilter","properties":{"host_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['www.testhost.com']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Host Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Host Strings","x-ves-example":"['www.testhost.com']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingHumanBrowserData":{"type":"object","description":"Human Browser Data","title":"Human Browser Data","x-displayname":"Human Browser Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.HumanBrowserData","properties":{"browser":{"type":"string","description":" Browser\n\nExample: ` \"chrome\"`","title":"Browser","x-displayname":"Browser","x-ves-example":"chrome"},"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"}}},"reportingHumanDeviceData":{"type":"object","description":"Human Device Data","title":"Human Device Data","x-displayname":"Human Device Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.HumanDeviceData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"},"device":{"type":"string","description":" Device\n\nExample: ` \"iPhone\"`","title":"Device","x-displayname":"Device","x-ves-example":"iPhone"}}},"reportingHumanGeolocationData":{"type":"object","description":"Human Geolocation Data","title":"Human Geolocation Data","x-displayname":"Human Geolocation Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.HumanGeolocationData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"},"count_percentage":{"type":"number","description":" Count percentage for count / total human count\n\nExample: ` \"10\"`","title":"Count percentage","format":"double","x-displayname":"Count percentage","x-ves-example":"10"},"flag_string":{"type":"string","description":" The flag string for flag icon display\n\nExample: ` \"flag_jp\"`","title":"Flag Icon String","x-displayname":"Flag String","x-ves-example":"flag_jp"},"geolocation":{"type":"string","description":" Geolocation\n\nExample: ` \"US\"`","title":"Geolocation","x-displayname":"Geolocation","x-ves-example":"US"}}},"reportingHumanPlatformData":{"type":"object","description":"Human Platform Data","title":"Human Platform Data","x-displayname":"Human Platform Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.HumanPlatformData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"},"platform":{"type":"string","description":" Platform\n\nExample: ` \"iOS\"`","title":"Platform","x-displayname":"Platform","x-ves-example":"iOS"}}},"reportingIPFilter":{"type":"object","description":"Query Filter by IP addresses","title":"IPFilter","x-displayname":"IP Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.IPFilter","properties":{"ips":{"type":"array","description":" An unordered list of IPv4 addresses\n\nExample: ` \"['1.2.3.4', '7.6.8.9']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"IP Addresses","maxItems":64,"items":{"type":"string"},"x-displayname":"IP addresses","x-ves-example":"['1.2.3.4', '7.6.8.9']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingInferenceFilter":{"type":"object","description":"Query Filter by Inference filter strings","title":"Inference Filter","x-displayname":"Inference Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.InferenceFilter","properties":{"inference_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['Good Bot']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Inference Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Inference Strings","x-ves-example":"['Good Bot']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingInsightBadBotReductionResponse":{"type":"object","description":"Insight Bad Bot Reduction Response","title":"Insight Bad Bot Reduction Response","x-displayname":"Insight Bad Bot Reduction Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.InsightBadBotReductionResponse","properties":{"create_date":{"type":"number","description":" UTC Create Date in seconds\n\nExample: ` \"1569528992\"`","title":"Create Date","format":"double","x-displayname":"Create Date","x-ves-example":"1569528992"},"reduction":{"type":"number","description":" Reduction\n\nExample: ` \"10.0\"`","title":"Reduction","format":"double","x-displayname":"Reduction","x-ves-example":"10.0"},"time_series_data":{"type":"array","description":" Time Series Data\n\nExample: ` \"\"`","title":"Time Series Data","items":{"$ref":"#/components/schemas/reportingTimeSeriesDataV2"},"x-displayname":"Time Series Data"}}},"reportingInsightPersonalStatsResponse":{"type":"object","description":"Insight Personal Stats Response","title":"Insight Personal Stats Response","x-displayname":"Insight Personal Stats Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.InsightPersonalStatsResponse","properties":{"bots":{"type":"string","description":" Bots\n\nExample: ` \"100\"`","title":"Bots","format":"uint64","x-displayname":"Bots","x-ves-example":"100"},"human":{"type":"string","description":" Human\n\nExample: ` \"200\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"200"}}},"reportingInsightRequest":{"type":"object","description":"Insight Request","title":"Insight Request","x-displayname":"Insight Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.InsightRequest","properties":{"date":{"type":"string","description":" Date\n Format: YYYY/MM/DD\n\nExample: ` \"2023/03/01\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Date","x-displayname":"Date","x-ves-example":"2023/03/01","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" Namespace\n\nExample: ` \"default\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"default","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"region":{"type":"string","description":" Region\n\nExample: ` \"US\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Region","x-displayname":"Region","x-ves-example":"US","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingInsightUnaddressedAutomationsResponse":{"type":"object","description":"Insight Unaddressed Automations Response","title":"Insight Unaddressed Automations Response","x-displayname":"Insight Unaddressed Automations Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.InsightUnaddressedAutomationsResponse","properties":{"bad_bots":{"type":"number","description":" Bad Bots\n\nExample: ` \"10.0\"`","title":"Bad Bots","format":"double","x-displayname":"Bad Bots","x-ves-example":"10.0"},"create_date":{"type":"number","description":" UTC Create Date in seconds\n\nExample: ` \"1569528992\"`","title":"Create Date","format":"double","x-displayname":"Create Date","x-ves-example":"1569528992"},"flagged_endpoints":{"type":"string","description":" Flagged Endpoints\n\nExample: ` \"200\"`","title":"Flagged Endpoints","format":"uint64","x-displayname":"Flagged Endpoints","x-ves-example":"200"},"unaddressed":{"type":"number","description":" Unaddressed\n\nExample: ` \"10.0\"`","title":"Unaddressed","format":"double","x-displayname":"Unaddressed","x-ves-example":"10.0"}}},"reportingMaliciousBotASOrgData":{"type":"object","description":"Malicious Bot ASOrg Data","title":"Malicious Bot ASOrg Data","x-displayname":"Malicious Bot ASOrg Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotASOrgData","properties":{"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"distinct_ip_count":{"type":"string","description":" The number of distinct IP addresses corresponding to the AS number\n\nExample: ` \"10\"`","title":"Distinct IP count","format":"uint64","x-displayname":"Distinct IP Count","x-ves-example":"10"},"human_request_count":{"type":"string","description":" Number of HTTP requests identified as human\n\nExample: ` \"20000\"`","title":"Human Request Count","format":"uint64","x-displayname":"Human Request Count","x-ves-example":"20000"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"0.9\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"0.9"}}},"reportingMaliciousBotASOrgDataV3":{"type":"object","description":"Malicious Bot ASOrg Data with action distribution","title":"Malicious Bot ASOrg Data V3","x-displayname":"Malicious Bot ASOrg Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotASOrgDataV3","properties":{"actions":{"type":"array","description":" Endpoint Traffic Actions\n\nExample: ` \"\"`","title":"Endpoint Traffic Actions","items":{"$ref":"#/components/schemas/reportingActionData"},"x-displayname":"Endpoint Traffic Actions"},"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"distinct_ip_count":{"type":"string","description":" The number of distinct IP addresses corresponding to the AS number\n\nExample: ` \"10\"`","title":"Distinct IP count","format":"uint64","x-displayname":"Distinct IP Count","x-ves-example":"10"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"94.6\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"94.6"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"94.6\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"94.6"}}},"reportingMaliciousBotAppData":{"type":"object","description":"Malicious Bot per App Data","title":"Malicious Bot per Application Data","x-displayname":"Malicious Bot per Application Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotAppData","properties":{"app_sentiment":{"type":"string","description":" The sentiment for the trend of malicious bot traffic per application\n\nExample: ` \"false\"`","title":"Trend Sentiment","x-displayname":"Trend Sentiment","x-ves-example":"false"},"application":{"type":"string","description":" Application Name\n\nExample: ` \"app A\"`","title":"Application Name","x-displayname":"Application Name","x-ves-example":"app A"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot per application\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests per application in total malicious request\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"malicious_bot_request_trend":{"type":"number","description":" The trend of malicious bot requests per application\n\nExample: ` -23.5 or null`","title":"Malicious Bot Request Trend","format":"double","x-displayname":"Malicious Bot Request Trend"}}},"reportingMaliciousBotAttackIntentASOrgData":{"type":"object","title":"Malicious Bot Event of Attack Intent by ASOrg Data","x-displayname":"Malicious Bot Event of Attack Intent by ASOrg Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentASOrgData","properties":{"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"bad_bot_count":{"type":"string","description":" Number of total Malicious Bot HTTP requests\n\nExample: ` \"20000\"`","title":"Malicious Bot Count","format":"uint64","x-displayname":"Events","x-ves-example":"20000"},"bad_bot_percentage":{"type":"number","description":" The percentage of traffic requests by as_org / total requests\n\nExample: ` \"0.9\"`","title":"Taffic Event Count Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"0.9"},"traffic_distribution":{"type":"array","description":" Taffic details for Attack Intent Distribution","title":"Attack Intent Distribution","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Traffic Details"}}},"reportingMaliciousBotAttackIntentIPData":{"type":"object","title":"Malicious Bot Event of Attack Intent by IP Data","x-displayname":"Malicious Bot Event of Attack Intent by IP Data ","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentIPData","properties":{"as_org":{"type":"string"},"bad_bot_count":{"type":"string","description":" Number of total Malicious Bot HTTP requests\n\nExample: ` \"20000\"`","title":"Malicious Bot Count","format":"uint64","x-displayname":"Events","x-ves-example":"20000"},"bad_bot_percentage":{"type":"number","description":" The percentage of traffic requests by source IP / total requests\n\nExample: ` \"0.9\"`","title":"Taffic Event Count Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"0.9"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Geolocation","x-ves-example":"US"},"ip":{"type":"string","description":" Source IP data\n\nExample: ` \"1.2.3.4\"`","title":"IP Address","x-displayname":"Source IP","x-ves-example":"1.2.3.4"},"traffic_distribution":{"type":"array","description":" Taffic details for Attack Intent Distribution","title":"Attack Intent Distribution","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Traffic Details"}}},"reportingMaliciousBotAttackIntentUAData":{"type":"object","title":"Malicious Bot Event of Attack Intent by UA Data","x-displayname":"Malicious Bot Event of Attack Intent by User Agent Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentUAData","properties":{"bad_bot_count":{"type":"string","description":" Number of total Malicious Bot HTTP requests\n\nExample: ` \"20000\"`","title":"Malicious Bot Count","format":"uint64","x-displayname":"Events","x-ves-example":"20000"},"bad_bot_percentage":{"type":"number","description":" The percentage of traffic requests by as_org / total requests\n\nExample: ` \"0.9\"`","title":"Taffic Event Count Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"0.9"},"browser":{"type":"string","description":" Browser name\n\nExample: ` \"Firefox\"`","title":"Browser","x-displayname":"Browser","x-ves-example":"Firefox"},"traffic_distribution":{"type":"array","description":" Taffic details for Attack Intent Distribution","title":"Attack Intent Distribution","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Traffic Details"},"ua":{"type":"string","description":" User Agent String\n\nExample: ` \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"`","title":"User Agent String","x-displayname":"User Agent String","x-ves-example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"}}},"reportingMaliciousBotIPData":{"type":"object","description":"Malicious Bot IP Data","title":"Malicious Bot IP Data","x-displayname":"Malicious Bot IP Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotIPData","properties":{"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"human_request_count":{"type":"string","description":" Number of HTTP requests identified as human\n\nExample: ` \"20000\"`","title":"Human Request Count","format":"uint64","x-displayname":"Human Request Count","x-ves-example":"20000"},"ip":{"type":"string","description":" IP Address\n\nExample: ` \"1.2.3.4\"`","title":"IP Address","x-displayname":"IP Address","x-ves-example":"1.2.3.4"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"0.9\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"0.9"}}},"reportingMaliciousBotIPDataV3":{"type":"object","description":"Malicious Bot IP Data with action distribution","title":"Malicious Bot IP Data V3","x-displayname":"Malicious Bot IP Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotIPDataV3","properties":{"actions":{"type":"array","description":" Endpoint Traffic Actions\n\nExample: ` \"\"`","title":"Endpoint Traffic Actions","items":{"$ref":"#/components/schemas/reportingActionData"},"x-displayname":"Endpoint Traffic Actions"},"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"ip":{"type":"string","description":" IP Address\n\nExample: ` \"1.2.3.4\"`","title":"IP Address","x-displayname":"IP Address","x-ves-example":"1.2.3.4"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"94.6\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"94.6"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"94.6\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"94.6"}}},"reportingMaliciousBotUAData":{"type":"object","description":"Malicious bot user agent data","title":"Malicious Bot User Agent Data","x-displayname":"Malicious Bot User Agent Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotUAData","properties":{"browser":{"type":"string","description":" Browser name\n\nExample: ` \"Firefox\"`","title":"Browser","x-displayname":"Browser","x-ves-example":"Firefox"},"human_request_count":{"type":"string","description":" Number of HTTP requests identified as human\n\nExample: ` \"20000\"`","title":"Human Request Count","format":"uint64","x-displayname":"Human Request Count","x-ves-example":"20000"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"0.9\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"0.9"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"0.9\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"0.9"},"ua":{"type":"string","description":" User Agent String\n\nExample: ` \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"`","title":"User Agent String","x-displayname":"User Agent String","x-ves-example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"}}},"reportingMaliciousBotUADataV4":{"type":"object","description":"Malicious bot user agent data with action distribution","title":"Malicious Bot User Agent Data V4","x-displayname":"Malicious Bot User Agent Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousBotUADataV4","properties":{"actions":{"type":"array","description":" Endpoint Traffic Actions\n\nExample: ` \"\"`","title":"Endpoint Traffic Actions","items":{"$ref":"#/components/schemas/reportingActionData"},"x-displayname":"Endpoint Traffic Actions"},"browser":{"type":"string","description":" Browser name\n\nExample: ` \"Firefox\"`","title":"Browser","x-displayname":"Browser","x-ves-example":"Firefox"},"malicious_bot_request_count":{"type":"string","description":" Number of HTTP requests identified as malicious bot\n\nExample: ` \"2000\"`","title":"Malicious Bot Request Count","format":"uint64","x-displayname":"Malicious Bot Request Count","x-ves-example":"2000"},"malicious_bot_request_percentage":{"type":"number","description":" The percentage of malicious bot requests in total requests\n\nExample: ` \"94.6\"`","title":"Malicious Bot Request Percentage","format":"double","x-displayname":"Malicious Bot Request Percentage","x-ves-example":"94.6"},"total_percentage":{"type":"number","description":" Total Percentage\n\nExample: ` \"94.6\"`","title":"Total Percentage","format":"double","x-displayname":"Total Percentage","x-ves-example":"94.6"},"ua":{"type":"string","description":" User Agent String\n\nExample: ` \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"`","title":"User Agent String","x-displayname":"User Agent String","x-ves-example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"}}},"reportingMaliciousReportAPPData":{"type":"object","description":"Malicious Report APP Data","title":"Malicious Report APP Data","x-displayname":"Malicious Report APP Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPData","properties":{"count":{"type":"string","description":" Count\n\nExample: ` \"100\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"100"},"name":{"type":"string","description":" Name\n\nExample: ` \"app\"`","title":"Name","x-displayname":"Name","x-ves-example":"app"},"percentage":{"type":"number","description":" Percentage\n\nExample: ` 50.0`","title":"Percentage","format":"double","x-displayname":"Percentage"},"time_series":{"type":"array","description":" APP Time Series\n\nExample: ` \"\"`","title":"APP Time Series","items":{"$ref":"#/components/schemas/reportingMaliciousReportAPPTimeSeries"},"x-displayname":"APP Time Series"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"},"total":{"type":"string","description":" Total\n\nExample: ` \"100\"`","title":"Total","format":"uint64","x-displayname":"Total","x-ves-example":"100"}}},"reportingMaliciousReportAPPTimeSeries":{"type":"object","description":"Malicious Report APP Time Series","title":"Malicious Report APP Time Series","x-displayname":"Malicious Report APP Time Series","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPTimeSeries","properties":{"count":{"type":"string","description":" Count\n\nExample: ` 10`","title":"Count","format":"uint64","x-displayname":"Count"},"percentage":{"type":"number","description":" Percentage\n\nExample: ` 50.0`","title":"Percentage","format":"double","x-displayname":"Percentage"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"},"total_count":{"type":"string","description":" Total Count\n\nExample: ` 10`","title":"Total Count","format":"uint64","x-displayname":"Total Count"}}},"reportingMaliciousReportAPPTimeSeriesResponse":{"type":"object","description":"Malicious Report APP Time Series Response","title":"MaliciousReportAPPTimeSeriesResponse","x-displayname":"Malicious Report APP Time Series Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPTimeSeriesResponse","properties":{"app_data":{"type":"array","description":" App Data\n\nExample: ` \"\"`","title":"App Data","items":{"$ref":"#/components/schemas/reportingMaliciousReportAPPData"},"x-displayname":"App Data"}}},"reportingMaliciousReportEndpointData":{"type":"object","description":"Malicious Report Endpoint Data","title":"MaliciousReportEndpointData","x-displayname":"Malicious Report Endpoint Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportEndpointData","properties":{"base_path":{"type":"string","description":" Base Path\n\nExample: ` \"/\"`","title":"Base Path","x-displayname":"Base Path","x-ves-example":"/"},"collapsed_url":{"type":"string","description":" Collapsed URL\n\nExample: ` \"/test/test\"`","title":"Collapsed URL","x-displayname":"Collapsed URL","x-ves-example":"/test/test"},"leaves_count":{"type":"string","description":" Number of leaves\n\nExample: ` \"10\"`","title":"Leaves Count","format":"uint64","x-displayname":"Leaves Count","x-ves-example":"10"},"level":{"type":"string","description":" Endpoint level\n\nExample: ` \"2\"`","title":"Level","format":"uint64","x-displayname":"Endpoint level","x-ves-example":"2"},"method":{"type":"string","description":" Method\n\nExample: ` \"GET\"`","title":"Method","x-displayname":"Method","x-ves-example":"GET"},"name":{"type":"string","description":" Name of the endpoint\n\nExample: ` \"/test\"`","title":"Name","x-displayname":"Name","x-ves-example":"/test"},"parent":{"type":"string","description":" Parent endpoint\n\nExample: ` \"/root\"`","title":"Parent","x-displayname":"Parent endpoint","x-ves-example":"/root"},"percentage":{"type":"number","description":" Percentage of the endpoint\n\nExample: ` \"10.0\"`","title":"Percentage","format":"double","x-displayname":"Percentage","x-ves-example":"10.0"},"request_percentage":{"type":"number","description":" Request Percentage\n\nExample: ` \"10.0\"`","title":"Request Percentage","format":"double","x-displayname":"Request Percentage","x-ves-example":"10.0"}}},"reportingMaliciousReportEndpointsResponse":{"type":"object","description":"Malicious Report Endpoints Response","title":"MaliciousReportEndpointsResponse","x-displayname":"Malicious Report Endpoints Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportEndpointsResponse","properties":{"endpoint_data":{"type":"array","description":" Malicious Report Endpoints Response\n\nExample: ` \"\"`","title":"Malicious Report Endpoints Response","items":{"$ref":"#/components/schemas/reportingMaliciousReportEndpointData"},"x-displayname":"Malicious Report Endpoints Response"}}},"reportingMaliciousReportTransactionsData":{"type":"object","description":"Malicious Report Transactions Data","title":"MaliciousReportTransactionsData","x-displayname":"Malicious Report Transactions Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportTransactionsData","properties":{"ASN":{"type":"string","description":" ASN\n\nExample: ` \"10\"`","title":"ASN","format":"uint64","x-displayname":"ASN","x-ves-example":"10"},"BFP":{"type":"string","description":" BFP\n\nExample: ` \"10\"`","title":"BFP","format":"uint64","x-displayname":"BFP","x-ves-example":"10"},"HFP":{"type":"string","description":" HFP\n\nExample: ` \"10\"`","title":"HFP","format":"uint64","x-displayname":"HFP","x-ves-example":"10"},"IP":{"type":"string","description":" IP\n\nExample: ` \"10\"`","title":"IP","format":"uint64","x-displayname":"IP","x-ves-example":"10"},"UFP":{"type":"string","description":" UFP\n\nExample: ` \"10\"`","title":"UFP","format":"uint64","x-displayname":"UFP","x-ves-example":"10"},"attack_intent_distribution":{"type":"array","description":" Attack Intent Distribution","title":"Attack Intent Distribution","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Attack Intent Distribution"},"count":{"type":"string","description":" Count\n\nExample: ` \"10\"`","title":"Count","format":"uint64","x-displayname":"Count","x-ves-example":"10"},"name":{"type":"string","description":" Name\n\nExample: ` \"WIN\"`","title":"Name","x-displayname":"Name","x-ves-example":"WIN"},"reason_code_distribution":{"type":"array","description":" Reason Code Distribution","title":"Reason Code Distribution","items":{"$ref":"#/components/schemas/reportingDistributionData"},"x-displayname":"Bad Bot Reason Code Distribution"},"user_agent":{"type":"string","description":" User Agent\n\nExample: ` \"10\"`","title":"User Agent","format":"uint64","x-displayname":"User Agent","x-ves-example":"10"}}},"reportingMaliciousReportTransactionsResponse":{"type":"object","description":"Malicious Report Transactions Response","title":"MaliciousReportTransactionsResponse","x-displayname":"Malicious Report Transactions Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousReportTransactionsResponse","properties":{"malicious_bot":{"type":"array","description":" Malicious Report Transactions Response\n\nExample: ` \"\"`","title":"Malicious Report Transactions Response","items":{"$ref":"#/components/schemas/reportingMaliciousReportTransactionsData"},"x-displayname":"Malicious Report Transactions Response"}}},"reportingMaliciousTrafficOverviewActionsResponse":{"type":"object","description":"Malicious Bot Taffic Overview in Actions Response","title":"MaliciousTrafficOverviewActionsResponse","x-displayname":"Malicious Bot Taffic Overview in Actions","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewActionsResponse","properties":{"flagged_count":{"type":"string","description":" The total number of malicious bot traffic in flagged.\n\nExample: ` 43`","title":"Flagged Count","format":"uint64","x-displayname":"Flagged Count"},"flagged_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count\n\nExample: ` 43.7`","title":"Flagged Count Percentage","format":"double","x-displayname":"Flagged Count Percentage"},"flagged_previous":{"type":"string","description":" The total number of malicious bot traffic in flagged within the previous specified time interval.\n\nExample: ` 34`","title":"Flagged count in the previous time interval","format":"uint64","x-displayname":"Flagged Count in last X days"},"flagged_sentiment":{"type":"string","description":" The sentiment for the trend of malicious traffic in flagged\n\nExample: ` \"true\"`","title":"Flagged Sentiment","x-displayname":"Flagged Sentiment","x-ves-example":"true"},"flagged_trend":{"type":"number","description":" Trend of the number of malicious bot traffic in flagged\n\nExample: ` 0.4 or null`","title":"Flagged Trend","format":"double","x-displayname":"Flagged Trend"},"mitigated_count":{"type":"string","description":" The total number of malicious bot traffic in mitigated.\n\nExample: ` 24`","title":"Mitigated Count","format":"uint64","x-displayname":"Mitigated Count"},"mitigated_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count\n\nExample: ` 25.7`","title":"Mitigated Count Percentage","format":"double","x-displayname":"Mitigated Count Percentage"},"mitigated_previous":{"type":"string","description":" The total number of malicious bot traffic in mitigated within the previous specified time interval.\n\nExample: ` 12`","title":"Mitigated count in the previous time interval","format":"uint64","x-displayname":"Mitigated Count in last X days"},"mitigated_sentiment":{"type":"string","description":" The sentiment for the trend of malicious traffic in mitigated\n\nExample: ` \"false\"`","title":"Mitigated Sentiment","x-displayname":"Mitigated Sentiment","x-ves-example":"false"},"mitigated_trend":{"type":"number","description":" Trend of the number of malicious bot traffic in mitigated\n\nExample: ` 0.3 or null`","title":"Mitigated Trend","format":"double","x-displayname":"Mitigated Trend"},"total":{"type":"string","description":" The total number of malicious bot traffic.\n\nExample: ` 100`","title":"Total Count","format":"uint64","x-displayname":"Total Count"},"unknown_count":{"type":"string","description":" The total number of malicious bot traffic in Unknown.\n\nExample: ` 23`","title":"Unknown Count","format":"uint64","x-displayname":"Unknown Count"},"unknown_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count\n\nExample: ` 45.7`","title":"Unknown Count Percentage","format":"double","x-displayname":"Unknown Count Percentage"}}},"reportingMaliciousTrafficOverviewActionsV2Response":{"type":"object","description":"Malicious Bot Taffic in Actions Response V2","title":"MaliciousTrafficOverviewActionsV2Response","x-displayname":"Malicious Bot Taffic Overview in Actions V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewActionsV2Response","properties":{"actions":{"type":"array","title":"x-displayName: \"Action taken Details\"","items":{"$ref":"#/components/schemas/reportingActionTakenData"}}}},"reportingMaliciousTrafficOverviewMetricsResponse":{"type":"object","description":"Malicious Traffic Overview Metrics Response","title":"MaliciousTrafficOverviewMetricsResponse","x-displayname":"Malicious Traffic Overview Metrics Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewMetricsResponse","properties":{"ASN":{"type":"string","description":" ASN\n\nExample: ` \"100\"`","title":"ASN","format":"uint64","x-displayname":"ASN","x-ves-example":"100"},"BFP":{"type":"string","description":" BFP\n\nExample: ` \"100\"`","title":"BFP","format":"uint64","x-displayname":"BFP","x-ves-example":"100"},"HFP":{"type":"string","description":" HFP\n\nExample: ` \"100\"`","title":"HFP","format":"uint64","x-displayname":"HFP","x-ves-example":"100"},"IP":{"type":"string","description":" IP\n\nExample: ` \"100\"`","title":"IP","format":"uint64","x-displayname":"IP","x-ves-example":"100"},"UFP":{"type":"string","description":" UFP\n\nExample: ` \"100\"`","title":"UFP","format":"uint64","x-displayname":"UFP","x-ves-example":"100"},"user_agent":{"type":"string","description":" User Agent\n\nExample: ` \"100\"`","title":"User Agent","format":"uint64","x-displayname":"User Agent","x-ves-example":"100"}}},"reportingMaliciousTrafficTimeseriesActions":{"type":"object","description":"Shape Bot Defense malicious traffic overview timeseries in actions value","title":"MaliciousTrafficOverviewTimeseriesActions","x-displayname":"Malicius Traffic Overview Timeseries in Actions","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActions","properties":{"flagged_count":{"type":"string","description":" The number of malicious bot traffic in flagged.\n\nExample: ` 43`","title":"Flagged Count","format":"uint64","x-displayname":"Flagged Count"},"flagged_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count\n\nExample: ` 74.3`","title":"Flagged Count Percentage","format":"double","x-displayname":"Flagged  Count Percentage"},"mitigated_count":{"type":"string","description":" The number of malicious bot traffic in mitigated.\n\nExample: ` 24`","title":"Mitigated Count","format":"uint64","x-displayname":"Mitigated Count"},"mitigated_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count\n\nExample: ` 25.7`","title":"Mitigated Count Percentage","format":"double","x-displayname":"Mitigated Count Percentage"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"},"unknown_count":{"type":"string","description":" The number of malicious bot traffic that are unknown.\n\nExample: ` 24`","title":"Unknown Count","format":"uint64","x-displayname":"Unknown Count"},"unknown_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count\n\nExample: ` 74.3`","title":"Unknown Count Percentage","format":"double","x-displayname":"Unknown  Count Percentage"}}},"reportingMaliciousTrafficTimeseriesActionsResponse":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview timeseries in actions value","title":"Malicious Traffic Timeseries in Actions Response","x-displayname":"Malicious Traffic Timeseries in Actions Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsResponse","properties":{"values":{"type":"array","description":" Maclicious Traffic Overview Timeseries in Actions","title":"Malicious Traffic in Actions Timeseries Values","items":{"$ref":"#/components/schemas/reportingMaliciousTrafficTimeseriesActions"},"x-displayname":"Malicious Traffic Timeseries in Actions Values"}}},"reportingMaliciousTrafficTimeseriesActionsResponseV2":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview timeseries in actions value","title":"Malicious Traffic Timeseries in Actions Response V2","x-displayname":"Malicious Traffic Timeseries in Actions Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsResponseV2","properties":{"values":{"type":"array","description":" Maclicious Traffic Overview Timeseries in Actions\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.min_items: 0\n","title":"Malicious Traffic in Actions Timeseries Values","maxItems":32,"items":{"$ref":"#/components/schemas/reportingMaliciousTrafficTimeseriesActionsV2"},"x-displayname":"Malicious Traffic Timeseries in Actions Values","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.min_items":"0"}}}},"reportingMaliciousTrafficTimeseriesActionsV2":{"type":"object","description":"Shape Bot Defense malicious traffic overview timeseries in actions value","title":"MaliciousTrafficOverviewTimeseriesActionsV2","x-displayname":"Malicius Traffic Overview Timeseries in Actions V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsV2","properties":{"name":{"type":"string","description":" The name of the Traffic Type\n\nExample: ` \"Blocked, Challenged, Flagged, Redirected, Transformed, Undefined\"`","title":"Name","x-displayname":"Name","x-ves-example":"Blocked, Challenged, Flagged, Redirected, Transformed, Undefined"},"time_series":{"type":"array","description":" Time Series data for each Malicious Traffic Action type","title":"Timeseries Values","items":{"$ref":"#/components/schemas/reportingTimeSeriesDataV2"},"x-displayname":"Timeseries values"}}},"reportingMethodFilter":{"type":"object","description":"Query Filter by traffic method strings","title":"Traffic Method Filter","x-displayname":"Traffic Method Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MethodFilter","properties":{"method_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['POST', 'GET']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Method Strings","minItems":1,"maxItems":64,"items":{"type":"string"},"x-displayname":"Method Strings","x-ves-example":"['POST', 'GET']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"op":{"$ref":"#/components/schemas/reportingFilterOperator"}}},"reportingMonthlyUsageSummaryData":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.MonthlyUsageSummaryData","properties":{"all":{"type":"string","description":" All traffic counter\n\nExample: ` \"34234\"`","title":"All Traffic","format":"uint64","x-displayname":"All Traffic","x-ves-example":"34234"},"js":{"type":"string","description":" Counts the number of Bot JS requests\n\nExample: ` \"342\"`","title":"JS Traffic","format":"uint64","x-displayname":"JS Traffic","x-ves-example":"342"},"mobile_config":{"type":"string","description":" Counts the number of Bot Mobile SDK Config requests\n\nExample: ` \"1509\"`","title":"Mobile SDK Config Traffic","format":"uint64","x-displayname":"Mobile SDK Config Traffic","x-ves-example":"1509"},"month":{"type":"string","description":" Month Identifier, format: YYYYMM\n\nExample: ` \"202209\"`","title":"Month","x-displayname":"Month","x-ves-example":"202209"}}},"reportingOSFilter":{"type":"object","description":"Query Filter by os filter strings","title":"Header OS Filter","x-displayname":"Header OS Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.OSFilter","properties":{"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"os_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['win', 'linux']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"OS Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"OS Strings","x-ves-example":"['win', 'linux']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"reportingPagination":{"type":"object","description":"Pagination with number and size","title":"Pagination","x-displayname":"Pagination","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.Pagination","properties":{"page_number":{"type":"integer","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Page Number","format":"int64","x-displayname":"Page Number","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"page_size":{"type":"integer","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Page Size","format":"int64","x-displayname":"Page Size","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"500"}}}},"reportingPeerGroupData":{"type":"object","title":"Peer Group Data","x-displayname":"Peer Group Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerGroupData","properties":{"name":{"type":"string","description":" The Name of Item\n\nExample: ` \"human\"`","title":"Item Name","x-displayname":"Name","x-ves-example":"human"},"peer_count":{"type":"string","description":" The count of Peer of the Item\n\nExample: ` \"100\"`","title":"Peer Count","format":"uint64","x-displayname":"Peer Count","x-ves-example":"100"},"peer_percentage":{"type":"number","description":" The Peer Percentage of the Item\n\nExample: ` \"25.3\"`","title":"Peer Percentage","format":"double","x-displayname":"Peer Percentage","x-ves-example":"25.3"},"self_count":{"type":"string","description":" The count of Self of the item\n\nExample: ` \"100\"`","title":"Self Count","format":"uint64","x-displayname":"Self Count","x-ves-example":"100"},"self_percentage":{"type":"number","description":" The Self Percentage of the Item\n\nExample: ` \"25.3\"`","title":"Self Percentage","format":"double","x-displayname":"Self Percentage","x-ves-example":"25.3"}}},"reportingPeerGroupRequest":{"type":"object","description":"Request for Shape Bot Defense Peer Group Peer Benchmarking","title":"PeerGroupRequest","x-displayname":"Peer Group Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest","properties":{"end_time":{"type":"string","description":" end time of the query period\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"limit":{"type":"integer","description":" limits the number of transactions returned in the response\n Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.\n\nExample: ` \"100\"`","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"100"},"rank_by":{"type":"string","description":" rank by self or peer\n\nExample: ` \"self\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.in: [\\\"self\\\",\\\"peer\\\"]\n","title":"Rankby","x-displayname":"Rank by","x-ves-example":"self","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.in":"[\\\"self\\\",\\\"peer\\\"]"}},"start_time":{"type":"string","description":" start time of the query period\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingPeerGroupResponse":{"type":"object","description":"The Response contains the total and detail of the Peer Group data","title":"Peer Group Response","x-displayname":"Response for Peer Group Peer Benchmarking","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerGroupResponse","properties":{"details":{"type":"array","title":"Response for Peer Group Peer Benchmarking","items":{"$ref":"#/components/schemas/reportingPeerGroupData"},"x-displayname":"Peer Group Top Good Bots Details"}}},"reportingPeerGroupTrafficOverviewResponse":{"type":"object","description":"The Response contains the total and detail of the Peer Group data","title":"Peer Group Traffic Overview Response","x-displayname":"Response for Peer Group Peer Benchmarking Traffic Overview","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerGroupTrafficOverviewResponse","properties":{"details":{"type":"array","title":"Response for Peer Group Peer Benchmarking Traffic Overview","items":{"$ref":"#/components/schemas/reportingPeerGroupData"},"x-displayname":"Peer Group Traffic Overview Details"},"peer_percentage":{"type":"number","description":" The Peer Percentage of the Item\n\nExample: ` \"25.3\"`","title":"Peer Percentage","format":"double","x-displayname":"Peer Percentage","x-ves-example":"25.3"},"peer_total":{"type":"string","description":" The total number of Peer of the Item\n\nExample: ` \"100\"`","title":"Peer Total","format":"uint64","x-displayname":"Peer Total","x-ves-example":"100"},"self_percentage":{"type":"number","description":" The Self Percentage of the Item\n\nExample: ` \"25.3\"`","title":"Self Percentage","format":"double","x-displayname":"Self Percentage","x-ves-example":"25.3"},"self_total":{"type":"string","description":" The total number of Self of the item\n\nExample: ` \"100\"`","title":"Self Total","format":"uint64","x-displayname":"Self Total","x-ves-example":"100"}}},"reportingPeerStatusRequest":{"type":"object","title":"Peer Status Request","x-displayname":"Request for checking peers status","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerStatusRequest"},"reportingPeerStatusResponse":{"type":"object","description":"The Response for checking if the tenant has peers or not","title":"PeerStatusResponse","x-displayname":"Has_Peers Status Response ","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.PeerStatusResponse","properties":{"has_peers":{"type":"boolean","description":" the tenat has peers or not","title":"has_peers","format":"boolean","x-displayname":"has peers status"}}},"reportingRefererFilter":{"type":"object","description":"Query Filter by referer filter strings","title":"Header Reference Filter","x-displayname":"Header Reference Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.RefererFilter","properties":{"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"referer_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['http://172.29.42.57/index.php']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Inference Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Referer Strings","x-ves-example":"['http://172.29.42.57/index.php']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"reportingReportEndpointDataV2":{"type":"object","description":"Report Endpoint Data V2","title":"ReportEndpointDataV2","x-displayname":"Report Endpoint Data V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ReportEndpointDataV2","properties":{"automated_events":{"type":"string","description":" Automated Events\n\nExample: ` \"10\"`","title":"Automated Events","format":"uint64","x-displayname":"Automated Events","x-ves-example":"10"},"automated_percentage":{"type":"number","description":" Automated Percentage\n\nExample: ` \"10\"`","title":"Automated Percentage","format":"double","x-displayname":"Automated Percentage","x-ves-example":"10"},"base_path":{"type":"string","description":" Base Path\n\nExample: ` \"/\"`","title":"Base Path","x-displayname":"Base Path","x-ves-example":"/"},"collapsed_url":{"type":"string","description":" Collapsed URL\n\nExample: ` \"/test/test\"`","title":"Collapsed URL","x-displayname":"Collapsed URL","x-ves-example":"/test/test"},"events":{"type":"string","description":" Events\n\nExample: ` \"10\"`","title":"Events","format":"uint64","x-displayname":"Events","x-ves-example":"10"},"flagged_events":{"type":"string","description":" Flagged Events\n\nExample: ` \"10\"`","title":"Flagged Events","format":"uint64","x-displayname":"Flagged Events","x-ves-example":"10"},"flagged_percentage":{"type":"number","description":" Flagged Percentage\n\nExample: ` \"10\"`","title":"Flagged Percentage","format":"double","x-displayname":"Flagged Percentage","x-ves-example":"10"},"human_events":{"type":"string","description":" Human Events\n\nExample: ` \"10\"`","title":"Human Events","format":"uint64","x-displayname":"Human Events","x-ves-example":"10"},"human_percentage":{"type":"number","description":" Human Percentage\n\nExample: ` \"10\"`","title":"Human Percentage","format":"double","x-displayname":"Human Percentage","x-ves-example":"10"},"method":{"type":"string","description":" Method\n\nExample: ` \"GET\"`","title":"Method","x-displayname":"Method","x-ves-example":"GET"},"mitigated_events":{"type":"string","description":" Mitigated Events\n\nExample: ` \"10\"`","title":"Mitigated Events","format":"uint64","x-displayname":"Mitigated Events","x-ves-example":"10"},"mitigated_percentage":{"type":"number","description":" Mitigated Percentage\n\nExample: ` \"10\"`","title":"Mitigated Percentage","format":"double","x-displayname":"Mitigated Percentage","x-ves-example":"10"},"request_percentage":{"type":"number","description":" Request Percentage\n\nExample: ` \"10.0\"`","title":"Request Percentage","format":"double","x-displayname":"Request Percentage","x-ves-example":"10.0"},"undefined_events":{"type":"string","description":" Undefined Events\n\nExample: ` \"10\"`","title":"Undefined Events","format":"uint64","x-displayname":"Undefined Events","x-ves-example":"10"},"undefined_percentage":{"type":"number","description":" Undefined Percentage\n\nExample: ` \"10\"`","title":"Undefined Percentage","format":"double","x-displayname":"Undefined Percentage","x-ves-example":"10"}}},"reportingReportEndpointsResponse":{"type":"object","description":"Report Endpoints Response","title":"ReportEndpointsResponse","x-displayname":"Report Endpoints Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.ReportEndpointsResponse","properties":{"endpoint_data":{"type":"array","description":" Report Endpoints Response\n\nExample: ` \"\"`","title":"Report Endpoints Response","items":{"$ref":"#/components/schemas/reportingReportEndpointDataV2"},"x-displayname":"Report Endpoints Response"}}},"reportingSortOption":{"type":"object","description":"Query Result Sort Option","title":"Sort Option","x-displayname":"Sort Option","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.SortOption","properties":{"key":{"$ref":"#/components/schemas/reportingFilterKey"},"order":{"$ref":"#/components/schemas/schemaSortOrder"}}},"reportingTimeSeriesDataV2":{"type":"object","description":"Time Series Data","title":"Time Series Data","x-displayname":"Time Series Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TimeSeriesDataV2","properties":{"count":{"type":"string","description":" Count\n\nExample: ` 10`","title":"Count","format":"uint64","x-displayname":"Count"},"percentage":{"type":"number","description":" Percentage\n\nExample: ` 50.0`","title":"Percentage","format":"double","x-displayname":"Percentage"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"}}},"reportingTimeSeriesGraphData":{"type":"object","description":"The data for Timeseries Graph","title":"Timeseries Graph Data","x-displayname":"Timeseries Graph Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TimeSeriesGraphData","properties":{"name":{"type":"string","description":" Name\n\nExample: ` \"January\"`","title":"Name","x-displayname":"Name","x-ves-example":"January"},"time_series_data":{"type":"array","description":" Time Series Data\n\nExample: ` \"\"`","title":"Time Series Data","items":{"$ref":"#/components/schemas/reportingTimeSeriesDataV2"},"x-displayname":"Time Series Data"}}},"reportingTimeSeriesGraphMinimalData":{"type":"object","description":"Response that contains timeseries against each traffic or any other type","title":"TimeSeriesGraphMinimalData","x-displayname":"Timeseries Graph Minimal Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TimeSeriesGraphMinimalData","properties":{"name":{"type":"string","description":" The name of the Traffic Type\n\nExample: ` \"Human, automated, allowListed, interstitual\"`","title":"Name","x-displayname":"Name","x-ves-example":"Human, automated, allowListed, interstitual"},"time_series":{"type":"array","description":" Time Series data for each traffic type","title":"Timeseries Values","items":{"$ref":"#/components/schemas/reportingTimeSeriesMinimalData"},"x-displayname":"Timeseries values"}}},"reportingTimeSeriesMinimalData":{"type":"object","description":"Requests over time","title":"Requests Time Series","x-displayname":"Requests Time Series","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TimeSeriesMinimalData","properties":{"count":{"type":"string","description":" Number of requests counted at specific time period marked by timestamp\n\nExample: ` 342`","title":"Number of Requests","format":"uint64","x-displayname":"Number of Requests"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"}}},"reportingTopAttackIntentData":{"type":"object","description":"Top Attack Intent Data","title":"Top Attack Intent Data","x-displayname":"Top Attack Intent Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackIntentData","properties":{"color_alert":{"type":"boolean","description":" Color Alert\n\nExample: ` \"false\"`","title":"Color Alert","format":"boolean","x-displayname":"color_alert","x-ves-example":"false"},"events":{"type":"string","description":" Events\n\nExample: ` \"100\"`","title":"Events","format":"uint64","x-displayname":"Events","x-ves-example":"100"},"link":{"type":"string","description":" Link of certain OWASP page\n\nExample: ` \"link\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Link","x-displayname":"Link","x-ves-example":"link","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"percentage":{"type":"number","description":" The Percentage of the number of each attack intent type / the total traffic or bad bot\n\nExample: ` 50.0`","title":"Attack Intent Type Percentage","format":"double","x-displayname":"Percentage"},"sentiment":{"type":"string","description":" Sentiment\n\nExample: ` \"null\"`","title":"Sentiment","x-displayname":"sentiment","x-ves-example":"null"},"trend":{"type":"number","description":" Trend\n\nExample: ` \"0.5\" or null`","title":"Trend","format":"double","x-displayname":"Trend"},"type":{"type":"string","description":" Attack Intent Type\n\nExample: ` \"Carding\"`","title":"Attack Intent Type","x-displayname":"Type","x-ves-example":"Carding"}}},"reportingTopAttackIntentResponse":{"type":"object","description":"The Response of Top Attack Intent  API","title":"Top Attack Intent  Response","x-displayname":"Top Attack Intent  Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackIntentResponse","properties":{"attack_intents":{"type":"array","title":"Attack Intent Widget Data","items":{"$ref":"#/components/schemas/reportingTopAttackIntentData"},"x-displayname":"Attack Intent List"},"total":{"type":"string","description":" Total Events\n\nExample: ` \"158\"`","title":"Total","format":"uint64","x-displayname":"Total","x-ves-example":"158"}}},"reportingTopAttackedBFPResponse":{"type":"object","description":"Top Attacked BFP Response","title":"TopAttackedBFPResponse","x-displayname":"Top Attacked BFP Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackedBFPResponse","properties":{"attacked_bfp":{"type":"array","description":" Top Attacked BFP\n\nExample: ` \"\"`","title":"Top Attacked BFP","items":{"$ref":"#/components/schemas/reportingAttackedBFPData"},"x-displayname":"Top Attacked BFP"}}},"reportingTopAttackedEndpointsResponse":{"type":"object","description":"Response for top attacked application endpoints","title":"TopAttackedEndpointsResponse","x-displayname":"Response for Top Attacked Endpoints","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponse","properties":{"attacked_endpoints":{"type":"array","description":" Top attacked application endpoints\n\nExample: ` \"\"`","title":"Top Attacked Endpoints","items":{"$ref":"#/components/schemas/reportingAttackedEndpointData"},"x-displayname":"Top Attacked Endpoints"}}},"reportingTopAttackedEndpointsResponseV2":{"type":"object","description":"Response for top attacked application endpoints","title":"TopAttackedEndpointsResponseV2","x-displayname":"Response V2 for Top Attacked Endpoints","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponseV2","properties":{"attacked_endpoints":{"type":"array","description":" Top attacked application endpoints\n\nExample: ` \"\"`","title":"Top Attacked Endpoints","items":{"$ref":"#/components/schemas/reportingAttackedEndpointDataV2"},"x-displayname":"Top Attacked Endpoints"}}},"reportingTopAttackedEndpointsResponseV4":{"type":"object","description":"Response for top attacked application endpoints","title":"TopAttackedEndpointsResponseV4","x-displayname":"Response V2 for Top Attacked Endpoints","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponseV4","properties":{"attacked_endpoints":{"type":"array","description":" Top attacked application endpoints\n\nExample: ` \"\"`","title":"Top Attacked Endpoints","items":{"$ref":"#/components/schemas/reportingAttackedEndpointDataV4"},"x-displayname":"Top Attacked Endpoints"}}},"reportingTopAutomationTypesResponse":{"type":"object","description":"Response for top malicious bot automation types","title":"TopAutomationTypesResponse","x-displayname":"Response for Top Malicious Bot Automation Types","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopAutomationTypesResponse","properties":{"automation_types":{"type":"array","description":" Top malicious bot automation types\n\nExample: ` \"\"`","title":"Top Malicious Bot Automation Types","items":{"$ref":"#/components/schemas/reportingAutomationTypeData"},"x-displayname":"Top Malicious Bot Automation Types"}}},"reportingTopCategoriesResponse":{"type":"object","description":"Response for top flow label categories","title":"Categories Response","x-displayname":"Response for Top Categories","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopCategoriesResponse","properties":{"categories":{"type":"array","description":" Requests sorted by flow label categories over a requested period of time (as time series)\n\nExample: ` \"\"`","title":"Requests by Flow Label Categories","items":{"$ref":"#/components/schemas/reportingCategoriesData"},"x-displayname":"Requests by Categories"},"total_requests":{"type":"string","description":" Total number of requests for requested period\n\nExample: ` 100`","title":"Total Number of Requests","format":"uint64","x-displayname":"Total Number of Requests"}}},"reportingTopEndpointLabelsResponse":{"type":"object","description":"Response for Top Endpoint Labels","title":"EndpointLabelsResponse","x-displayname":"Response for Top Endpoint Labels","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopEndpointLabelsResponse","properties":{"endpoint_labels":{"type":"array","description":" Over a time period\n\nExample: ` \"\"`","title":"Endpoint Labels Requests","items":{"$ref":"#/components/schemas/reportingEndpointLabelsData"},"x-displayname":"Endpoint Labels Requests"},"total_requests":{"type":"string","description":" Total number of requests\n\nExample: ` 100`","title":"Total number of requests","format":"uint64","x-displayname":"Total Number of Requests"}}},"reportingTopGoodBotsData":{"type":"object","description":"Good bots data","title":"Good Bots Data","x-displayname":"Good Bots Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopGoodBotsData","properties":{"name":{"type":"string","description":" Name\n\nExample: ` \"Google Search\"`","title":"Name","x-displayname":"Name","x-ves-example":"Google Search"},"traffic_usage_count":{"type":"string","description":" Traffic Usage Count\n\nExample: ` \"100\"`","title":"Traffic Usage Count","format":"uint64","x-displayname":"Traffic Usage Count","x-ves-example":"100"},"traffic_usage_percentage":{"type":"number","description":" Traffic Usage Percentage\n\nExample: ` \"0.5\"`","title":"Traffic Usage Percentage","format":"double","x-displayname":"Traffic Usage Percentage","x-ves-example":"0.5"},"type":{"type":"string","description":" Name\n\nExample: ` \"Search\"`","title":"Type","x-displayname":"Type","x-ves-example":"Search"}}},"reportingTopGoodBotsResponse":{"type":"object","description":"Response for top good bots","title":"TopGoodBotsResponse","x-displayname":"Response for Top God Bots","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopGoodBotsResponse","properties":{"good_bots":{"type":"array","description":" Top good bots\n\nExample: ` \"\"`","title":"Top Good Bots","items":{"$ref":"#/components/schemas/reportingTopGoodBotsData"},"x-displayname":"Top Good Bots"}}},"reportingTopGoodBotsResponseV2":{"type":"object","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopGoodBotsResponseV2","properties":{"good_bots":{"type":"array","description":" Top good bots\n\nExample: ` \"\"`","title":"Top Good Bots","items":{"$ref":"#/components/schemas/reportingTopGoodBotsData"},"x-displayname":"Top Good Bots"},"top_good_bots_percentage":{"type":"number","description":" Top Good Bots Count / Total Good Bots Count\n\nExample: ` \"50.2\"`","title":"Top Good Bots Percentage","format":"double","x-displayname":"Top Good Bot Percentage","x-ves-example":"50.2"},"total_good_bots":{"type":"string","description":" Total Good Bots Traffic Count\n\nExample: ` \"100\"`","title":"Total Good Bot Traffic Count","format":"uint64","x-displayname":"Total Good Bots Traffic Count","x-ves-example":"100"}}},"reportingTopHumanBrowserResponse":{"type":"object","description":"Top Human Browser Response","title":"TopHumanBrowserResponse","x-displayname":"Top Human Browser Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopHumanBrowserResponse","properties":{"human_browser_data":{"type":"array","description":" Top Human Browser Response\n\nExample: ` \"chrome\"`","title":"Top Human Browser Response","items":{"$ref":"#/components/schemas/reportingHumanBrowserData"},"x-displayname":"Top Human Browser Response","x-ves-example":"chrome"}}},"reportingTopHumanDeviceResponse":{"type":"object","description":"Top Human Device Response","title":"TopHumanDeviceResponse","x-displayname":"Top Human Device Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopHumanDeviceResponse","properties":{"human_device_data":{"type":"array","description":" Top Human Device Response\n\nExample: ` \"iPhone\"`","title":"Top Human Device Response","items":{"$ref":"#/components/schemas/reportingHumanDeviceData"},"x-displayname":"Top Human Device Response","x-ves-example":"iPhone"}}},"reportingTopHumanGeolocationResponse":{"type":"object","description":"Top Human Geolocation Response","title":"TopHumanGeolocationResponse","x-displayname":"Top Human Geolocation Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopHumanGeolocationResponse","properties":{"human_geolocation_data":{"type":"array","description":" Top Human Geolocation Response\n\nExample: ` \"US\"`","title":"Top Human Geolocation Response","items":{"$ref":"#/components/schemas/reportingHumanGeolocationData"},"x-displayname":"Top Human Geolocation Response","x-ves-example":"US"}}},"reportingTopHumanPlatformResponse":{"type":"object","description":"Top Human Platform Response","title":"TopHumanPlatformResponse","x-displayname":"Top Human Platform Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopHumanPlatformResponse","properties":{"human_platform_data":{"type":"array","description":" Top Human Platform Response\n\nExample: ` \"iOS\"`","title":"Top Human Platform Response","items":{"$ref":"#/components/schemas/reportingHumanPlatformData"},"x-displayname":"Top Human Platform Response","x-ves-example":"iOS"}}},"reportingTopLatencyOverviewAppsData":{"type":"object","description":"Top Latency Applications","title":"Top Latency Apps Data","x-displayname":"Top Latency Apps Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewAppsData","properties":{"application":{"type":"string","description":" Application","title":"x-displayName: \"Application\"\nx-example: \"AppA\"\nApplication","x-displayname":"Application","x-ves-example":"AppA"},"counts":{"type":"string","description":" counts\n\nExample: ` \"100\"`","title":"x-displayName: \"Counts\"","format":"uint64","x-displayname":"Counts","x-ves-example":"100"},"latency":{"type":"string","description":" latency\n\nExample: ` \"123\"`","title":"x-displayName: \"Latency\"","format":"uint64","x-displayname":"Latency","x-ves-example":"123"},"sentiment":{"type":"string","description":" sentiment\n\nExample: ` \"false\"`","title":"x-displayName: \"Sentiment\"","x-displayname":"Sentiment","x-ves-example":"false"},"status":{"type":"string","description":" status\n\nExample: ` \"critical\"`","title":"x-displayName: \"Status\"","x-displayname":"Status","x-ves-example":"critical"},"trend":{"type":"number","description":" trend\n\nExample: ` \"0.34\" or null`","title":"x-displayName: \"Trend\"","format":"double","x-displayname":"Trend"}}},"reportingTopLatencyOverviewAppsResponse":{"type":"object","description":"Bot API Latency Across Top Protected Apps Overview Apps Response","title":"Top Latency Overview Apps Response","x-displayname":"Top Latency Overview Apps Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewAppsResponse","properties":{"applications":{"type":"array","description":" Top Latency Overview Apps","title":"x-displayName: \"Top Latency Overview Apps\"\nx-example: \"\"\nTop Latency Overview Apps","items":{"$ref":"#/components/schemas/reportingTopLatencyOverviewAppsData"},"x-displayname":"Top Latency Overview Apps"}}},"reportingTopLatencyOverviewResponse":{"type":"object","description":"Bot API Latency Across Top Protected Apps Overview Response","title":"Top Latency Overview Response","x-displayname":"Top Latency Overview Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewResponse","properties":{"average_latency":{"type":"string","description":" average latency\n\nExample: ` \"60\"`","title":"x-displayName: \"Average Time\"","format":"uint64","x-displayname":"Average Time","x-ves-example":"60"},"critical":{"type":"string","description":" critical\n\nExample: ` \"123000\"`","title":"x-displayName: \"Critical\"","format":"uint64","x-displayname":"Critical","x-ves-example":"123000"},"high":{"type":"string","description":" high\n\nExample: ` \"234\"`","title":"x-displayName: \"High\"","format":"uint64","x-displayname":"High","x-ves-example":"234"},"low":{"type":"string","description":" low\n\nExample: ` \"235\"`","title":"x-displayName: \"Low\"","format":"uint64","x-displayname":"Low","x-ves-example":"235"},"previous_latency":{"type":"string","description":" previous latency\n\nExample: ` \"20\"`","title":"x-displayName: \"Previous\"","format":"uint64","x-displayname":"Previous","x-ves-example":"20"},"sentiment":{"type":"string","description":" sentiment\n\nExample: ` \"false\"`","title":"x-displayName: \"Sentiment\"","x-displayname":"Sentiment","x-ves-example":"false"},"trend":{"type":"number","description":" trend\n\nExample: ` \"0.34\" or null`","title":"x-displayName: \"Trend\"","format":"double","x-displayname":"Trend"}}},"reportingTopMaliciousBotsAttackIntentByASOrgResponse":{"type":"object","description":"Response for top bad bot events by ASN of Attack Intent Types","title":"TopMaliciousBotsAttackIntentByASOrgResponse","x-displayname":"Response for Top ASN of Attack Intent under bad bot traffic","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByASOrgResponse","properties":{"bad_bot_asn_data":{"type":"array","description":" The list of top source by ASN","title":"Top ASN event of Attack Intent under bad bot traffic","items":{"$ref":"#/components/schemas/reportingMaliciousBotAttackIntentASOrgData"},"x-displayname":"Top Event by ASN of Attack Intent"}}},"reportingTopMaliciousBotsAttackIntentByIPResponse":{"type":"object","description":"Response for top bad bot events by source IPs of Attack Intent Types","title":"TopMaliciousBotsAttackIntentByIPResponse","x-displayname":"Response for Top Source IP of Attack Intent under bad bot traffic","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByIPResponse","properties":{"bad_bot_ip_data":{"type":"array","description":" The list of top source by source IP","title":"Top IP source event of Attack Intent under bad bot traffic","items":{"$ref":"#/components/schemas/reportingMaliciousBotAttackIntentIPData"},"x-displayname":"Top Event by Souce IP of Attack Intent"}}},"reportingTopMaliciousBotsAttackIntentByUAResponse":{"type":"object","description":"Response for top bad bot events by User Agent of Attack Intent Types","title":"TopMaliciousBotsAttackIntentByUAResponse","x-displayname":"Response for Top User Agent of Attack Intent under bad bot traffic","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByUAResponse","properties":{"bad_bot_ua_data":{"type":"array","description":" The list of top source by UA","title":"Top UA event of Attack Intent under bad bot traffic","items":{"$ref":"#/components/schemas/reportingMaliciousBotAttackIntentUAData"},"x-displayname":"Top Event by User Agent of Attack Intent"}}},"reportingTopMaliciousBotsByASOrgResponse":{"type":"object","description":"Response for top malicious bots by AS Organizations","title":"TopMaliciousBotsByASOrgResponse","x-displayname":"Response for Top Malicious Bots by AS Organization","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByASOrgResponse","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by AS Organizations\n\nExample: ` \"\"    `","title":"Top Malicious Bot ASOrganizations","items":{"$ref":"#/components/schemas/reportingMaliciousBotASOrgData"},"x-displayname":"Top Malicious Bots by AS Organizations"}}},"reportingTopMaliciousBotsByASOrgResponseV3":{"type":"object","description":"Response for top malicious bots by AS Organizations with action distribution","title":"TopMaliciousBotsByASOrgResponseV3","x-displayname":"Response for Top Malicious Bots by AS Organization","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByASOrgResponseV3","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by AS Organizations\n\nExample: ` \"\"`","title":"Top Malicious Bot ASOrganizations","items":{"$ref":"#/components/schemas/reportingMaliciousBotASOrgDataV3"},"x-displayname":"Top Malicious Bots by AS Organizations"}}},"reportingTopMaliciousBotsByAppResponse":{"type":"object","description":"Response for top malicious bots by applications","title":"TopMaliciousBotsByAppResponse","x-displayname":"Response for Top Malicious Bots by Applications","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByAppResponse","properties":{"application_data":{"type":"array","description":" The list of top malicious bots by application\n\nExample: ` \"\"    `","title":"Top Malicious Bot App","items":{"$ref":"#/components/schemas/reportingMaliciousBotAppData"},"x-displayname":"Top Malicious Bots by Application Data"},"total_applications":{"type":"string","description":"\n\nExample: `8`","title":"Total number of Applications","format":"uint64","x-displayname":"The Total Number of Applications"}}},"reportingTopMaliciousBotsByIPResponse":{"type":"object","description":"Response for top malicious bots by source IPs","title":"TopMaliciousBotsByIPResponse","x-displayname":"Response for Top Malicious Bots by IP","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByIPResponse","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by source IP\n\nExample: ` \"\"    `","title":"Top Malicious Bot IPs","items":{"$ref":"#/components/schemas/reportingMaliciousBotIPData"},"x-displayname":"Top Malicious Bots by IP"}}},"reportingTopMaliciousBotsByIPResponseV3":{"type":"object","description":"Response for top malicious bots by source IPs with action distribution","title":"TopMaliciousBotsByIPResponseV3","x-displayname":"Response for Top Malicious Bots by IP","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByIPResponseV3","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by source IP\n\nExample: ` \"\"`","title":"Top Malicious Bot IPs","items":{"$ref":"#/components/schemas/reportingMaliciousBotIPDataV3"},"x-displayname":"Top Malicious Bots by IP"}}},"reportingTopMaliciousBotsByUAResponse":{"type":"object","description":"Response for top malicious bots by user agent string","title":"TopMaliciousBotsByUAResponse","x-displayname":"Response for Top Malicious Bots by User Agent String","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByUAResponse","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by User Agent String\n\nExample: ` \"\"    `","title":"Top Malicious Bots by User Agent","items":{"$ref":"#/components/schemas/reportingMaliciousBotUAData"},"x-displayname":"Top Malicious Bots by User Agent String"}}},"reportingTopMaliciousBotsByUAResponseV4":{"type":"object","description":"Response for top malicious bots by user agent string  with action distribution","title":"TopMaliciousBotsByUAResponseV4","x-displayname":"Response for Top Malicious Bots by User Agent String","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByUAResponseV4","properties":{"malicious_bots":{"type":"array","description":" The list of top malicious bots by User Agent String\n\nExample: ` \"\"`","title":"Top Malicious Bots by User Agent","items":{"$ref":"#/components/schemas/reportingMaliciousBotUADataV4"},"x-displayname":"Top Malicious Bots by User Agent String"}}},"reportingTopRequest":{"type":"object","description":"Request for top malicious bots","title":"TopRequest","x-displayname":"Request for Top Malicious Bots","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopRequest","properties":{"attack_type":{"type":"string","description":" \n Optional: this is the query parameter for top source of attack types\n Used in TopTafficEventsByIP\n\nExample: ` \"accountcreation\"`","title":"Attack Intent Type","x-displayname":"Attack Intent Type","x-ves-example":"accountcreation"},"end_time":{"type":"string","description":" end time of traffic overview query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingFilters"},"limit":{"type":"integer","description":" Number of top malicious bots to query\n Optional: if not specified, the query will include top 10 malicious bots\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"500"}},"namespace":{"type":"string","description":" namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of traffic overview query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"},"virtual_host":{"type":"string","description":" Name of Virtual Host to scope traffic overview query\n\nExample: ` \"myapp-vh-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host Name","x-displayname":"Virtual Host Name","x-ves-example":"myapp-vh-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingTopRequestAttackIntent":{"type":"object","description":"Request for top malicious bots by attack intent","title":"Request for Top  Malicious Bot Events of Sources by Attack Intent","x-displayname":"Request for Top Malicious Bot Events of Souces by Attack Intent Type","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopRequestAttackIntent","properties":{"attack_type":{"type":"string","description":" \n Optional: this is the query parameter for top source of attack types\n Used in TopMaliciousBotsByIPV3\n\nExample: ` \"AccountCreation\"`","title":"Attack Intent Type","x-displayname":"Attack Intent Type","x-ves-example":"AccountCreation"},"end_time":{"type":"string","description":" end time of traffic overview query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingFilters"},"limit":{"type":"integer","description":" Number of top malicious bots to query\n Optional: if not specified, the query will include top 10 malicious bots\n\nExample: ` \"10\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"10","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"500"}},"namespace":{"type":"string","description":" namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of traffic overview query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"},"virtual_host":{"type":"string","description":" Name of Virtual Host to scope traffic overview query\n\nExample: ` \"myapp-vh-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host Name","x-displayname":"Virtual Host Name","x-ves-example":"myapp-vh-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingTopTransactionsByAppData":{"type":"object","description":"Top Transactions per Application Data","title":"Top Transactions per Application Data","x-displayname":"Top Transactions per Application Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopTransactionsByAppData","properties":{"all_traffic_request_count":{"type":"string","description":" Number of HTTP requests for all traffic per application\n\nExample: ` \"2000\"`","title":"Request Count","format":"uint64","x-displayname":"Request Count","x-ves-example":"2000"},"all_traffic_request_percentage":{"type":"number","description":" The percentage of all traffic requests per application in total request\n\nExample: ` \"0.9\"`","title":"Request Percentage","format":"double","x-displayname":"Request Percentage","x-ves-example":"0.9"},"all_traffic_request_trend":{"type":"number","description":" The trend of all traffic requests per application\n\nExample: ` -23.5 or null`","title":"Request Trend","format":"double","x-displayname":"Request Trend"},"app_sentiment":{"type":"string","description":" The sentiment for the trend of all traffic per application\n\nExample: ` \"false\"`","title":"Trend Sentiment","x-displayname":"Trend Sentiment","x-ves-example":"false"},"application":{"type":"string","description":" Application Name\n\nExample: ` \"app A\"`","title":"Application Name","x-displayname":"Application Name","x-ves-example":"app A"}}},"reportingTopTransactionsByAppResponse":{"type":"object","description":"Response for top transactions by applications","title":"TopTransactionsByAppResponse","x-displayname":"Response for Top Transactions by Applications","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TopTransactionsByAppResponse","properties":{"application_data":{"type":"array","description":" The list of top transactions by application\n\nExample: ` \"\"    `","title":"Top Transactions By App","items":{"$ref":"#/components/schemas/reportingTopTransactionsByAppData"},"x-displayname":"Top Transactions by Application Data"},"total_applications":{"type":"string","description":"\n\nExample: `8`","title":"Total number of Applications","format":"uint64","x-displayname":"The Total Number of Applications"}}},"reportingTotalAutomationResponse":{"type":"object","description":"Response for Total Automation Insight Event","title":"InsightEvent: TotalAutomationResponse","x-displayname":"Total Automation Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TotalAutomationResponse","properties":{"automated":{"type":"string","description":" Number of HTTP requests identified as automated traffic\n\nExample: ` \"25\"`","title":"Automated","format":"uint64","x-displayname":"Automated","x-ves-example":"25"},"automated_percentage":{"type":"number","description":" The percentage of the number of automated traffic / the total number\n\nExample: ` \"24.7\"`","title":"automated Percentage","format":"double","x-displayname":"Automated Percentage","x-ves-example":"24.7"},"create_date":{"type":"number","description":" UTC Create Date in seconds\n\nExample: ` \"1569528992\"`","title":"Create_Date","format":"double","x-displayname":"Create Date","x-ves-example":"1569528992"},"endpoint":{"type":"string","description":" The number of Endpoint\n\nExample: ` \"123\"`","title":"Endpoint","format":"uint64","x-displayname":"The number of Endpoint","x-ves-example":"123"},"endpoint_label":{"type":"string"},"good_bot":{"type":"string","description":" Number of HTTP requests identified as good bot traffic within specified time interval\n\nExample: ` \"23\"`","title":"Good Bot","format":"uint64","x-displayname":"Good Bot","x-ves-example":"23"},"good_bot_percentage":{"type":"number","description":" The percentage of the number of good bot traffic / the total number\n\nExample: ` \"25.3\"`","title":"Good Bot Percentage","format":"double","x-displayname":"Good Bot Percentage","x-ves-example":"25.3"},"human":{"type":"string","description":" Number of HTTP requests identified as human traffic\n\nExample: ` \"100\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"100"},"human_percentage":{"type":"number","description":" The percentage of the number of human traffic / the total number\n\nExample: ` \"24.3\"`","title":"Human Percentage","format":"double","x-displayname":"Human Percentage","x-ves-example":"24.3"},"malicious_bot":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic\n\nExample: ` \"25\"`","title":"Malicious Bot","format":"uint64","x-displayname":"Malicious Bot","x-ves-example":"25"},"malicious_bot_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic / the total number\n\nExample: ` \"24.7\"`","title":"Malicious Bot Percentage","format":"double","x-displayname":"Malicious Bot Percentage","x-ves-example":"24.7"},"mobile":{"type":"string","description":" Number of HTTP requests identified as traffic channel is mobile\n\nExample: ` \"23\"`","title":"Mobile","format":"uint64","x-displayname":"Mobile","x-ves-example":"23"},"mobile_percentage":{"type":"number","description":" The percentage of the number of traffic channel:mobile / the total number\n\nExample: ` \"25.3\"`","title":"Mobile Percentage","format":"double","x-displayname":"Mobile Percentage","x-ves-example":"25.3"},"others":{"type":"string","description":" Number of HTTP requests identified as other traffic within specified time interval\n\nExample: ` \"10\"`","title":"Others","format":"uint64","x-displayname":"Others","x-ves-example":"10"},"others_percentage":{"type":"number","description":" The percentage of the number of others traffic / the total number\n\nExample: ` \"25.7\"`","title":"Others Percentage","format":"double","x-displayname":"Others Percentage","x-ves-example":"25.7"},"traffic_channel":{"type":"string","description":" The majority of automated traffic channel\n\nExample: ` \"Web\"`","title":"Traffic Channel","x-displayname":"The majority of automated traffic channel","x-ves-example":"Web"},"web":{"type":"string","description":" Number of HTTP requests identified as traffic channel is web\n\nExample: ` \"23\"`","title":"Web","format":"uint64","x-displayname":"Web","x-ves-example":"23"},"web_percentage":{"type":"number","description":" The percentage of the number of traffic channel:web / the total number\n\nExample: ` \"25.3\"`","title":"Web Percentage","format":"double","x-displayname":"Mobile Percentage","x-ves-example":"25.3"}}},"reportingTrafficOverviewData":{"type":"object","description":"Data for different traffic type","title":"Traffic Overview Data","x-displayname":"Traffic Overview Data","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewData","properties":{"previous_reqeust_count":{"type":"string","description":" Previous Request Count\n\nExample: ` \"2000\"`","title":"Previous Request Count","format":"uint64","x-displayname":"Previous Request Count","x-ves-example":"2000"},"request_count":{"type":"string","description":" Number of requests with the specified traffic type\n\nExample: ` \"2000\"`","title":"Request Count","format":"uint64","x-displayname":"Request Count","x-ves-example":"2000"},"request_sentiment":{"type":"string","description":" Request Sentiment\n\nExample: ` \"false\"`","title":"Request Sentiment","x-displayname":"Request Sentiment","x-ves-example":"false"},"traffic_type":{"type":"string","description":" Traffic Type\n\nExample: ` \"human, good bot, bad bot, trusted, untrusted, interstitual, others\"`","title":"Traffic Type","x-displayname":"Traffic Type","x-ves-example":"human, good bot, bad bot, trusted, untrusted, interstitual, others"},"trend":{"type":"number","description":" Trend\n\nExample: ` 0.3 or null`","title":"Trend","format":"double","x-displayname":"Trend"}}},"reportingTrafficOverviewExpandedRequest":{"type":"object","description":"Request for Shape Bot Defense expanded traffic overview","title":"TrafficOverviewExpandedRequest","x-displayname":"Traffic Overview Expanded Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedRequest","properties":{"end_time":{"type":"string","description":" end time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingFilters"},"limit":{"type":"integer","description":" limits the number of transactions returned in the response\n Optional: If not specified, the first 500 transactions that matches the query will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"100","x-ves-validation-rules":{"ves.io.schema.rules.uint32.lte":"500"}},"namespace":{"type":"string","description":" namespace is used to scope the query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"},"virtual_host":{"type":"string","description":" Name of Virtual Host to scope the query\n\nExample: ` \"myapp-vh-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host Name","x-displayname":"Virtual Host Name","x-ves-example":"myapp-vh-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingTrafficOverviewExpandedResponse":{"type":"object","description":"Response for Shape Bot Defense expanded traffic overview","title":"TrafficOverviewExpandedResponse","x-displayname":"Traffic Overview Expanded Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedResponse","properties":{"total_transactions":{"type":"string","description":" Total number of traffic transactions\n\nExample: ` 1000`","title":"Total transactions\nx-displayName: \"Total transactions\"\nx-example: 1000\nTotal number of traffic transactions","format":"uint64","x-displayname":"Total transactions"},"transactions":{"type":"array","description":" A list of traffic transactions","title":"Transactions","items":{"$ref":"#/components/schemas/reportingTransaction"},"x-displayname":"Transactions"}}},"reportingTrafficOverviewExpandedV5Request":{"type":"object","description":"Request for Shape Bot Defense expanded traffic overview V5","title":"TrafficOverviewExpandedV5Request","x-displayname":"Traffic Overview Expanded V5 Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedV5Request","properties":{"end_time":{"type":"string","description":" end time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingGlobalFilters"},"namespace":{"type":"string","description":" namespace is used to scope the query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"namespace1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"namespace1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"pagination":{"$ref":"#/components/schemas/reportingPagination"},"sort":{"$ref":"#/components/schemas/reportingSortOption"},"start_time":{"type":"string","description":" start time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"}}},"reportingTrafficOverviewExpandedV5Response":{"type":"object","description":"Response for Shape Bot Defense expanded traffic overview V5","title":"TrafficOverviewExpandedV5Response","x-displayname":"Traffic Overview Expanded V5 Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedV5Response","properties":{"total_transactions":{"type":"string","description":" Total number of traffic transactions\n\nExample: ` 108`","title":"Total transactions\nx-displayName: \"Total transactions\"\nx-example: 108\nTotal number of traffic transactions","format":"uint64","x-displayname":"Total transactions"},"transactions":{"type":"array","description":" A list of traffic transactions","title":"Transactions","items":{"$ref":"#/components/schemas/reportingTransactionRecord"},"x-displayname":"Transactions"}}},"reportingTrafficOverviewRequest":{"type":"object","description":"Request for Shape Bot Defense traffic overview","title":"TrafficOverviewRequest","x-displayname":"Traffic Overview Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest","properties":{"category":{"type":"string","description":" \n endpoint category label.\n\nExample: ` \"Login\"`","title":"Category","x-displayname":"Category","x-ves-example":"Login"},"end_time":{"type":"string","description":" end time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingFilters"},"namespace":{"type":"string","description":" namespace is used to scope the query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"},"use_raw_data":{"type":"boolean","description":" \n Optional: by default is false. If use_raw_data = True and referer filter is set, \n then backend will query raw data","title":"Use raw data","format":"boolean","x-displayname":"Use raw data"},"virtual_host":{"type":"string","description":" Name of Virtual Host to scope the query\n\nExample: ` \"myapp-vh-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Virtual Host Name","x-displayname":"Virtual Host Name","x-ves-example":"myapp-vh-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"reportingTrafficOverviewResponse":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview","title":"TrafficOverviewResponse","x-displayname":"Traffic Overview Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewResponse","properties":{"human":{"type":"string","description":" Number of HTTP requests identified as human traffic within specified time interval\n\nExample: ` \"100\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"100"},"malicious_bot":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic within specified time interval\n\nExample: ` \"25\"`","title":"Malicious Bot","format":"uint64","x-displayname":"Malicious Bot","x-ves-example":"25"},"total":{"type":"string","description":" Total number of HTTP requests within specified time interval\n\nExample: ` \"158\"`","title":"Total","format":"uint64","x-displayname":"Total","x-ves-example":"158"}}},"reportingTrafficOverviewTimeseriesResponse":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview timeseries","title":"TrafficOverviewTimeseriesResponse","x-displayname":"Traffic Overview Timeseries Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesResponse","properties":{"values":{"type":"array","description":" Traffic overview timeseries","title":"Timeseries Values","items":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesValue"},"x-displayname":"Timeseries values"}}},"reportingTrafficOverviewTimeseriesV2Response":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview timeseries","title":"TrafficOverviewTimeseriesV2Response","x-displayname":"Traffic Overview Timeseries V2 Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV2Response","properties":{"values":{"type":"array","description":" Traffic overview timeseries","title":"Timeseries Values","items":{"$ref":"#/components/schemas/reportingTrafficOverviewTimeseriesV2Value"},"x-displayname":"Timeseries values"}}},"reportingTrafficOverviewTimeseriesV2Value":{"type":"object","description":"Shape Bot Defense traffic overview timeseries V2 value","title":"TrafficOverviewTimeseriesV2Data","x-displayname":"Traffic Overview Timeseries V2 Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV2Value","properties":{"good_bot":{"type":"string","description":" Number of HTTP requests identified as good bot traffic\n\nExample: ` \"25\"`","title":"Good Bot","format":"uint64","x-displayname":"Good Bot","x-ves-example":"25"},"human":{"type":"string","description":" Number of HTTP requests identified as human traffic\n\nExample: ` \"100\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"100"},"malicious_bot":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic\n\nExample: ` \"25\"`","title":"Malicious Bot","format":"uint64","x-displayname":"Malicious Bot","x-ves-example":"25"},"others":{"type":"string","description":" Number of HTTP requests identified as others traffic\n\nExample: ` \"25\"`","title":"Others","format":"uint64","x-displayname":"Others","x-ves-example":"25"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"}}},"reportingTrafficOverviewTimeseriesV3Response":{"type":"object","description":"Response that contains Shape Bot Defense traffic type timeseries","title":"TrafficOverviewTimeseriesV2Response","x-displayname":"Traffic Overview Timeseries V3 Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV3Response","properties":{"traffic_type_data":{"type":"array","description":" Traffic type timeseries","title":"Traffic Type Data","items":{"$ref":"#/components/schemas/reportingTimeSeriesGraphMinimalData"},"x-displayname":"Traffic Type Data"}}},"reportingTrafficOverviewTimeseriesValue":{"type":"object","description":"Shape Bot Defense traffic overview timeseries value","title":"TrafficOverviewTimeseriesData","x-displayname":"Traffic Overview Timeseries Value","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesValue","properties":{"human":{"type":"string","description":" Number of HTTP requests identified as human traffic\n\nExample: ` \"100\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"100"},"malicious_bot":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic\n\nExample: ` \"25\"`","title":"Malicious Bot","format":"uint64","x-displayname":"Malicious Bot","x-ves-example":"25"},"timestamp":{"type":"number","description":" UTC timestamp in seconds\n\nExample: ` \"1569528992\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1569528992"}}},"reportingTrafficOverviewV2Request":{"type":"object","description":"Request for Shape Bot Defense traffic overview with global filters","title":"TrafficOverviewV2Request","x-displayname":"Traffic Overview V2 Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV2Request","properties":{"category":{"type":"string","description":"\n endpoint category label\n Optional: empty by default\n\nExample: ` \"Login\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"Category","maxLength":128,"x-displayname":"Category","x-ves-example":"Login","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"end_time":{"type":"string","description":" end time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600"},"filters":{"$ref":"#/components/schemas/reportingGlobalFilters"},"namespace":{"type":"string","description":" namespace is used to scope the query. Only virtual_host in given namespace will be considered.\n\nExample: ` \"payment-app-namespace-1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"payment-app-namespace-1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"start_time":{"type":"string","description":" start time of the query period\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000"},"use_raw_data":{"type":"boolean","description":"\n Optional: by default is false","title":"Use raw data","format":"boolean","x-displayname":"Use raw data"}}},"reportingTrafficOverviewV2Response":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview","title":"TrafficOverviewV2Response","x-displayname":"Traffic Overview Response V2","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV2Response","properties":{"bot_trend":{"type":"number","description":" Trend of the number of HTTP requests identified as bot traffic\n\nExample: ` 0.1 or null`","title":"Bot Trend","format":"double","x-displayname":"Bot Trend"},"good_bot":{"type":"string","description":" Number of HTTP requests identified as good bot traffic within specified time interval\n\nExample: ` \"23\"`","title":"Good Bot","format":"uint64","x-displayname":"Good Bot","x-ves-example":"23"},"good_bot_percentage":{"type":"number","description":" The percentage of the number of good bot traffic / the total number\n\nExample: ` \"25.3\"`","title":"Good Bot Percentage","format":"double","x-displayname":"Good Bot Percentage","x-ves-example":"25.3"},"good_bot_previous":{"type":"string","description":" Number of HTTP requests identified as good bot traffic within the previous specified time interval\n\nExample: ` \"23\"`","title":"Good Bot in the previous time interval","format":"uint64","x-displayname":"Good Bot in last X days","x-ves-example":"23"},"good_bot_sentiment":{"type":"string","description":" The sentiment for the trend of good bot traffic \n\nExample: ` \"null\"`","title":"Good Bot Sentiment","x-displayname":"Good Bot Sentiment","x-ves-example":"null"},"good_bot_trend":{"type":"number","description":" Trend of the number of HTTP requests identified as good bot traffic\n\nExample: ` 0.4 or null`","title":"Good Bot Trend","format":"double","x-displayname":"Good Bot Trend"},"human":{"type":"string","description":" Number of HTTP requests identified as human traffic within specified time interval\n\nExample: ` \"100\"`","title":"Human","format":"uint64","x-displayname":"Human","x-ves-example":"100"},"human_percentage":{"type":"number","description":" The percentage of the number of human traffic / the total number\n\nExample: ` \"24.3\"`","title":"Human Percentage","format":"double","x-displayname":"Human Percentage","x-ves-example":"24.3"},"human_previous":{"type":"string","description":" Number of HTTP requests identified as human traffic within the previous specified time interval\n\nExample: ` \"100\"`","title":"Human in the previous time interval","format":"uint64","x-displayname":"Human in last X days","x-ves-example":"100"},"human_sentiment":{"type":"string","description":" The sentiment for the trend of human traffic \n\nExample: ` \"true\"`","title":"Human Sentiment","x-displayname":"Human Sentiment","x-ves-example":"true"},"human_trend":{"type":"number","description":" Trend of the number of HTTP requests identified as human traffic\n\nExample: ` 0.5 or null`","title":"Human Trend","format":"double","x-displayname":"Human Trend"},"malicious_bot":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic within specified time interval\n\nExample: ` \"25\"`","title":"Malicious Bot","format":"uint64","x-displayname":"Malicious Bot","x-ves-example":"25"},"malicious_bot_percentage":{"type":"number","description":" The percentage of the number of malicious bot traffic / the total number\n\nExample: ` \"24.7\"`","title":"Malicious Bot Percentage","format":"double","x-displayname":"Malicious Bot Percentage","x-ves-example":"24.7"},"malicious_bot_previous":{"type":"string","description":" Number of HTTP requests identified as malicious bot traffic within the previous specified time interval\n\nExample: ` \"25\"`","title":"Malicious Bot in the previous time interval","format":"uint64","x-displayname":"Malicious Bot in last X days","x-ves-example":"25"},"malicious_bot_sentiment":{"type":"string","description":" The sentiment for the trend of malicious bot traffic \n\nExample: ` \"false\"`","title":"Malicious Bot Sentiment","x-displayname":"Malicious Bot Sentiment","x-ves-example":"false"},"others":{"type":"string","description":" Number of HTTP requests identified as other traffic within specified time interval\n\nExample: ` \"10\"`","title":"Others","format":"uint64","x-displayname":"Others","x-ves-example":"10"},"others_percentage":{"type":"number","description":" The percentage of the number of others traffic / the total number\n\nExample: ` \"25.7\"`","title":"Others Percentage","format":"double","x-displayname":"Others Percentage","x-ves-example":"25.7"},"others_previous":{"type":"string","description":" Number of HTTP requests identified as other traffic within the previous specified time interval\n\nExample: ` \"10\"`","title":"Others in the previous time interval","format":"uint64","x-displayname":"Others  in last X days","x-ves-example":"10"},"others_trend":{"type":"number","description":" Trend of the number of HTTP requests identified as other traffic\n\nExample: ` 0.3 or null`","title":"Others Trend","format":"double","x-displayname":"Others Trend"},"total":{"type":"string","description":" Total number of HTTP requests within specified time interval\n\nExample: ` \"158\"`","title":"Total","format":"uint64","x-displayname":"Total","x-ves-example":"158"},"total_previous":{"type":"string","description":" Total number of HTTP requests within the previous specified time interval\n\nExample: ` \"10\"`","title":"total in the previous time interval","format":"uint64","x-displayname":"Total in last X days","x-ves-example":"10"},"total_sentiment":{"type":"string","description":" The sentiment for the trend of total traffic \n\nExample: ` null`","title":"Total Sentiment","x-displayname":"Total Sentiment"},"total_trend":{"type":"number","description":" Trend of the total number of HTTP requests\n\nExample: ` 0.3 or null`","title":"Total Trend","format":"double","x-displayname":"Total Trend"}}},"reportingTrafficOverviewV3Response":{"type":"object","description":"Response that contains Shape Bot Defense traffic overview","title":"TrafficOverviewV3Response","x-displayname":"Traffic Overview Response V3","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV3Response","properties":{"traffic_type_data":{"type":"array","description":" Traffic Overview","title":"Traffic Type Data","items":{"$ref":"#/components/schemas/reportingTrafficOverviewData"},"x-displayname":"Traffic Type Data"}}},"reportingTrafficTypeFilter":{"type":"object","description":"Query Filter by traffic type filter strings","title":"Traffic Type Filter","x-displayname":"Traffic Type Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TrafficTypeFilter","properties":{"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"traffic_type_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['web']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"Traffic Type Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"Traffic Type Strings","x-ves-example":"['web']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"reportingTransaction":{"type":"object","description":"Traffic transaction","title":"Transaction","x-displayname":"Transaction","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.Transaction","properties":{"action_taken":{"type":"string","description":" Action Taken Values: Flagged, Blocked, Allow Request, etc","title":"x-displayName: \"Action Taken\"\nx-example: \"Flagged\"\nAction Taken Values: Flagged, Blocked, Allow Request, etc","x-displayname":"Action Taken","x-ves-example":"Flagged"},"app_type":{"type":"string","description":" Traffic Channel\n\nExample: ` \"web\"`","title":"Traffic Channel","x-displayname":"Traffic Channel","x-ves-example":"web"},"as_org":{"type":"string","description":" Organization name\n\nExample: ` \"Google LLC\"`","title":"AS Organization","x-displayname":"AS Organization","x-ves-example":"Google LLC"},"asn":{"type":"integer","description":" AS Number\n\nExample: ` \"713\"`","title":"AS Number","format":"int64","x-displayname":"AS Number","x-ves-example":"713"},"attack_intent":{"type":"string","description":" Attack Intent\n\nExample: ` \"Credential Stuffing\"`","title":"Attack Intent","x-displayname":"Attack Intent","x-ves-example":"Credential Stuffing"},"automation_type":{"type":"string","description":" Malicious Bot Automation Type","title":"x-displayName: \"Malicious Bot Automation Type\"\nx-example: \"Token Missing\"\nMalicious Bot Automation Type","x-displayname":"Malicious Bot Automation Type","x-ves-example":"Token Missing"},"country":{"type":"string","description":" Country name\n\nExample: ` \"US\"`","title":"Country","x-displayname":"Country","x-ves-example":"US"},"hostname":{"type":"string","description":" Hostname of attacked app endpoint\n\nExample: ` \"xyz.foo.com\"`","title":"Hostname","x-displayname":"Hostname","x-ves-example":"xyz.foo.com"},"inference":{"type":"string","description":" Bot Defense Inference: Human, Automated, Allowlisted, Other","title":"x-displayName: \"Main Type\"\nx-example: \"Bot\"\nBot Defense Inference: Human, Automated, Allowlisted, Other","x-displayname":"Main Type","x-ves-example":"Bot"},"inference_sub_type":{"type":"string","description":" Bot Defense Inference Sub Type: Bad Bot, Trusted Allow, Good Bot","title":"x-displayName: \"Sub Type\"\nx-example: \"Bot\"\nBot Defense Inference Sub Type: Bad Bot, Trusted Allow, Good Bot","x-displayname":"Sub Type","x-ves-example":"Bot"},"ip":{"type":"string","description":" IP Address\n\nExample: ` \"1.2.3.4\"`","title":"IP Address","x-displayname":"IP Address","x-ves-example":"1.2.3.4"},"method":{"type":"string","description":" HTTP method of attacked app endpoint\n\nExample: ` \"POST\"`","title":"HTTP Method","x-displayname":"HTTP Method","x-ves-example":"POST"},"referer":{"type":"string","description":" header reference\n\nExample: ` \"http://172.29.42.57/index.php?\"`","title":"header reference","x-displayname":"header reference","x-ves-example":"http://172.29.42.57/index.php?"},"timestamp":{"type":"string","description":" Time/Date of the transaction in RFC 3339 format\n Format: rfc 3339\n\nExample: ` \"2021-09-13T17:27:35.549Z\"`","title":"Timestamp","x-displayname":"Timestamp","x-ves-example":"2021-09-13T17:27:35.549Z"},"ua":{"type":"string","description":" User Agent String\n\nExample: ` \"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"`","title":"User Agent String","x-displayname":"User Agent String","x-ves-example":"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0"},"uri":{"type":"string","description":" URI of attacked app endpoint\n\nExample: ` \"/index.php\"`","title":"URI","x-displayname":"URI","x-ves-example":"/index.php"}}},"reportingTransactionField":{"type":"object","description":"Traffic transaction fields","title":"TransactionField","x-displayname":"TransactionField","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TransactionField","properties":{"group":{"type":"string","description":" group name the field belongs to","title":"Group","x-displayname":"Group"},"name":{"type":"string","description":" field name","title":"Name","x-displayname":"Name"},"value":{"type":"string","description":" field value","title":"Value","x-displayname":"Value"}}},"reportingTransactionRecord":{"type":"object","description":"Traffic transaction","title":"TransactionRecord","x-displayname":"TransactionRecord","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TransactionRecord","properties":{"fields":{"type":"array","description":" Traffic Fields - for example: AS Number, Timestamp, host, etc","title":"Transaction Fields","items":{"$ref":"#/components/schemas/reportingTransactionField"},"x-displayname":"Transaction Fields"}}},"reportingTransactionUsageSummaryResponse":{"type":"object","description":"Response for Transaction Usage Summary","title":"TransactionUsageSummaryResponse","x-displayname":"Response for Transaction Usage Summary","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.TransactionUsageSummaryResponse","properties":{"records":{"type":"array","description":" Per month usage summary data\n\nExample: ` \"\"`","title":"Monthly Usage Summary Records","items":{"$ref":"#/components/schemas/reportingMonthlyUsageSummaryData"},"x-displayname":"Monthly Usage Summary Records"}}},"reportingURIFilter":{"type":"object","description":"Query Filter by URI filter strings","title":"URI Filter","x-displayname":"URI Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.URIFilter","properties":{"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"uri_strings":{"type":"array","description":" An list of strings\n\nExample: ` \"['/test']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"URI Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"URI Strings","x-ves-example":"['/test']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"reportingUserAgentFilter":{"type":"object","description":"Query Filter by user agent filter strings","title":"User Agent Filter","x-displayname":"User Agent Filter","x-ves-proto-message":"ves.io.schema.shape.bot_defense.reporting.UserAgentFilter","properties":{"op":{"$ref":"#/components/schemas/reportingFilterOperator"},"ua_strings":{"type":"array","description":" An unordered list of user agent strings\n\nExample: ` \"['Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"User Agent Strings","maxItems":64,"items":{"type":"string"},"x-displayname":"User Agent Strings","x-ves-example":"['Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}}}},"schemaSortOrder":{"type":"string","description":"Sort algorithm\n\nSort in descending order\nSort in ascending order","title":"SortOrder","enum":["DESCENDING","ASCENDING"],"default":"DESCENDING","x-displayname":"Sort Order","x-ves-proto-enum":"ves.io.schema.SortOrder"}}}}