@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0036.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule","description":"Configures Bot Detection Rule","version":""},"paths":{"/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules":{"post":{"summary":"Deploy Bot Detection Rules","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DeployBotDetectionRules","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleDeployBotDetectionRulesResponse"}}}},"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: \"system\"\nnamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bot_detection_ruleDeployBotDetectionRulesRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-threat_intelligence-bot_detection_rule-customapi-deploybotdetectionrules"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DeployBotDetectionRules"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments":{"get":{"summary":"Get list of bot detection rule deployments","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeployments","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetBotDetectionRulesDeploymentsResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"rules_deployment_status","description":"x-example: \"[BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED, BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED]\"\nThe deployments will be filtered by the deployment status values provided. This field is optional. If no deployment status values are provided, all the deployments will be fetched\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch","in":"query","required":false,"x-displayname":"Partially Initiated","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DRAFT","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DEPLOYED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_FAILED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DISCARDED_DRAFT","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATION_FAILED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED"]}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-threat_intelligence-bot_detection_rule-customapi-getbotdetectionrulesdeployments"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeployments"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments/{deployment_id}":{"get":{"summary":"Get details of a bot detection rule deployment","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeploymentDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetBotDetectionRulesDeploymentDetailsResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"deployment_id","description":"DeploymentID\n\nx-required\nUnique identifier for a bot detection rule(s) deployment","in":"path","required":true,"x-displayname":"Deployment ID","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-threat_intelligence-bot_detection_rule-customapi-getbotdetectionrulesdeploymentdetails"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeploymentDetails"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/draft":{"get":{"summary":"Get bot detection rules which are in draft state","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDraft","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetBotDetectionRulesDraftResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","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-threat_intelligence-bot_detection_rule-customapi-getbotdetectionrulesdraft"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDraft"},"delete":{"summary":"Discard draft","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DiscardDraft","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ioschemaEmpty"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","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-threat_intelligence-bot_detection_rule-customapi-discarddraft"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DiscardDraft"},"post":{"summary":"Save draft","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.SaveDraft","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleSaveDraftResponse"}}}},"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: \"system\"\nnamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/bot_detection_ruleDeployBotDetectionRulesRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-threat_intelligence-bot_detection_rule-customapi-savedraft"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.SaveDraft"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/summary":{"get":{"summary":"Get summary of bot detection rules","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetBotDetectionRulesSummaryResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","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-threat_intelligence-bot_detection_rule-customapi-getbotdetectionrulessummary"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesSummary"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_detection_rules":{"get":{"summary":"List Bot Detection Rule","description":"List the set of bot_detection_rule in a namespace","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleListResponse"}}}},"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-example: \"ns1\"\nNamespace to scope the listing of bot_detection_rule","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"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-threat_intelligence-bot_detection_rule-api-list"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.List"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_detection_rules/{id}/history":{"get":{"summary":"Get the change history for a bot detection rule","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRuleChangeHistory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetBotDetectionRuleChangeHistoryResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"id","description":"ID\n\nx-example: \"Rule_CB_DUBEXLDQKV\"\nx-required\nRule ID is the unique identifier for a Rule","in":"path","required":true,"x-displayname":"ID","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-threat_intelligence-bot_detection_rule-customapi-getbotdetectionrulechangehistory"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRuleChangeHistory"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_detection_rules/{name}":{"get":{"summary":"Get Bot Detection Rule","description":"Get Bot Detection Rule","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleGetResponse"}}}},"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-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-bot_defense-threat_intelligence-bot_detection_rule-api-get"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.Get"},"x-displayname":"Bot Detection Rule","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"}},"x-displayname":"Bot Detection Rule","x-ves-proto-package":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule","components":{"requestBodies":{"bot_detection_ruleDeployBotDetectionRulesRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_ruleDeployBotDetectionRulesRequest"}}},"required":true}},"schemas":{"bot_detection_ruleBotDetectionRuleChangeType":{"type":"string","description":"Type of bot detection rule change\n","title":"BotDetectionRuleChangeType","enum":["BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN","BOT_DETECTION_RULE_CHANGE_TYPE_CREATION","BOT_DETECTION_RULE_CHANGE_TYPE_MODIFICATION","BOT_DETECTION_RULE_CHANGE_TYPE_DELETION"],"default":"BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN","x-displayname":"Bot Detection Rule Change Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleChangeType"},"bot_detection_ruleBotDetectionRuleConfig":{"type":"object","description":"Rule configuration","title":"BotDetectionRuleConfig","x-displayname":"Rule configuration","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfig","properties":{"mitigation":{"type":"boolean","description":" Mitigation - true(ON) / false(OFF)","title":"Mitigation","format":"boolean","x-displayname":"Mitigation"}}},"bot_detection_ruleBotDetectionRuleConfigChange":{"type":"object","description":"Bot Detection Rule Config Change","title":"BotDetectionRuleConfigChange","x-displayname":"Bot Detection Rule Config Change","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChange","properties":{"deploy_to":{"type":"array","description":" Environments to which new rule configuration has to be deployed onto","title":"Deploy To","items":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"x-displayname":"Deploy To"},"desired_rule_config":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfig"},"desired_rule_config_per_bot_infra":{"type":"array","title":"Desired Rule Configuration Per Bot Infra","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra"},"x-displayname":"Desired Rule Configuration Per Bot Infra"},"existing_rule_config_per_bot_infra":{"type":"array","title":"Existing Rule Configuration Per Bot Infra","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra"},"x-displayname":"Existing Rule Configuration Per Bot Infra"},"last_modified_at":{"type":"string","description":" Last Modified At as per SAPI's database","title":"Last Modified At","format":"date-time","x-displayname":"Last Modified At"},"reason":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChangeReason"},"rule_id":{"type":"string","description":" Unique identifier for a bot detection rule as per SAPI's database","title":"Rule ID","x-displayname":"Rule ID"},"rule_name":{"type":"string","title":"Rule Name","x-displayname":"Rule Name"},"traffic_type":{"$ref":"#/components/schemas/bot_infrastructureTrafficType"}}},"bot_detection_ruleBotDetectionRuleConfigChangeReason":{"type":"object","description":"Reason for changing the bot detection rule configuration","title":"BotDetectionRuleConfigChangeReason","x-displayname":"Bot Detection Rule Config Change Reason","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChangeReason","properties":{"comments":{"type":"string","description":" Comments are required when the reason type is selected as 'Other'","title":"Comments","x-displayname":"Comments"},"reasons":{"type":"array","description":" List of reasons why the rule configuration is changed","title":"Reasons","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChangeReasonType"},"x-displayname":"Reasons"}}},"bot_detection_ruleBotDetectionRuleConfigChangeReasonType":{"type":"string","description":"Reason type for changing the bot detection rule configuration\n","title":"BotDetectionRuleConfigChangeReasonType","enum":["BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN","BOT_DETECTION_RULE_CHANGE_REASON_FALSE_POSITIVE","BOT_DETECTION_RULE_CHANGE_REASON_TRUE_POSITIVE","BOT_DETECTION_RULE_CHANGE_REASON_TESTING","BOT_DETECTION_RULE_CHANGE_REASON_OTHER"],"default":"BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN","x-displayname":"Bot Detection Rule Config Change Reason Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChangeReasonType"},"bot_detection_ruleBotDetectionRuleConfigDeploymentDetailsPerBotInfra":{"type":"object","title":"BotDetectionRuleConfigDeploymentDetailsPerBotInfra","x-displayname":"Rule configuration per bot infrastructure","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigDeploymentDetailsPerBotInfra","properties":{"bot_detection_rule_config":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfig"},"bot_infra_deployment_details":{"$ref":"#/components/schemas/threat_intelligenceBotInfraDeploymentDetails"}}},"bot_detection_ruleBotDetectionRuleConfigPerBotInfra":{"type":"object","description":"Bot detection rule configuration per bot infrastructure","title":"BotDetectionRuleConfigPerBotInfra","x-displayname":"Bot detection rule configuration per bot infrastructure","x-ves-oneof-field-rule_config":"[\"bot_detection_rule_config\",\"region_rule_config\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigPerBotInfra","properties":{"bot_detection_rule_config":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfig"},"bot_infra_id":{"type":"string","description":" Bot Infrastructure ID as per SAPI's database","title":"Bot Infrastructure ID","x-displayname":"Bot Infrastructure ID"},"bot_infra_name":{"type":"string","description":" Name of the bot infrastructure as per SAPI's database","title":"BotInfraName","x-displayname":"Bot Infrastructure Name"},"bot_infrastructure_type":{"$ref":"#/components/schemas/threat_intelligenceBotInfrastuctureType"},"environment_type":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"region_rule_config":{"$ref":"#/components/schemas/bot_detection_ruleRegionRuleConfig"}}},"bot_detection_ruleBotDetectionRuleType":{"type":"string","title":"BotDetectionRuleType","enum":["BOT_DETECTION_RULE_TYPE_UNKNOWN","BOT_DETECTION_RULE_TYPE_ENFORCED_BLOCKING","BOT_DETECTION_RULE_TYPE_CONTROL_BLOCKING"],"default":"BOT_DETECTION_RULE_TYPE_UNKNOWN","x-displayname":"Bot Detection Rule Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleType"},"bot_detection_ruleBotDetectionRulesDeployment":{"type":"object","description":"Bot detection rules deployment","title":"BotDetectionRulesDeployment","x-displayname":"Bot Detection Rules Deployment","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRulesDeployment","properties":{"bot_infrastructures":{"type":"array","title":"Bot Infrastructures","items":{"$ref":"#/components/schemas/threat_intelligenceBotInfrastructure"},"x-displayname":"Bot Infrastructures"},"comments":{"type":"string","description":" Comments provided by official for making the changes to rule configuration","title":"Comments","x-displayname":"Comments"},"deployment_id":{"type":"string","description":" Unique identifier for a deployment batch","title":"Deployment Id","x-displayname":"Deployment Id"},"deployment_status":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus"},"deployment_time":{"type":"string","description":" Timestamp at which the deployment was initiated","title":"DeploymentTime","format":"date-time","x-displayname":"Deployment Time"},"modified_by":{"type":"string","description":" EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'","title":"Modified By","x-displayname":"Modified By"},"number_of_rules":{"type":"integer","title":"Number of rules","format":"int64","x-displayname":"Number of rules"},"rules":{"type":"array","description":" List of rules that went in the deployment","title":"Rules","items":{"type":"string"},"x-displayname":"Rules"},"traffic_types":{"type":"array","title":"Traffic Types","items":{"$ref":"#/components/schemas/bot_infrastructureTrafficType"},"x-displayname":"Traffic Types"}}},"bot_detection_ruleBotDetectionRulesDeploymentStatus":{"type":"string","description":"Deployment status of bot detection rule(s)\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch","title":"BotDetectionRulesDeploymentStatus","enum":["BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DRAFT","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DEPLOYED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_FAILED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DISCARDED_DRAFT","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATION_FAILED","BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED"],"default":"BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN","x-displayname":"Bot Detection Rules Deployment Status","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRulesDeploymentStatus"},"bot_detection_ruleDeployBotDetectionRulesRequest":{"type":"object","description":"Request for deploy bot detection rules","title":"DeployBotDetectionRulesRequest","x-displayname":"Deploy Bot Detection Rules Request","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesRequest","properties":{"comments":{"type":"string","description":" Deployment Comments","title":"Comments","x-displayname":"Comments"},"config_change_per_bot_detection_rule":{"type":"array","description":" Config change per bot detection rules\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Config Change Per Bot Detection Rules","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange"},"x-displayname":"Config Change Per Bot Detection Rules","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" namespace is used to scope the query\n\nExample: ` \"system\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"namespace","minLength":1,"x-displayname":"Namespace","x-ves-example":"system","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.min_len":"1","ves.io.schema.rules.string.ves_object_name":"true"}}}},"bot_detection_ruleDeployBotDetectionRulesResponse":{"type":"object","description":"Response for deploy bot detection rules","title":"DeployBotDetectionRulesResponse","x-displayname":"Deploy Bot Detection Rules Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesResponse","properties":{"deployment_status":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus"}}},"bot_detection_ruleDraftRuleCounts":{"type":"object","description":"Rule summary of bot detection rules in draft state","title":"Draft Rule Counts","x-displayname":"Draft Rule Counts","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DraftRuleCounts","properties":{"total":{"type":"integer","description":" Total number of rules","title":"Total","format":"int64","x-displayname":"Total"}}},"bot_detection_ruleEnvironmentRuleCounts":{"type":"object","description":"Rule summary of bot detection rules in per environment","title":"Environment Rule Counts","x-displayname":"Environment Rule Counts","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.EnvironmentRuleCounts","properties":{"mobile":{"$ref":"#/components/schemas/bot_detection_ruleRuleStateCounts"},"web":{"$ref":"#/components/schemas/bot_detection_ruleRuleStateCounts"}}},"bot_detection_ruleGetBotDetectionRuleChangeHistoryResponse":{"type":"object","description":"Response for get bot detection rule change history","title":"GetBotDetectionRuleChangeHistoryResponse","x-displayname":"Get Bot Detection Rule Change History Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRuleChangeHistoryResponse","properties":{"rule_changes":{"type":"array","description":" Rule changes holds the details for changes made to a bot detection rule","title":"RuleChanges","items":{"$ref":"#/components/schemas/bot_detection_ruleRuleChange"},"x-displayname":"Rule Changes"}}},"bot_detection_ruleGetBotDetectionRulesDeploymentDetailsResponse":{"type":"object","description":"Response for get bot detection rules deployment deployment","title":"GetBotDetectionRulesDeploymentDetailsResponse","x-displayname":"Get details of a bot detection rule(s) deployment response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDeploymentDetailsResponse","properties":{"config_change_per_bot_detection_rule":{"type":"array","description":" Config change per bot detection rule","title":"Config Change Per Bot Detection Rule","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange"},"x-displayname":"Config Change Per Bot Detection Rule"},"deploy_to":{"type":"array","description":" Environments to which new rule configuration has to be deployed onto","title":"Deploy To","items":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"x-displayname":"Deploy To"},"deployed_by":{"type":"string","description":" Deployed By","title":"Deployed By","x-displayname":"Deployed By"},"deployment_details_per_bot_infra":{"type":"array","description":" Deployment details per bot infrastructure","title":"DeploymentDetailsPerBotInfra","items":{"$ref":"#/components/schemas/threat_intelligenceBotInfraDeploymentDetails"},"x-displayname":"Deployment Details Per Bot Infrastructure"},"deployment_status":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus"},"deployment_time":{"type":"string","description":" Timestamp at which the deployment was initiated","title":"DeploymentTime","format":"date-time","x-displayname":"Deployment Time"}}},"bot_detection_ruleGetBotDetectionRulesDeploymentsResponse":{"type":"object","description":"Response for get bot detection rules deployments","title":"GetBotDetectionRulesDeploymentsResponse","x-displayname":"Get list of bot detection rule deployments response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDeploymentsResponse","properties":{"bot_detection_rules_deployments":{"type":"array","description":" List of bot detection rules deployments","title":"Deployments","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRulesDeployment"},"x-displayname":"Deployments"}}},"bot_detection_ruleGetBotDetectionRulesDraftResponse":{"type":"object","description":"Response for get bot detection rules draft","title":"GetBotDetectionRulesDraftResponse","x-displayname":"Get bot detection rules draft response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDraftResponse","properties":{"comments":{"type":"string","description":" Comments","title":"Comments","x-displayname":"Comments"},"config_change_per_bot_detection_rule":{"type":"array","description":" Config change per bot detection rule","title":"Config Change Per Bot Detection Rule","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange"},"x-displayname":"Config Change Per Bot Detection Rule"}}},"bot_detection_ruleGetBotDetectionRulesSummaryResponse":{"type":"object","description":"Response for get bot detection rules summary","title":"GetBotDetectionRulesSummaryResponse","x-displayname":"Get BotDetection Rules Summary Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesSummaryResponse","properties":{"rule_summary":{"$ref":"#/components/schemas/bot_detection_ruleRuleSummary"}}},"bot_detection_ruleGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read bot_detection_rule","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetResponse","properties":{"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"spec":{"$ref":"#/components/schemas/threat_intelligencebot_detection_ruleGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"bot_detection_ruleGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"bot_detection_ruleListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of bot_detection_rule","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/bot_detection_ruleListResponseItem"},"x-displayname":"Items"}}},"bot_detection_ruleListResponseItem":{"type":"object","description":"By default a summary of bot_detection_rule is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of bot_detection_rule","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this bot_detection_rule","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this bot_detection_rule","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates bot_detection_rule is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/threat_intelligencebot_detection_ruleGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this bot_detection_rule","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this bot_detection_rule\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this bot_detection_rule\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"bot_detection_ruleRegionRuleConfig":{"type":"object","description":"Rule config per region","title":"RegionRuleConfig","x-displayname":"Rule Config Per Region","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RegionRuleConfig","properties":{"region_config":{"type":"object","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.map.min_pairs: 1\n  ves.io.schema.rules.message.required: true\n","title":"Rule Config Per Region","x-displayname":"Rule Config Per Region","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.map.min_pairs":"1","ves.io.schema.rules.message.required":"true"}}}},"bot_detection_ruleRuleChange":{"type":"object","description":"Rule change holds the details of the changes made to a bot detection rule","title":"RuleChange","x-displayname":"Rule Change","x-ves-oneof-field-change":"[\"creation\",\"deletion\",\"modification\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleChange","properties":{"change_type":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleChangeType"},"changed_by":{"type":"string","description":" EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'","title":"Changed By","x-displayname":"Changed By"},"creation":{"$ref":"#/components/schemas/ioschemaEmpty"},"deletion":{"$ref":"#/components/schemas/ioschemaEmpty"},"modification":{"$ref":"#/components/schemas/bot_detection_ruleRuleChangeTypeModification"},"timestamp":{"type":"string","description":" Timestamp at which the change was made","title":"Timestamp","format":"date-time","x-displayname":"Timestamp"}}},"bot_detection_ruleRuleChangeTypeModification":{"type":"object","description":"Rule change type - Modification","title":"RuleChangeTypeModification","x-displayname":"Rule change type - Modification","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleChangeTypeModification","properties":{"comments":{"type":"string","description":" Comments provided for when making changes to the configuration of a rule","title":"Comments","x-displayname":"Comments"},"reasons":{"type":"array","description":" List of reasons why the rule configuration was changed","title":"Reasons","items":{"type":"string"},"x-displayname":"Reasons"},"rule_config_deployment_details_per_bot_infra":{"type":"array","title":"Rule configuration deployment details per bot infrastructure","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigDeploymentDetailsPerBotInfra"},"x-displayname":"Rule configuration deployment details per bot infrastructure"}}},"bot_detection_ruleRuleStateCounts":{"type":"object","description":"Rule summary of bot detection rules for per state","title":"Rule State Counts","x-displayname":"Rule State Counts","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleStateCounts","properties":{"off":{"type":"integer","description":" Number of rules which are Off","title":"Off","format":"int64","x-displayname":"Off"},"on":{"type":"integer","description":" Number of rules which are On","title":"On","format":"int64","x-displayname":"On"}}},"bot_detection_ruleRuleSummary":{"type":"object","description":"Rule summary of bot detection rules","title":"RuleSummary","x-displayname":"Rule Summary","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleSummary","properties":{"draft":{"$ref":"#/components/schemas/bot_detection_ruleDraftRuleCounts"},"prod":{"$ref":"#/components/schemas/bot_detection_ruleEnvironmentRuleCounts"},"test":{"$ref":"#/components/schemas/bot_detection_ruleEnvironmentRuleCounts"}}},"bot_detection_ruleSaveDraftResponse":{"type":"object","description":"Response for save draft","title":"SaveDraftResponse","x-displayname":"Save Draft Response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.SaveDraftResponse"},"bot_infrastructureEnvironmentType":{"type":"string","description":"Identifies the environment as either Production or Testing. Production environments have two infrastructure regions in an Active-Active configuration where traffic is routed equally between the two regions. Test environments have a single infrastructure region.\n\nProduction Protect live production applications and services from automated attacks.\nTest Evaluate new features, settings, and system performance.","title":"EnvironmentType","enum":["PRODUCTION","TESTING"],"default":"PRODUCTION","x-displayname":"Environment Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.bot_infrastructure.EnvironmentType"},"bot_infrastructureTrafficType":{"type":"string","description":"The type of traffic that is routed to and processed by this infrastructure (Web or Mobile).\n\nOnly web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure.\nOnly mobile traffic from native mobile apps with the Bot Defense SDK are routed through this Bot Defense infrastructure.","title":"TrafficType","enum":["WEB","MOBILE"],"default":"WEB","x-displayname":"Traffic Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.bot_infrastructure.TrafficType"},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"threat_intelligenceBotInfraDeploymentDetails":{"type":"object","description":"Bot Infrastructure Deployment Details","title":"BotInfraDeploymentDetails","x-displayname":"Bot Infrastructure Deployment Details","x-ves-oneof-field-status":"[\"bot_infra_status\",\"region_status\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentDetails","properties":{"bot_infra_name":{"type":"string","description":" Name of the bot infrastructure as per SAPI's database","title":"BotInfraName","x-displayname":"Bot Infrastructure Name"},"bot_infra_status":{"$ref":"#/components/schemas/threat_intelligenceBotInfraDeploymentStatusDetails"},"bot_infrastructure_type":{"$ref":"#/components/schemas/threat_intelligenceBotInfrastuctureType"},"environment":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"region_status":{"$ref":"#/components/schemas/threat_intelligenceRegionStatus"}}},"threat_intelligenceBotInfraDeploymentStatus":{"type":"string","description":"Deployment status of bot-infrastructure\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for the cluster\nSuccess represents the status when SAPI's deployment status API returns success for the cluster\nFailed represents the status when SAPI's deployment status API returns failure for the cluster\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for the cluster","title":"BotInfraDeploymentStatus","enum":["BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN","BOT_INFRA_DEPLOYMENT_STATUS_INITIATED","BOT_INFRA_DEPLOYMENT_STATUS_SUCCESS","BOT_INFRA_DEPLOYMENT_STATUS_FAILED","BOT_INFRA_DEPLOYMENT_STATUS_INITIATION_FAILED"],"default":"BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN","x-displayname":"Bot-Infra Deployment Status","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentStatus"},"threat_intelligenceBotInfraDeploymentStatusDetails":{"type":"object","description":"Bot Infrastructure Deployment Status Details","title":"BotInfraDeploymentStatusDetails","x-displayname":"Bot Infrastructure Deployment Status Details","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentStatusDetails","properties":{"bot_infra_deployment_status":{"$ref":"#/components/schemas/threat_intelligenceBotInfraDeploymentStatus"},"status_message":{"type":"string","description":" Status message. In case of error, this would contain error details","title":"StatusMessage","x-displayname":"Status Message"}}},"threat_intelligenceBotInfrastructure":{"type":"object","description":"Bot Infrastructure","title":"Bot Infrastructure","x-displayname":"Bot Infrastructure","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfrastructure","properties":{"environment_type":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"name":{"type":"string","description":" Name of the bot-infrastructure","title":"Name","x-displayname":"Name"}}},"threat_intelligenceBotInfrastuctureType":{"type":"string","description":"Type of the Bot Infrastructure\n\n - BOT_INFRA_TYPE_UNKNOWN: Unknown\n\n - BOT_INFRA_TYPE_CLOUD_HOSTED: F5 Cloud Hosted\n\n - BOT_INFRA_TYPE_HOSTED: F5 Hosted\n\n - BOT_INFRA_TYPE_ON_PREM: F5 On Premises\n","title":"BotInfrastuctureType","enum":["BOT_INFRA_TYPE_UNKNOWN","BOT_INFRA_TYPE_CLOUD_HOSTED","BOT_INFRA_TYPE_HOSTED","BOT_INFRA_TYPE_ON_PREM"],"default":"BOT_INFRA_TYPE_UNKNOWN","x-displayname":"Bot Infrastructure Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfrastuctureType"},"threat_intelligenceRegionStatus":{"type":"object","description":"The status of each bot infrastructure per region","title":"Bot Infra Deployment Status Per Region","x-displayname":"Bot Infra Deployment Status Per Region","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.RegionStatus","properties":{"region_status_details":{"type":"object","description":" Bot Infra Deployment Status Details Per Region","title":"Bot Infra Deployment Status Details Per Region","x-displayname":"Bot Infra Deployment Status Details Per Region"}}},"threat_intelligencebot_detection_ruleGetSpecType":{"type":"object","description":"Get Bot Detection Rule","title":"Get Bot Detection Rule","x-displayname":"Get Bot Detection Rule","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetSpecType","properties":{"bot_detection_rule_configs_per_bot_infras":{"type":"array","items":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra"},"x-displayname":"Rule configurations per Bot-Infras"},"classification":{"type":"array","description":"\n\nExample: ` \"[\"environment\", \"execution\", \"timing\"]\"`","items":{"type":"string"},"x-displayname":"Classification","x-ves-example":"[\"environment\", \"execution\", \"timing\"]"},"cluster_groups":{"type":"array","description":"\n\nExample: ` \"[Add to cart, login]\"`","items":{"type":"string"},"x-displayname":"Cluster Groups","x-ves-example":"[Add to cart, login]"},"created_at":{"type":"string","description":" Created at as per SAPI's database","format":"date-time","x-displayname":"Created At"},"description":{"type":"string","description":"\n\nExample: ` \"Detection of signal payload\"`","x-displayname":"Description","x-ves-example":"Detection of signal payload"},"last_modified_at":{"type":"string","description":" Last modified at as per SAPI's database","format":"date-time","x-displayname":"Last Modified At"},"last_modified_by":{"type":"string","description":" Last Modified By as per SAPI's database","x-displayname":"Last Modified By"},"rule_name":{"type":"string","description":"\n\nExample: ` \"Rule_CB_DUBEXLDQKV\"`","x-displayname":"Rule Name","x-ves-example":"Rule_CB_DUBEXLDQKV"},"rule_type":{"$ref":"#/components/schemas/bot_detection_ruleBotDetectionRuleType"},"traffic_type":{"$ref":"#/components/schemas/bot_infrastructureTrafficType"},"version":{"type":"integer","description":"\n\nExample: ` \"1\"`","format":"int64","x-displayname":"Version","x-ves-example":"1"}}}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0037.public.ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update","description":"Public Custom API definition for Bot Detection Update","version":""},"paths":{"/api/shape/bot/namespaces/{namespace}/bot_detection_updates":{"get":{"summary":"Get bot detection updates","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.GetBotDetectionUpdates","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_updateGetBotDetectionUpdatesResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","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-threat_intelligence-bot_detection_update-customapi-getbotdetectionupdates"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.GetBotDetectionUpdates"},"x-displayname":"Bot Detection Update","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/bot/namespaces/{namespace}/bot_detection_updates/download_release_notes":{"get":{"summary":"Download BotDetection Updates Release Notes","operationId":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.DownloadBotDetectionUpdatesReleaseNotes","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/bot_detection_updateDownloadBotDetectionUpdatesReleaseNotesResponse"}}}},"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-example: \"system\"\nx-required\nNamespace is used to scope the query","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"deployment_id","description":"x-example: \"06957ed8-52b5-43e0-bb56-429db281bfb4\"\nx-required\nUnique identifier for a deployment","in":"query","required":false,"x-displayname":"Deployment Id","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-threat_intelligence-bot_detection_update-customapi-downloadbotdetectionupdatesreleasenotes"},"x-ves-proto-rpc":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.DownloadBotDetectionUpdatesReleaseNotes"},"x-displayname":"Bot Detection Update","x-ves-proto-service":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Bot Detection Update","x-ves-proto-package":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update","components":{"schemas":{"bot_detection_updateBotDetectionUpdate":{"type":"object","description":"Bot detection update holds details of a new threat intelligence package deployment","title":"BotDetectionUpdate","x-displayname":"Bot Detection Update","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.BotDetectionUpdate","properties":{"bot_infrastructures":{"type":"array","description":" Bot Infrastructure(s) impacted by the release if a new theat intelligence package","title":"Bot Infrastructures","items":{"$ref":"#/components/schemas/threat_intelligenceBotInfrastructure"},"x-displayname":"Bot Infrastructures"},"deployment_id":{"type":"string","description":" Deployment Id is used to uniquely identify a deployment/scheduled deployment","title":"Deployment Id","x-displayname":"Deployment Id"},"deployment_range":{"$ref":"#/components/schemas/bot_detection_updateDeploymentRange"},"deployment_status":{"$ref":"#/components/schemas/bot_detection_updateThreatIntelligencePackageDeploymentStatus"},"traffic_type":{"$ref":"#/components/schemas/bot_infrastructureTrafficType"}}},"bot_detection_updateDeploymentRange":{"type":"object","description":"Deployment range holds the different types of deployment timing i.e deploy at a specific time, deploy within a time range, etc","title":"DeploymentRange","x-displayname":"Deployment Range","x-ves-oneof-field-type":"[\"initiated_time\",\"time_range\"]","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.DeploymentRange","properties":{"initiated_time":{"type":"string","description":"Exclusive with [time_range]\n Timestamp at which the deployment is initiated - Relevant when deployment status is 'Initiated', 'Initiation Failed', 'Partially Initiated', 'Deployed', 'Failed', 'Partially Deployed'","title":"Initiated Time","format":"date-time","x-displayname":"Initiated Time"},"time_range":{"$ref":"#/components/schemas/bot_detection_updateTimeRange"}}},"bot_detection_updateDownloadBotDetectionUpdatesReleaseNotesResponse":{"type":"object","description":"Response for download bot detection updates release notes","title":"DownloadBotDetectionUpdatesReleaseNotesResponse","x-displayname":"Download bot detection updates release notes response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.DownloadBotDetectionUpdatesReleaseNotesResponse","properties":{"pre_signed_url":{"type":"string","description":" Pre-Signed URL for the release notes PDF. The expiration of this URL is controlled by config","title":"Pre-Signed URL","x-displayname":"Pre-Signed URL"}}},"bot_detection_updateGetBotDetectionUpdatesResponse":{"type":"object","description":"Response for get bot detection updates","title":"GetBotDetectionUpdatesResponse","x-displayname":"Get bot detection updates response","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.GetBotDetectionUpdatesResponse","properties":{"bot_detection_updates":{"type":"array","description":" Bot detection updates holds details of a new threat intelligence package deployment","title":"Bot Detection Updates","items":{"$ref":"#/components/schemas/bot_detection_updateBotDetectionUpdate"},"x-displayname":"Bot Detection Updates"}}},"bot_detection_updateThreatIntelligencePackageDeploymentStatus":{"type":"string","description":"Deployment status of a new threat intelligence package\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch\nPending Submission represents the status when the threat intelligence package details are loaded into the database and before initiating the SAPI deployment","title":"ThreatIntelligencePackageDeploymentStatus","enum":["THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_INITIATED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_DEPLOYED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_FAILED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_INITIATION_FAILED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PARTIALLY_INITIATED","THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PENDING_SUBMISSION"],"default":"THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN","x-displayname":"Threat Intelligence Package Deployment Status","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.ThreatIntelligencePackageDeploymentStatus"},"bot_detection_updateTimeRange":{"type":"object","description":"Time range holds the start time and end time","title":"TimeRange","x-displayname":"Time Range","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.TimeRange","properties":{"end_time":{"type":"string","title":"End Time","format":"date-time","x-displayname":"End Time"},"start_time":{"type":"string","title":"Start Time","format":"date-time","x-displayname":"Start Time"}}},"bot_infrastructureEnvironmentType":{"type":"string","description":"Identifies the environment as either Production or Testing. Production environments have two infrastructure regions in an Active-Active configuration where traffic is routed equally between the two regions. Test environments have a single infrastructure region.\n\nProduction Protect live production applications and services from automated attacks.\nTest Evaluate new features, settings, and system performance.","title":"EnvironmentType","enum":["PRODUCTION","TESTING"],"default":"PRODUCTION","x-displayname":"Environment Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.bot_infrastructure.EnvironmentType"},"bot_infrastructureTrafficType":{"type":"string","description":"The type of traffic that is routed to and processed by this infrastructure (Web or Mobile).\n\nOnly web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure.\nOnly mobile traffic from native mobile apps with the Bot Defense SDK are routed through this Bot Defense infrastructure.","title":"TrafficType","enum":["WEB","MOBILE"],"default":"WEB","x-displayname":"Traffic Type","x-ves-proto-enum":"ves.io.schema.shape.bot_defense.bot_infrastructure.TrafficType"},"threat_intelligenceBotInfrastructure":{"type":"object","description":"Bot Infrastructure","title":"Bot Infrastructure","x-displayname":"Bot Infrastructure","x-ves-proto-message":"ves.io.schema.shape.bot_defense.threat_intelligence.BotInfrastructure","properties":{"environment_type":{"$ref":"#/components/schemas/bot_infrastructureEnvironmentType"},"name":{"type":"string","description":" Name of the bot-infrastructure","title":"Name","x-displayname":"Name"}}}}}}