@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.4

package/dist/docs/specifications/api/docs-cloud-f5-com.0021.public.ves.io.schema.api_sec.rule_suggestion.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.api_sec.rule_suggestion","description":"APIs to get rule suggestions from App Security Monitoring pages","version":""},"paths":{"/api/config/namespaces/{namespace}/api_sec/rule_suggestion/api_endpoint_protection":{"post":{"summary":"Suggest api endpoint protection rule","description":"Suggest API endpoint protection rule for a given path","operationId":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedAPIEndpointProtectionRule","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedAPIEndpointProtectionRuleRsp"}}}},"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: \"shared\"\nx-required\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedAPIEndpointProtectionRuleReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-rule_suggestion-rulesuggestionapi-getsuggestedapiendpointprotectionrule"},"x-ves-proto-rpc":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedAPIEndpointProtectionRule"},"x-displayname":"Application Security Monitoring APIs","x-ves-proto-service":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/api_sec/rule_suggestion/data_exposure":{"post":{"summary":"Suggest sensitive data rule","description":"Suggest sensitive data rule for a given path","operationId":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedSensitiveDataRule","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedSensitiveDataRuleRsp"}}}},"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: \"shared\"\nx-required\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedSensitiveDataRuleReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-rule_suggestion-rulesuggestionapi-getsuggestedsensitivedatarule"},"x-ves-proto-rpc":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedSensitiveDataRule"},"x-displayname":"Application Security Monitoring APIs","x-ves-proto-service":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/api_sec/rule_suggestion/oas_validation":{"post":{"summary":"Suggest Open API specification validation rule","description":"Suggest Open API specification validation rule for a given path","operationId":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedOasValidationRule","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedOasValidationRuleRsp"}}}},"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: \"shared\"\nx-required\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedOasValidationRuleReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-rule_suggestion-rulesuggestionapi-getsuggestedoasvalidationrule"},"x-ves-proto-rpc":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedOasValidationRule"},"x-displayname":"Application Security Monitoring APIs","x-ves-proto-service":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/api_sec/rule_suggestion/rate_limit":{"post":{"summary":"Suggest rate limit rule","description":"Suggest rate limit rule for a given path","operationId":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedRateLimitRule","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedRateLimitRuleRsp"}}}},"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: \"shared\"\nx-required\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_suggestionGetSuggestedRateLimitRuleReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-api_sec-rule_suggestion-rulesuggestionapi-getsuggestedratelimitrule"},"x-ves-proto-rpc":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI.GetSuggestedRateLimitRule"},"x-displayname":"Application Security Monitoring APIs","x-ves-proto-service":"ves.io.schema.api_sec.rule_suggestion.RuleSuggestionAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Application Security Monitoring APIs","x-ves-proto-package":"ves.io.schema.api_sec.rule_suggestion","components":{"schemas":{"common_wafAPIEndpointProtectionRule":{"type":"object","description":"API Protection Rule for a specific endpoint","title":"API Endpoint Protection Rule","x-displayname":"API Endpoint Protection Rule","x-ves-oneof-field-domain_choice":"[\"any_domain\",\"specific_domain\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.APIEndpointProtectionRule","properties":{"action":{"$ref":"#/components/schemas/common_wafAPIProtectionRuleAction"},"any_domain":{"$ref":"#/components/schemas/schemaEmpty"},"api_endpoint_method":{"$ref":"#/components/schemas/policyHttpMethodMatcherType"},"api_endpoint_path":{"type":"string","description":" The endpoint (path) of the request.\n\nExample: ` \"/endpoint1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"api endpoint path","maxLength":1024,"x-displayname":"API Endpoint","x-ves-example":"/endpoint1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"client_matcher":{"$ref":"#/components/schemas/policyClientMatcher"},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"request_matcher":{"$ref":"#/components/schemas/policyRequestMatcher"},"specific_domain":{"type":"string","description":"Exclusive with [any_domain]\n The rule will apply for a specific domain.\n For example: api.example.com\n\nExample: ` \"api.example.com\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n  ves.io.schema.rules.string.vh_domain: true\n","title":"domain","maxLength":128,"x-displayname":"Specific Domain","x-ves-example":"api.example.com","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128","ves.io.schema.rules.string.vh_domain":"true"}}}},"common_wafAPIProtectionRuleAction":{"type":"object","description":"The action to take if the input request matches the rule.","title":"API Protection Rule Action","x-displayname":"API Protection Rule Action","x-ves-oneof-field-action":"[\"allow\",\"deny\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.APIProtectionRuleAction","properties":{"allow":{"$ref":"#/components/schemas/schemaEmpty"},"deny":{"$ref":"#/components/schemas/schemaEmpty"}}},"common_wafApiEndpointDetails":{"type":"object","description":"This defines api endpoint","title":"ApiEndpointDetails","x-displayname":"API Endpoint","x-ves-proto-message":"ves.io.schema.views.common_waf.ApiEndpointDetails","properties":{"methods":{"type":"array","description":" Methods to be matched\n\nExample: ` \"GET\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"Methods","maxItems":16,"items":{"$ref":"#/components/schemas/schemaHttpMethod"},"x-displayname":"Methods","x-ves-example":"GET","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"path":{"type":"string","description":" Path to be matched\n\nExample: ` \"/api/v1/login\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"Path","maxLength":1024,"x-displayname":"Path","x-ves-example":"/api/v1/login","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}}}},"common_wafApiEndpointRule":{"type":"object","title":"ApiEndpointRule","x-displayname":"ApiEndpointRule","x-ves-oneof-field-domain_choice":"[\"any_domain\",\"specific_domain\"]","x-ves-oneof-field-rate_limiter_choice":"[\"inline_rate_limiter\",\"ref_rate_limiter\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.ApiEndpointRule","properties":{"any_domain":{"$ref":"#/components/schemas/schemaEmpty"},"api_endpoint_method":{"$ref":"#/components/schemas/policyHttpMethodMatcherType"},"api_endpoint_path":{"type":"string","description":" The endpoint (path) of the request.\n\nExample: ` \"value\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"api endpoint path","maxLength":1024,"x-displayname":"API Endpoint","x-ves-example":"value","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"client_matcher":{"$ref":"#/components/schemas/policyClientMatcher"},"inline_rate_limiter":{"$ref":"#/components/schemas/common_wafInlineRateLimiter"},"ref_rate_limiter":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"request_matcher":{"$ref":"#/components/schemas/policyRequestMatcher"},"specific_domain":{"type":"string","description":"Exclusive with [any_domain]\n The rule will apply for a specific domain.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n  ves.io.schema.rules.string.vh_domain: true\n","title":"domain","maxLength":128,"x-displayname":"Specific Domain","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128","ves.io.schema.rules.string.vh_domain":"true"}}}},"common_wafCustomFallThroughMode":{"type":"object","description":"Define the fall through settings","title":"Custom Fall Through Mode","x-displayname":"Custom Fall Through Mode","x-ves-proto-message":"ves.io.schema.views.common_waf.CustomFallThroughMode","properties":{"open_api_validation_rules":{"type":"array","description":"\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 15\n  ves.io.schema.rules.repeated.unique_metadata_name: true\n","title":"Custom Fall Through Rule List","maxItems":15,"items":{"$ref":"#/components/schemas/common_wafFallThroughRule"},"x-displayname":"Custom Fall Through Rule List","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"15","ves.io.schema.rules.repeated.unique_metadata_name":"true"}}}},"common_wafFallThroughRule":{"type":"object","description":"Fall Through Rule for a specific endpoint, base-path, or API group","title":"Fall Through Rule","x-displayname":"Fall Through Rule","x-ves-oneof-field-action_choice":"[\"action_block\",\"action_report\",\"action_skip\"]","x-ves-oneof-field-condition_type_choice":"[\"api_endpoint\",\"api_group\",\"base_path\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.FallThroughRule","properties":{"action_block":{"$ref":"#/components/schemas/schemaEmpty"},"action_report":{"$ref":"#/components/schemas/schemaEmpty"},"action_skip":{"$ref":"#/components/schemas/schemaEmpty"},"api_endpoint":{"$ref":"#/components/schemas/common_wafApiEndpointDetails"},"api_group":{"type":"string","description":"Exclusive with [api_endpoint base_path]\n The API group which this validation applies to\n\nExample: ` \"oas-all-operations\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"api_group","maxLength":128,"x-displayname":"API Group","x-ves-example":"oas-all-operations","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"base_path":{"type":"string","description":"Exclusive with [api_endpoint api_group]\n The base path which this validation applies to\n\nExample: ` \"/api/v1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 128\n","title":"base path","maxLength":128,"x-displayname":"Base Path","x-ves-example":"/api/v1","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"128"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"}}},"common_wafInlineRateLimiter":{"type":"object","title":"InlineRateLimiter","x-displayname":"InlineRateLimiter","x-ves-oneof-field-count_by_choice":"[\"ref_user_id\",\"use_http_lb_user_id\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.InlineRateLimiter","properties":{"ref_user_id":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"threshold":{"type":"integer","description":" The total number of allowed requests for 1 unit (e.g. SECOND/MINUTE/HOUR etc.) of the specified period.\n\nExample: ` \"1\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.uint32.gt: 0\n  ves.io.schema.rules.uint32.lte: 8192\n","title":"threshold","format":"int64","x-displayname":"Threshold","x-ves-example":"1","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.uint32.gt":"0","ves.io.schema.rules.uint32.lte":"8192"}},"unit":{"$ref":"#/components/schemas/rate_limiterRateLimitPeriodUnit"},"use_http_lb_user_id":{"$ref":"#/components/schemas/schemaEmpty"}}},"common_wafOpenApiFallThroughMode":{"type":"object","description":"x-required\nDetermine what to do with unprotected endpoints (not in the OpenAPI specification file (a.k.a. swagger) or doesn't have a specific rule in custom rules)","title":"Fall Through Mode","x-displayname":"Fall Through Mode","x-ves-oneof-field-fall_through_mode_choice":"[\"fall_through_mode_allow\",\"fall_through_mode_custom\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiFallThroughMode","properties":{"fall_through_mode_allow":{"$ref":"#/components/schemas/schemaEmpty"},"fall_through_mode_custom":{"$ref":"#/components/schemas/common_wafCustomFallThroughMode"}}},"common_wafOpenApiValidationAllSpecEndpointsSettings":{"type":"object","description":"Settings for API Inventory validation","title":"OpenAPI Validation API Inventory Settings","x-displayname":"API Inventory","x-ves-oneof-field-oversized_body_choice":"[]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationAllSpecEndpointsSettings","properties":{"fall_through_mode":{"$ref":"#/components/schemas/common_wafOpenApiFallThroughMode"},"settings":{"$ref":"#/components/schemas/common_wafOpenApiValidationCommonSettings"},"validation_mode":{"$ref":"#/components/schemas/common_wafOpenApiValidationMode"}}},"common_wafOpenApiValidationCommonSettings":{"type":"object","description":"OpenAPI specification validation settings relevant for \"API Inventory\" enforcement and for \"Custom list\" enforcement","title":"OpenAPI specification validation common settings","x-displayname":"Common Settings","x-ves-oneof-field-fail_configuration":"[]","x-ves-oneof-field-oversized_body_choice":"[\"oversized_body_fail_validation\",\"oversized_body_skip_validation\"]","x-ves-oneof-field-property_validation_settings_choice":"[\"property_validation_settings_custom\",\"property_validation_settings_default\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationCommonSettings","properties":{"oversized_body_fail_validation":{"$ref":"#/components/schemas/schemaEmpty"},"oversized_body_skip_validation":{"$ref":"#/components/schemas/schemaEmpty"},"property_validation_settings_custom":{"$ref":"#/components/schemas/common_wafValidationPropertySetting"},"property_validation_settings_default":{"$ref":"#/components/schemas/schemaEmpty"}}},"common_wafOpenApiValidationMode":{"type":"object","description":"x-required\nValidation mode of OpenAPI specification.\n When a validation mismatch occurs on a request to one of the endpoints listed on the OpenAPI specification file (a.k.a. swagger)","title":"Validation Mode","x-displayname":"Validation Mode","x-ves-oneof-field-response_validation_mode_choice":"[\"response_validation_mode_active\",\"skip_response_validation\"]","x-ves-oneof-field-validation_mode_choice":"[\"skip_validation\",\"validation_mode_active\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationMode","properties":{"response_validation_mode_active":{"$ref":"#/components/schemas/common_wafOpenApiValidationModeActiveResponse"},"skip_response_validation":{"$ref":"#/components/schemas/schemaEmpty"},"skip_validation":{"$ref":"#/components/schemas/schemaEmpty"},"validation_mode_active":{"$ref":"#/components/schemas/common_wafOpenApiValidationModeActive"}}},"common_wafOpenApiValidationModeActive":{"type":"object","description":"Validation mode properties of request","title":"Open API Validation Mode Active For Request","x-displayname":"Open API Validation Mode Active","x-ves-oneof-field-validation_enforcement_type":"[\"enforcement_block\",\"enforcement_report\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationModeActive","properties":{"enforcement_block":{"$ref":"#/components/schemas/schemaEmpty"},"enforcement_report":{"$ref":"#/components/schemas/schemaEmpty"},"request_validation_properties":{"type":"array","description":" List of properties of the request to validate according to the OpenAPI specification file (a.k.a. swagger)\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.not_in: [7]\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Request Validation Properties","minItems":1,"items":{"$ref":"#/components/schemas/schemaOpenApiValidationProperties"},"x-displayname":"Request Validation Properties","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.not_in":"[7]","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"common_wafOpenApiValidationModeActiveResponse":{"type":"object","description":"Validation mode properties of response","title":"Open API Validation Mode Active For Response","x-displayname":"Open API Validation Mode Active","x-ves-oneof-field-validation_enforcement_type":"[\"enforcement_block\",\"enforcement_report\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationModeActiveResponse","properties":{"enforcement_block":{"$ref":"#/components/schemas/schemaEmpty"},"enforcement_report":{"$ref":"#/components/schemas/schemaEmpty"},"response_validation_properties":{"type":"array","description":" List of properties of the response to validate according to the OpenAPI specification file (a.k.a. swagger)\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.items.enum.in: [2,4,5,7]\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Response Validation Properties","minItems":1,"items":{"$ref":"#/components/schemas/schemaOpenApiValidationProperties"},"x-displayname":"Response Validation Properties","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.items.enum.in":"[2,4,5,7]","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"common_wafOpenApiValidationRule":{"type":"object","description":"OpenAPI Validation Rule for a specific endpoint, base-path, or API group","title":"OpenAPI Validation Rule","x-displayname":"OpenAPI Validation Rule","x-ves-oneof-field-condition_type_choice":"[\"api_endpoint\",\"api_group\",\"base_path\"]","x-ves-oneof-field-domain_choice":"[\"any_domain\",\"specific_domain\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.OpenApiValidationRule","properties":{"any_domain":{"$ref":"#/components/schemas/schemaEmpty"},"api_endpoint":{"$ref":"#/components/schemas/common_wafApiEndpointDetails"},"api_group":{"type":"string","description":"Exclusive with [api_endpoint base_path]\n The API group which this validation applies to\n\nExample: ` \"oas-all-operations\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n","title":"api_group","maxLength":128,"x-displayname":"API Group","x-ves-example":"oas-all-operations","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128"}},"base_path":{"type":"string","description":"Exclusive with [api_endpoint api_group]\n The base path which this validation applies to\n\nExample: ` \"/api/v1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.http_path: true\n  ves.io.schema.rules.string.max_len: 128\n","title":"base path","maxLength":128,"x-displayname":"Base Path","x-ves-example":"/api/v1","x-ves-validation-rules":{"ves.io.schema.rules.string.http_path":"true","ves.io.schema.rules.string.max_len":"128"}},"metadata":{"$ref":"#/components/schemas/schemaMessageMetaType"},"specific_domain":{"type":"string","description":"Exclusive with [any_domain]\n The rule will apply for a specific domain.\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 128\n  ves.io.schema.rules.string.vh_domain: true\n","title":"domain","maxLength":128,"x-displayname":"Specific Domain","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"128","ves.io.schema.rules.string.vh_domain":"true"}},"validation_mode":{"$ref":"#/components/schemas/common_wafOpenApiValidationMode"}}},"common_wafValidationPropertySetting":{"type":"object","description":"Custom property validation settings","title":"Validation Property settings","x-displayname":"Validation Property Settings","x-ves-proto-message":"ves.io.schema.views.common_waf.ValidationPropertySetting","properties":{"queryParameters":{"$ref":"#/components/schemas/common_wafValidationSettingForQueryParameters"}}},"common_wafValidationSettingForHeaders":{"type":"object","description":"x-displayName: \"Validation Settings For Headers\"\nCustom settings for headers validation","title":"Validation Settings For Headers","properties":{"allow_additional_headers":{"$ref":"#/components/schemas/schemaEmpty"},"disallow_additional_headers":{"$ref":"#/components/schemas/schemaEmpty"}}},"common_wafValidationSettingForQueryParameters":{"type":"object","description":"Custom settings for query parameters validation","title":"Validation Settings For Query Parameters","x-displayname":"Validation Settings For Query Parameters","x-ves-oneof-field-additional_parameters_choice":"[\"allow_additional_parameters\",\"disallow_additional_parameters\"]","x-ves-proto-message":"ves.io.schema.views.common_waf.ValidationSettingForQueryParameters","properties":{"allow_additional_parameters":{"$ref":"#/components/schemas/schemaEmpty"},"disallow_additional_parameters":{"$ref":"#/components/schemas/schemaEmpty"}}},"http_loadbalancerBodySectionMaskingOptions":{"type":"object","description":"Options for HTTP Body Masking","title":"Body Section Masking Options","x-displayname":"Body Section Masking Options","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.BodySectionMaskingOptions","properties":{"fields":{"type":"array","description":" List of JSON Path field values. Use square brackets with an underscore [_] to indicate array elements (e.g., person.emails[_]). To reference JSON keys that contain spaces, enclose the entire path in double quotes. For example: \"person.first name\".\n\nExample: ` \"['user.email', 'credit_card']\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.json_path: true\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.min_bytes: 1\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Values","minItems":1,"maxItems":16,"items":{"type":"string","minLength":1,"maxLength":256},"x-displayname":"Values","x-ves-example":"['user.email', 'credit_card']","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.json_path":"true","ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.min_bytes":"1","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"http_loadbalancerSensitiveDataTypes":{"type":"object","description":"Settings to mask sensitive data in request/response payload","title":"Sensitive Data Types","x-displayname":"Sensitive Data Types","x-ves-oneof-field-masking_mode_choice":"[\"mask\",\"report\"]","x-ves-oneof-field-type_condition_type_choice":"[\"api_endpoint\"]","x-ves-proto-message":"ves.io.schema.views.http_loadbalancer.SensitiveDataTypes","properties":{"api_endpoint":{"$ref":"#/components/schemas/common_wafApiEndpointDetails"},"body":{"$ref":"#/components/schemas/http_loadbalancerBodySectionMaskingOptions"},"mask":{"$ref":"#/components/schemas/schemaEmpty"},"report":{"$ref":"#/components/schemas/schemaEmpty"}}},"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"}}},"policyAsnMatchList":{"type":"object","description":"An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.","title":"Asn Match List","x-displayname":"ASN Match List","x-ves-proto-message":"ves.io.schema.policy.AsnMatchList","properties":{"as_numbers":{"type":"array","description":" An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.\n\nExample: ` \"[713, 7932, 847325, 4683, 15269, 1000001]\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"as numbers","minItems":1,"maxItems":16,"items":{"type":"integer","format":"int64"},"x-displayname":"AS Numbers","x-ves-example":"[713, 7932, 847325, 4683, 15269, 1000001]","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}}}},"policyAsnMatcherType":{"type":"object","description":"Match any AS number contained in the list of bgp_asn_sets.","title":"asn matcher type","x-displayname":"ASN Matcher","x-ves-proto-message":"ves.io.schema.policy.AsnMatcherType","properties":{"asn_sets":{"type":"array","description":" A list of references to bgp_asn_set objects.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n","title":"asn_sets","maxItems":4,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"BGP ASN Sets","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"4"}}}},"policyClientMatcher":{"type":"object","description":"Client conditions for matching a rule","title":"Client Matcher","x-displayname":"Client Matcher","x-ves-oneof-field-client_choice":"[\"any_client\",\"client_selector\",\"ip_threat_category_list\"]","x-ves-oneof-field-ip_asn_choice":"[\"any_ip\",\"asn_list\",\"asn_matcher\",\"ip_matcher\",\"ip_prefix_list\"]","x-ves-proto-message":"ves.io.schema.policy.ClientMatcher","properties":{"any_client":{"$ref":"#/components/schemas/schemaEmpty"},"any_ip":{"$ref":"#/components/schemas/schemaEmpty"},"asn_list":{"$ref":"#/components/schemas/policyAsnMatchList"},"asn_matcher":{"$ref":"#/components/schemas/policyAsnMatcherType"},"client_selector":{"$ref":"#/components/schemas/schemaLabelSelectorType"},"ip_matcher":{"$ref":"#/components/schemas/policyIpMatcherType"},"ip_prefix_list":{"$ref":"#/components/schemas/policyPrefixMatchList"},"ip_threat_category_list":{"$ref":"#/components/schemas/schemapolicyIPThreatCategoryListType"},"tls_fingerprint_matcher":{"$ref":"#/components/schemas/policyTlsFingerprintMatcherType"}}},"policyCookieMatcherType":{"type":"object","description":"A cookie matcher specifies the name of a single cookie and the criteria to match it. The input has a list of values for each\ncookie in the request.\nA cookie matcher can check for one of the following:\n* Presence or absence of the cookie\n* At least one of the values for the cookie in the request satisfies the MatcherType item","title":"CookieMatcherType","x-displayname":"Cookie Matcher","x-ves-displayorder":"1,6,4","x-ves-oneof-field-match":"[\"check_not_present\",\"check_present\",\"item\"]","x-ves-proto-message":"ves.io.schema.policy.CookieMatcherType","properties":{"check_not_present":{"$ref":"#/components/schemas/schemaEmpty"},"check_present":{"$ref":"#/components/schemas/schemaEmpty"},"invert_matcher":{"type":"boolean","description":" Invert Match of the expression defined","title":"invert_matcher","format":"boolean","x-displayname":"Invert Matcher"},"item":{"$ref":"#/components/schemas/policyMatcherType"},"name":{"type":"string","description":" A case-sensitive cookie name.\n\nExample: ` \"Session\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"name","maxLength":256,"x-displayname":"Cookie Name","x-ves-example":"Session","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256"}}}},"policyHttpMethodMatcherType":{"type":"object","description":"A http method matcher specifies a list of methods to match an input HTTP method. The match is considered successful if the input method is a member of the list.\nThe result of the match based on the method list is inverted if invert_matcher is true.","title":"HttpMethodMatcherType","x-displayname":"HTTP Method Matcher","x-ves-proto-message":"ves.io.schema.policy.HttpMethodMatcherType","properties":{"invert_matcher":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert Method Matcher"},"methods":{"type":"array","description":" List of methods values to match against.\n\nExample: ` \"['GET', 'POST', 'DELETE']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.enum.defined_only: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"methods","maxItems":16,"items":{"$ref":"#/components/schemas/schemaHttpMethod"},"x-displayname":"Method List","x-ves-example":"['GET', 'POST', 'DELETE']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.enum.defined_only":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}}}},"policyIPThreatCategory":{"type":"string","description":"The IP threat categories to use when a policy based IP threat category is configured.\n\n - SPAM_SOURCES: SPAM_SOURCES\n\n - WINDOWS_EXPLOITS: WINDOWS_EXPLOITS\n\n - WEB_ATTACKS: WEB_ATTACKS\n\n - BOTNETS: BOTNETS\n\n - SCANNERS: SCANNERS\n\n - REPUTATION: REPUTATION\n\n - PHISHING: PHISHING\n\n - PROXY: PROXY\n\n - MOBILE_THREATS: MOBILE_THREATS\n\n - TOR_PROXY: TOR_PROXY\n\n - DENIAL_OF_SERVICE: DENIAL_OF_SERVICE\n\n - NETWORK: NETWORK\n","title":"IP Threat Category","enum":["SPAM_SOURCES","WINDOWS_EXPLOITS","WEB_ATTACKS","BOTNETS","SCANNERS","REPUTATION","PHISHING","PROXY","MOBILE_THREATS","TOR_PROXY","DENIAL_OF_SERVICE","NETWORK"],"default":"SPAM_SOURCES","x-displayname":"IP Threat Category","x-ves-proto-enum":"ves.io.schema.policy.IPThreatCategory"},"policyIpMatcherType":{"type":"object","description":"Match any ip prefix contained in the list of ip_prefix_sets.\nThe result of the match is inverted if invert_matcher is true.","title":"ip matcher type","x-displayname":"IP Prefix Matcher","x-ves-proto-message":"ves.io.schema.policy.IpMatcherType","properties":{"invert_matcher":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert IP Matcher"},"prefix_sets":{"type":"array","description":" A list of references to ip_prefix_set objects.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 4\n","title":"prefix_sets","maxItems":4,"items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"IP Prefix Sets","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"4"}}}},"policyJWTClaimMatcherType":{"type":"object","description":"A JWT claim matcher specifies the name of a single JWT claim and the criteria for the input request to match it.\nThe input has a list of actual values for each JWT claim name in the JWT payload.\nA JWT claim matcher can check for one of the following:\n* Presence or absence of the JWT Claim in the input\n* At least one of the values for the JWT Claim in the input satisfies the MatcherType item","title":"JWTClaimMatcherType","x-displayname":"JWT Claim Matcher","x-ves-displayorder":"1,2,6","x-ves-oneof-field-match":"[\"check_not_present\",\"check_present\",\"item\"]","x-ves-proto-message":"ves.io.schema.policy.JWTClaimMatcherType","properties":{"check_not_present":{"$ref":"#/components/schemas/schemaEmpty"},"check_present":{"$ref":"#/components/schemas/schemaEmpty"},"invert_matcher":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert Matcher"},"item":{"$ref":"#/components/schemas/policyMatcherType"},"name":{"type":"string","description":" JWT claim name.\n\nExample: ` \"user_id\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"name","maxLength":256,"x-displayname":"JWT Claim Name","x-ves-example":"user_id","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256"}}}},"policyKnownTlsFingerprintClass":{"type":"string","description":"Specifies known TLS fingerprint classes\n\n - TLS_FINGERPRINT_NONE: TLS_FINGERPRINT_NONE\n\nNo TLS fingerprint\n - ANY_MALICIOUS_FINGERPRINT: ANY_MALICIOUS_FINGERPRINT\n\nTLS fingerprints known to be associated with malicious clients\n - ADWARE: ADWARE\n\nTLS fingerprints known to be associated with adware\n - ADWIND: ADWIND\n\nTLS fingerprints known to be associated with adwind\n - DRIDEX: DRIDEX\n\nTLS fingerprints known to be associated with dridex\n - GOOTKIT: GOOTKIT\n\nTLS fingerprints known to be associated with gootkit\n - GOZI: GOZI\n\nTLS fingerprints known to be associated with gozi\n - JBIFROST: JBIFROST\n\nTLS fingerprints known to be associated with jbifrost\n - QUAKBOT: QUAKBOT\n\nTLS fingerprints known to be associated with quakbot\n - RANSOMWARE: RANSOMWARE\n\nTLS fingerprints known to be associated with ransomware\n - TROLDESH: TROLDESH\n\nTLS fingerprints known to be associated with troldesh\n - TOFSEE: TOFSEE\n\nTLS fingerprints known to be associated with tofsee\n - TORRENTLOCKER: TORRENTLOCKER\n\nTLS fingerprints known to be associated with torrentlocker\n - TRICKBOT: TRICKBOT\n\nTLS fingerprints known to be associated with trickbot","title":"TLS known fingerprint class","enum":["TLS_FINGERPRINT_NONE","ANY_MALICIOUS_FINGERPRINT","ADWARE","ADWIND","DRIDEX","GOOTKIT","GOZI","JBIFROST","QUAKBOT","RANSOMWARE","TROLDESH","TOFSEE","TORRENTLOCKER","TRICKBOT"],"default":"TLS_FINGERPRINT_NONE","x-displayname":"TLS known fingerprint class","x-ves-proto-enum":"ves.io.schema.policy.KnownTlsFingerprintClass"},"policyMatcherType":{"type":"object","description":"A matcher specifies multiple criteria for matching an input string. The match is considered successful if any of the criteria are satisfied. The set\nof supported match criteria includes a list of exact values and a list of regular expressions.","title":"MatcherType","x-displayname":"Matcher","x-ves-proto-message":"ves.io.schema.policy.MatcherType","properties":{"exact_values":{"type":"array","description":" A list of exact values to match the input against.\n\nExample: ` \"['new york', 'london', 'sydney', 'tokyo', 'cairo']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.max_items: 64\n  ves.io.schema.rules.repeated.unique: true\n","title":"exact values","maxItems":64,"items":{"type":"string","maxLength":256},"x-displayname":"Exact Values","x-ves-example":"['new york', 'london', 'sydney', 'tokyo', 'cairo']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.max_items":"64","ves.io.schema.rules.repeated.unique":"true"}},"regex_values":{"type":"array","description":" A list of regular expressions to match the input against.\n\nExample: ` \"['^new .*$', 'san f.*', '.* del .*']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.max_bytes: 256\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.items.string.regex: true\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"regex values","maxItems":16,"items":{"type":"string","maxLength":256},"x-displayname":"Regex Values","x-ves-example":"['^new .*$', 'san f.*', '.* del .*']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.max_bytes":"256","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.items.string.regex":"true","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"transformers":{"type":"array","description":" An ordered list of transformers (starting from index 0) to be applied to the path before matching.\n\nExample: ` \"[BASE64_DECODE, LOWER_CASE]`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 9\n  ves.io.schema.rules.repeated.unique: true\n","title":"transformers","maxItems":9,"items":{"$ref":"#/components/schemas/policyTransformer"},"x-displayname":"Transformers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"9","ves.io.schema.rules.repeated.unique":"true"}}}},"policyPrefixMatchList":{"type":"object","description":"List of IP Prefix strings to match against.","title":"IP Prefix Match List","x-displayname":"IP Prefix Match List","x-ves-proto-message":"ves.io.schema.policy.PrefixMatchList","properties":{"invert_match":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert Match Result"},"ip_prefixes":{"type":"array","description":" List of IPv4 prefix strings.\n\nExample: ` \"192.168.20.0/24\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.ipv4_prefix: true\n  ves.io.schema.rules.repeated.items.string.not_empty: true\n  ves.io.schema.rules.repeated.max_items: 128\n  ves.io.schema.rules.repeated.unique: true\n","title":"ip prefixes","maxItems":128,"items":{"type":"string"},"x-displayname":"IPv4 Prefix List","x-ves-example":"192.168.20.0/24","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv4_prefix":"true","ves.io.schema.rules.repeated.items.string.not_empty":"true","ves.io.schema.rules.repeated.max_items":"128","ves.io.schema.rules.repeated.unique":"true"}}}},"policyRequestMatcher":{"type":"object","description":"Request conditions for matching a rule","title":"Request Matcher","x-displayname":"Request Matcher","x-ves-proto-message":"ves.io.schema.policy.RequestMatcher","properties":{"cookie_matchers":{"type":"array","description":" A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances\n of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name.\n Note that all specified cookie matcher predicates must evaluate to true.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"cookie matchers","maxItems":16,"items":{"$ref":"#/components/schemas/policyCookieMatcherType"},"x-displayname":"Cookie Matchers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}},"headers":{"type":"array","description":" A list of predicates for various HTTP headers that need to match. The criteria for matching each HTTP header are described in individual HeaderMatcherType\n instances. The actual HTTP header values are extracted from the request API as a list of strings for each HTTP header type.\n Note that all specified header predicates must evaluate to true.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"headers","maxItems":16,"items":{"$ref":"#/components/schemas/schemapolicyHeaderMatcherType"},"x-displayname":"HTTP Headers","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}},"jwt_claims":{"type":"array","description":" A list of predicates for various JWT claims that need to match. The criteria for matching each JWT claim are described in individual JWTClaimMatcherType\n instances. The actual JWT claims values are extracted from the JWT payload as a list of strings.\n Note that all specified JWT claim predicates must evaluate to true.\n Note that this feature only works on LBs with JWT Validation feature enabled.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"JWT claims","maxItems":16,"items":{"$ref":"#/components/schemas/policyJWTClaimMatcherType"},"x-displayname":"JWT Claims","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}},"query_params":{"type":"array","description":" A list of predicates for all query parameters that need to be matched. The criteria for matching each query parameter are described in individual instances\n of QueryParameterMatcherType. The actual query parameter values are extracted from the request API as a list of strings for each query parameter name.\n Note that all specified query parameter predicates must evaluate to true.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n","title":"query params","maxItems":16,"items":{"$ref":"#/components/schemas/schemapolicyQueryParameterMatcherType"},"x-displayname":"HTTP Query Parameters","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16"}}}},"policyTlsFingerprintMatcherType":{"type":"object","description":"A TLS fingerprint matcher specifies multiple criteria for matching a TLS fingerprint. The set of supported positve match criteria includes a list of known\nclasses of TLS fingerprints and a list of exact values. The match is considered successful if either of these positive criteria are satisfied and the input\nfingerprint is not one of the excluded values.","title":"TlsFingerprintMatcherType","x-displayname":"TLS Fingerprint Matcher","x-ves-proto-message":"ves.io.schema.policy.TlsFingerprintMatcherType","properties":{"classes":{"type":"array","description":" A list of known classes of TLS fingerprints to match the input TLS JA3 fingerprint against.\n\nExample: ` \"['ADWARE', 'TRICKBOT']`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"classes","maxItems":16,"items":{"$ref":"#/components/schemas/policyKnownTlsFingerprintClass"},"x-displayname":"TLS fingerprint classes","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"exact_values":{"type":"array","description":" A list of exact TLS JA3 fingerprints to match the input TLS JA3 fingerprint against.\n\nExample: ` \"['ed6dfd54b01ebe31b7a65b88abfa7297', '16efcf0e00504ddfedde13bfea997952', 'de364c46b0dfc283b5e38c79ceae3f8f']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.len: 32\n  ves.io.schema.rules.repeated.max_items: 16\n  ves.io.schema.rules.repeated.unique: true\n","title":"exact values","maxItems":16,"items":{"type":"string"},"x-displayname":"Exact Values","x-ves-example":"['ed6dfd54b01ebe31b7a65b88abfa7297', '16efcf0e00504ddfedde13bfea997952', 'de364c46b0dfc283b5e38c79ceae3f8f']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.len":"32","ves.io.schema.rules.repeated.max_items":"16","ves.io.schema.rules.repeated.unique":"true"}},"excluded_values":{"type":"array","description":" A list of TLS JA3 fingerprints to be excluded when matching the input TLS JA3 fingerprint. This can be used to skip known false positives when using one\n or more known TLS fingerprint classes in the enclosing matcher.\n\nExample: ` \"['fb00055a1196aeea8d1bc609885ba953', 'b386946a5a44d1ddcc843bc75336dfce']\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.len: 32\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"excluded values","maxItems":32,"items":{"type":"string"},"x-displayname":"Excluded Values","x-ves-example":"['fb00055a1196aeea8d1bc609885ba953', 'b386946a5a44d1ddcc843bc75336dfce']","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.len":"32","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}}}},"policyTransformer":{"type":"string","description":"Transformers to be applied on the part of the request before matching.\n\n - TRANSFORMER_NONE: transformer none\n\nNo transformers enabled\n - LOWER_CASE: lower case\n\nConvert string to lower case\n - UPPER_CASE: upper case\n\nConvert string to upper case\n - BASE64_DECODE: base64 decode\n\nDecode string assuming base64 encoding\n - NORMALIZE_PATH: normalize path\n\nNormalize URL path so that /a/b/../c will be transformed to /a/c\n - REMOVE_WHITESPACE: remove whitespace\n\nRemove whitespaces\n - URL_DECODE: URL decode\n\nDecode string assuming URL encoding as per rfc1738\n - TRIM_LEFT: trim left\n\nRemove whitespace from the left side of the input string\n - TRIM_RIGHT: trim right\n\nRemove whitespace from the right side of the input string\n - TRIM: trim\n\nRemove whitespace from the both sides of the input string","title":"Transformer","enum":["LOWER_CASE","UPPER_CASE","BASE64_DECODE","NORMALIZE_PATH","REMOVE_WHITESPACE","URL_DECODE","TRIM_LEFT","TRIM_RIGHT","TRIM"],"default":"TRANSFORMER_NONE","x-displayname":"Transformer","x-ves-proto-enum":"ves.io.schema.policy.Transformer"},"rate_limiterRateLimitPeriodUnit":{"type":"string","description":"Unit for the period per which the rate limit is applied.\n\n - SECOND: Second\n\nRate limit period unit is seconds\n - MINUTE: Minute\n\nRate limit period unit is minutes\n - HOUR: Hour\n\nRate limit period unit is hours\n - DAY: Day\n\nRate limit period unit is days","title":"RateLimitPeriodUnit","enum":["SECOND","MINUTE","HOUR"],"default":"SECOND","x-displayname":"Rate Limit Period Unit","x-ves-proto-enum":"ves.io.schema.rate_limiter.RateLimitPeriodUnit"},"rule_suggestionGetSuggestedAPIEndpointProtectionRuleReq":{"type":"object","description":"Get suggested API endpoint protection rule for a given path","title":"GetSuggestedAPIEndpointProtectionRuleReq","x-displayname":"Get Suggested API endpoint protection Rule Request","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedAPIEndpointProtectionRuleReq","properties":{"method":{"$ref":"#/components/schemas/schemaHttpMethod"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"path":{"type":"string","description":" Path to apply the API endpoint protection to\n\nExample: ` \"/example\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"Path","maxLength":1024,"x-displayname":"Request Path","x-ves-example":"/example","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"virtual_host_name":{"type":"string","description":" Virtual Host for which this API endpoint protection rule applied\n\nExample: ` \"ves-io-frontend\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Virtual Host Name","x-ves-example":"ves-io-frontend","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"rule_suggestionGetSuggestedAPIEndpointProtectionRuleRsp":{"type":"object","description":"Get suggested API endpoint protection rule for a given path","title":"GetSuggestedAPIEndpointProtectionRuleRsp","x-displayname":"Get Suggested API endpoint protection Rule Response","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedAPIEndpointProtectionRuleRsp","properties":{"found_existing_rule":{"$ref":"#/components/schemas/schemaEmpty"},"loadbalancer_type":{"$ref":"#/components/schemas/virtual_hostVirtualHostType"},"rule":{"$ref":"#/components/schemas/common_wafAPIEndpointProtectionRule"}}},"rule_suggestionGetSuggestedOasValidationRuleReq":{"type":"object","description":"Get suggested Open API specification validation for a given path","title":"GetSuggestedOasValidationRuleReq","x-displayname":"Get Suggested Open API specification validation Rule Request","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedOasValidationRuleReq","properties":{"api_groups":{"type":"array","description":" List of API Groups the API Endpoint is a member of.\n\nExample: ` [\"group-1\", \"group-2\"]`","title":"API Groups membership","items":{"type":"string"},"x-displayname":"API Groups membership"},"method":{"$ref":"#/components/schemas/schemaHttpMethod"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"path":{"type":"string","description":" Path to apply the Open API specification validation to\n\nExample: ` \"/example\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"Path","maxLength":1024,"x-displayname":"Request Path","x-ves-example":"/example","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"virtual_host_name":{"type":"string","description":" Virtual Host for which this Open API specification validation rule applied\n\nExample: ` \"ves-io-frontend\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Virtual Host Name","x-ves-example":"ves-io-frontend","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"rule_suggestionGetSuggestedOasValidationRuleRsp":{"type":"object","description":"Get suggested Open API specification validation for a given path","title":"GetSuggestedOasValidationRuleRsp","x-displayname":"Get Suggested Open API specification validation Rule Response","x-ves-oneof-field-api_validation_choice":"[\"all_endpoints_oas_validation\",\"custom_oas_validation\"]","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedOasValidationRuleRsp","properties":{"all_endpoints_oas_validation":{"$ref":"#/components/schemas/common_wafOpenApiValidationAllSpecEndpointsSettings"},"custom_oas_validation":{"$ref":"#/components/schemas/common_wafOpenApiValidationRule"},"found_existing_rule":{"$ref":"#/components/schemas/schemaEmpty"},"loadbalancer_type":{"$ref":"#/components/schemas/virtual_hostVirtualHostType"}}},"rule_suggestionGetSuggestedRateLimitRuleReq":{"type":"object","description":"Get suggested rate limit rule for a given path","title":"GetSuggestedRateLimitRuleReq","x-displayname":"Get Suggested Rate Limit Rule Request","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedRateLimitRuleReq","properties":{"method":{"$ref":"#/components/schemas/schemaHttpMethod"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"path":{"type":"string","description":" Path to apply the rate limit to\n\nExample: ` \"/example\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"Path","maxLength":1024,"x-displayname":"Request Path","x-ves-example":"/example","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"virtual_host_name":{"type":"string","description":" Virtual Host for which this rate limit rule applied\n\nExample: ` \"ves-io-frontend\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Virtual Host Name","x-ves-example":"ves-io-frontend","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"rule_suggestionGetSuggestedRateLimitRuleRsp":{"type":"object","description":"Get suggested rate limit rule for a given path","title":"GetSuggestedRateLimitRuleRsp","x-displayname":"Get Suggested Rate Limit Rule Response","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedRateLimitRuleRsp","properties":{"found_existing_rule":{"$ref":"#/components/schemas/schemaEmpty"},"loadbalancer_type":{"$ref":"#/components/schemas/virtual_hostVirtualHostType"},"rule":{"$ref":"#/components/schemas/common_wafApiEndpointRule"}}},"rule_suggestionGetSuggestedSensitiveDataRuleReq":{"type":"object","description":"Get suggested sensitive data rule for a given path","title":"GetSuggestedSensitiveDataRuleReq","x-displayname":"Get Suggested Sensitive Data Rule Request","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedSensitiveDataRuleReq","properties":{"method":{"$ref":"#/components/schemas/schemaHttpMethod"},"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"path":{"type":"string","description":" Path to apply the senstive data to\n\nExample: ` \"/example\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 1024\n  ves.io.schema.rules.string.templated_http_path: true\n","title":"Path","maxLength":1024,"x-displayname":"Request Path","x-ves-example":"/example","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"1024","ves.io.schema.rules.string.templated_http_path":"true"}},"virtual_host_name":{"type":"string","description":" Virtual Host for which this sensitive data rule applied\n\nExample: ` \"ves-io-frontend\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"Name","x-displayname":"Virtual Host Name","x-ves-example":"ves-io-frontend","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}}}},"rule_suggestionGetSuggestedSensitiveDataRuleRsp":{"type":"object","description":"Get suggested sensitive data rule for a given path","title":"GetSuggestedSensitiveDataRuleRsp","x-displayname":"Get Suggested Sensitive Data Rule Response","x-ves-proto-message":"ves.io.schema.api_sec.rule_suggestion.GetSuggestedSensitiveDataRuleRsp","properties":{"found_existing_rule":{"$ref":"#/components/schemas/schemaEmpty"},"loadbalancer_type":{"$ref":"#/components/schemas/virtual_hostVirtualHostType"},"rule":{"$ref":"#/components/schemas/http_loadbalancerSensitiveDataTypes"}}},"schemaEmpty":{"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"},"schemaHttpMethod":{"type":"string","description":"Specifies the HTTP method used to access a resource.\n\nAny HTTP Method","title":"HttpMethod","enum":["ANY","GET","HEAD","POST","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH","COPY"],"default":"ANY","x-displayname":"HTTP Method","x-ves-proto-enum":"ves.io.schema.HttpMethod"},"schemaLabelSelectorType":{"type":"object","description":"This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expresssions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nexpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n<selector-syntax>         ::= <requirement> | <requirement> \",\" <selector-syntax>\n<requirement>             ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]\n<set-based-restriction>   ::= \"\" | <inclusion-exclusion> <value-set>\n<inclusion-exclusion>     ::= <inclusion> | <exclusion>\n<exclusion>               ::= \"notin\"\n<inclusion>               ::= \"in\"\n<value-set>               ::= \"(\" <values> \")\"\n<values>                  ::= VALUE | VALUE \",\" <values>\n<exact-match-restriction> ::= [\"=\"|\"==\"|\"!=\"] VALUE","title":"LabelSelectorType","x-displayname":"Label Selector","x-ves-proto-message":"ves.io.schema.LabelSelectorType","properties":{"expressions":{"type":"array","description":" expressions contains the kubernetes style label expression for selections.\n\nExample: ` \"region in (us-west1, us-west2),tier in (staging)\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.items.string.k8s_label_selector: true\n  ves.io.schema.rules.repeated.items.string.max_len: 4096\n  ves.io.schema.rules.repeated.items.string.min_len: 1\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"expressions","maxItems":1,"items":{"type":"string","minLength":1,"maxLength":4096},"x-displayname":"Selector Expression","x-ves-example":"region in (us-west1, us-west2),tier in (staging)","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.items.string.k8s_label_selector":"true","ves.io.schema.rules.repeated.items.string.max_len":"4096","ves.io.schema.rules.repeated.items.string.min_len":"1","ves.io.schema.rules.repeated.max_items":"1"}}}},"schemaMessageMetaType":{"type":"object","description":"MessageMetaType is metadata (common attributes) of a message that only certain messages\nhave. This information is propagated to the metadata of a child object that gets created\nfrom the containing message during view processing.\nThe information in this type can be specified by user during create and replace APIs.","title":"MessageMetaType","x-displayname":"Message Metadata","x-ves-proto-message":"ves.io.schema.MessageMetaType","properties":{"description":{"type":"string","description":" Human readable description.\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"description","maxLength":256,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"name":{"type":"string","description":" This is the name of the message.\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  ves.io.schema.rules.string.min_len: 1\n  ves.io.schema.rules.string.ves_object_name: true\n","title":"name","minLength":1,"x-displayname":"Name","x-ves-example":"acmecorp-web","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"}}}},"schemaOpenApiValidationProperties":{"type":"string","description":"List of required properties to validate against the OpenAPI spec\n\nValidate that all query parameters are according to the OpenAPI specification\nValidate that all path parameters are according to the OpenAPI specification\nValidate that the content type of the request is according to the OpenAPI specification\nValidate that all cookies are according to the OpenAPI specification\nValidate that all HTTP headers are according to the OpenAPI specification\nValidate that the body is according to the OpenAPI specification\nValidate that the security schema is according to the OpenAPI specification\nValidate that the response code is according to the OpenAPI specification","title":"OpenApiValidationProperties","enum":["PROPERTY_QUERY_PARAMETERS","PROPERTY_PATH_PARAMETERS","PROPERTY_CONTENT_TYPE","PROPERTY_COOKIE_PARAMETERS","PROPERTY_HTTP_HEADERS","PROPERTY_HTTP_BODY","PROPERTY_SECURITY_SCHEMA","PROPERTY_RESPONSE_CODE"],"default":"PROPERTY_QUERY_PARAMETERS","x-displayname":"OpenAPI Validation Properties","x-ves-proto-enum":"ves.io.schema.OpenApiValidationProperties"},"schemapolicyHeaderMatcherType":{"type":"object","description":"A header matcher specifies the name of a single HTTP header and the criteria for the input request to match it. The input has a list of actual values for each\nheader name in the original HTTP request.\nA header matcher can check for one of the following:\n* Presence or absence of the header in the input\n* At least one of the values for the header in the input satisfies the MatcherType item","title":"HeaderMatcherType","x-displayname":"Header Matcher","x-ves-displayorder":"1,6,4","x-ves-oneof-field-match":"[\"check_not_present\",\"check_present\",\"item\"]","x-ves-proto-message":"ves.io.schema.policy.HeaderMatcherType","properties":{"check_not_present":{"$ref":"#/components/schemas/schemaEmpty"},"check_present":{"$ref":"#/components/schemas/schemaEmpty"},"invert_matcher":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert Header Matcher"},"item":{"$ref":"#/components/schemas/policyMatcherType"},"name":{"type":"string","description":" A case-insensitive HTTP header name.\n\nExample: ` \"Accept-Encoding\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.http_header_field: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"name","maxLength":256,"x-displayname":"Header Name","x-ves-example":"Accept-Encoding","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.http_header_field":"true","ves.io.schema.rules.string.max_bytes":"256"}}}},"schemapolicyIPThreatCategoryListType":{"type":"object","description":"List of ip threat categories","title":"IP Threat Category List Type","x-displayname":"IP Threat Category List Type","x-ves-proto-message":"ves.io.schema.policy.IPThreatCategoryListType","properties":{"ip_threat_categories":{"type":"array","description":" The IP threat categories is obtained from the list and is used to auto-generate equivalent label selection expressions\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 32\n  ves.io.schema.rules.repeated.unique: true\n","title":"IP Threat Categories","maxItems":32,"items":{"$ref":"#/components/schemas/policyIPThreatCategory"},"x-displayname":"List of IP Threat Categories to choose","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"32","ves.io.schema.rules.repeated.unique":"true"}}}},"schemapolicyQueryParameterMatcherType":{"type":"object","description":"A query parameter matcher specifies the name of a single query parameter and the criteria for the input request to match it. The input has a list of actual\nvalues for each query parameter name in the original HTTP request.\nA query parameter matcher can check for one of the following:\n* Presence or absence of the query parameter in the input\n* At least one of the values for the query parameter in the input satisfies the MatcherType item","title":"QueryParameterMatcherType","x-displayname":"Query Parameter Matcher","x-ves-displayorder":"1,6,4","x-ves-oneof-field-match":"[\"check_not_present\",\"check_present\",\"item\"]","x-ves-proto-message":"ves.io.schema.policy.QueryParameterMatcherType","properties":{"check_not_present":{"$ref":"#/components/schemas/schemaEmpty"},"check_present":{"$ref":"#/components/schemas/schemaEmpty"},"invert_matcher":{"type":"boolean","description":" Invert the match result.","title":"invert_matcher","format":"boolean","x-displayname":"Invert Query Parameter Matcher"},"item":{"$ref":"#/components/schemas/policyMatcherType"},"key":{"type":"string","description":" A case-sensitive HTTP query parameter name.\n\nExample: ` \"sourceid\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 256\n","title":"key","maxLength":256,"x-displayname":"Query Parameter Name","x-ves-example":"sourceid","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"256"}}}},"schemaviewsObjectRefType":{"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","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"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: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"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\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"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\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"virtual_hostVirtualHostType":{"type":"string","description":"VirtualHostType tells the type of virtual_host. Functionally, all types are same,\nthis is mainly used for categorizing metrics.\n\n - VIRTUAL_SERVICE: VirtualService\n\nVirtual Host used Virtual Service\n - HTTP_LOAD_BALANCER: HTTP LoadBalancer\n\nVirtual Host used as Load Balancer\n - API_GATEWAY: APIGateway\n\nVirtual Host used API Gateway\n - TCP_LOAD_BALANCER: TCP LoadBalancer\n\nVirtual Host used as Load Balancer\n - PROXY: Proxy\n\nVirtual Host used as Proxy\n - LOCAL_K8S_API_GATEWAY: LOCAL_K8S_API_GATEWAY\n\nInternal use only, used for k8s cluster api gateway on the site.\n - CDN_LOAD_BALANCER: CDN LoadBalancer\n\n Virtual Host used as Load Balancer\n - NGINX_SERVER: NGINX Server\n\nVirtual Host representing an NGINX Server block\n - BIGIP_VIRTUAL_SERVER: BIG-IP Virtual Server\n\nVirtual Host representing a BIG-IP Virtual Server\n - UDP_LOAD_BALANCER: UDP LoadBalancer\n\nVirtual Host used as Load Balancer\n - THIRD_PARTY_APPLICATION: THIRD PARTY Virtual Server\n\nVirtual Host representing a Third Party Application","title":"VirtualHostType","enum":["VIRTUAL_SERVICE","HTTP_LOAD_BALANCER","API_GATEWAY","TCP_LOAD_BALANCER","PROXY","CDN_LOAD_BALANCER","NGINX_SERVER","UDP_LOAD_BALANCER"],"default":"VIRTUAL_SERVICE","x-displayname":"Virtual Host Type","x-ves-proto-enum":"ves.io.schema.virtual_host.VirtualHostType"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0022.public.ves.io.schema.shape.device_id.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.shape.device_id","description":"Use this API to interact with Application Traffic Insights endpoitns\nAll calls allow a blob as the payload and return a blob as the return parameter","version":""},"paths":{"/api/shape/dip/namespaces/system/app_provision":{"post":{"summary":"Application Provision","description":"Provision an application for a tenant","operationId":"ves.io.schema.shape.device_id.CustomAPI.ApplicationProvision","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idApplicationProvisionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idApplicationProvisionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-applicationprovision"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.ApplicationProvision"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/application":{"delete":{"summary":"Delete Application","description":"Delete an application","operationId":"ves.io.schema.shape.device_id.CustomAPI.DeleteApplication","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idDeleteApplicationsResponse"}}}},"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":"app_id","description":"x-example: \" ``volt-testing_backenda949ef7c-eda1ab47`` \"\nTarget application ID to delete","in":"query","required":false,"x-displayname":"app_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-device_id-customapi-deleteapplication"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.DeleteApplication"},"post":{"summary":"Update Application","description":"Update an application's information","operationId":"ves.io.schema.shape.device_id.CustomAPI.UpdateApplication","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idUpdateApplicationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idUpdateApplicationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-updateapplication"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.UpdateApplication"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/applications":{"get":{"summary":"GetApplications","description":"Get Applications Information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetApplications","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetApplicationsResponse"}}}},"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getapplications"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetApplications"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/bot/asn":{"post":{"summary":"Get Bot Assessment by Top Asn","description":"Get Bot Top ASN Information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopAsn","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTopAsnResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTopAsnRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getbotassessmenttopasn"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopAsn"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/bot/transactions":{"post":{"summary":"Get Bot Assessment for Transactions","description":"Get Bot Transactions Information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTransactions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTransactionsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTransactionsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getbotassessmenttransactions"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTransactions"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/bot/urls":{"post":{"summary":"Get Bot Assessment by Top Urls","description":"Get Bot Top URL Information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopUrls","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTopUrlsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetBotAssessmentTopUrlsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getbotassessmenttopurls"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopUrls"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/age":{"post":{"summary":"Get Devices By Age","description":"Get device age information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAge","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByAgeResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByAgeRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbyage"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAge"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/applications":{"post":{"summary":"Get Information By Applications","description":"Get device applications information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByApplications","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByApplicationsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByApplicationsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbyapplications"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByApplications"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/asn":{"post":{"summary":"Get Devices By Asn","description":"Get devices asn information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAsn","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByAsnResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByAsnRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbyasn"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAsn"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/country":{"post":{"summary":"Get Devices By Country","description":"Get devices country information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByCountry","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByCountryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByCountryRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbycountry"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByCountry"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/session":{"post":{"summary":"Get Devices By Session","description":"Get devices session information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardBySession","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardBySessionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardBySessionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbysession"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardBySession"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/ua":{"post":{"summary":"Get Devices By User-Agent","description":"Get devices user agent information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByUa","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByUaResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardByUaRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboardbyua"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardByUa"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/dashboard/unique":{"post":{"summary":"Get Devices by Unique Access","description":"Get devices unique access information","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardUniqueAccess","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardUniqueAccessResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetDashboardUniqueAccessRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getdashboarduniqueaccess"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetDashboardUniqueAccess"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/enable":{"post":{"summary":"Enable Application Traffic Insights","description":"Enable Application Traffic Insights feature for the tenant","operationId":"ves.io.schema.shape.device_id.CustomAPI.Enable","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idEnableResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idEnableRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-enable"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.Enable"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/provision/regions":{"get":{"summary":"Get avaialable Regions for Application Traffic Insights","description":"Returns Application Traffic Insights regions information for the tenant","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetRegions","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetRegionsResponse"}}}},"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getregions"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetRegions"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/status":{"get":{"summary":"Get Application Traffic Insights Status","description":"Returns Application Traffic Insights information for the tenant","operationId":"ves.io.schema.shape.device_id.CustomAPI.GetStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idGetStatusResponse"}}}},"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"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-getstatus"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.GetStatus"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/shape/dip/namespaces/system/validate/src_tag_injection":{"post":{"summary":"Validate JS Injection","description":"Validate js src tag injection in the target url","operationId":"ves.io.schema.shape.device_id.CustomAPI.ValidateSrcTagInjection","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idValidateSrcTagInjectionResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_idValidateSrcTagInjectionRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-shape-device_id-customapi-validatesrctaginjection"},"x-ves-proto-rpc":"ves.io.schema.shape.device_id.CustomAPI.ValidateSrcTagInjection"},"x-displayname":"Application Traffic Insights","x-ves-proto-service":"ves.io.schema.shape.device_id.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Application Traffic Insights","x-ves-proto-package":"ves.io.schema.shape.device_id","components":{"schemas":{"device_idApplicationProvisionRequest":{"type":"object","description":"Any payload to be passed on the Application Provision API","title":"ApplicationProvisionRequest","x-displayname":"Application Provision Request","x-ves-proto-message":"ves.io.schema.shape.device_id.ApplicationProvisionRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-id-management/blob/master/deployment/openapi/openapi-prod.yaml\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idApplicationProvisionResponse":{"type":"object","description":"Any payload to be return by Application Provision API","title":"ApplicationProvisionResponse","x-displayname":"Application Provision Response","x-ves-proto-message":"ves.io.schema.shape.device_id.ApplicationProvisionResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idDeleteApplicationsResponse":{"type":"object","description":"Any payload to be returned by Delete Applications API","title":"DeleteApplicationsResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.DeleteApplicationsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-id-management/blob/master/deployment/openapi/openapi-prod.yaml\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idEnableRequest":{"type":"object","description":"Any payload to be passed on the Provision API","title":"EnableRequest","x-displayname":"Enable Application Traffic Insights Request","x-ves-proto-message":"ves.io.schema.shape.device_id.EnableRequest","properties":{"region":{"type":"string","description":" Target webpage to check src tag injection\n\nExample: ` \" ``https://www.example.com`` \"`","title":"Region","x-displayname":"region","x-ves-example":" ``https://www.example.com`` "}}},"device_idEnableResponse":{"type":"object","description":"Any payload to be return by Provision API","title":"EnableResponse","x-displayname":"Enable Application Traffic Insights Response","x-ves-proto-message":"ves.io.schema.shape.device_id.EnableResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetApplicationsResponse":{"type":"object","description":"Any payload to be returned by Applications API","title":"GetApplicationsResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetApplicationsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-id-management/blob/master/deployment/openapi/openapi-prod.yaml\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idGetBotAssessmentTopAsnRequest":{"type":"object","description":"Any payload to be passed to the Bot Top ASN API","title":"GetBotAssessmentTopAsnRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTopAsnRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetBotAssessmentTopAsnResponse":{"type":"object","description":"Any payload to be returned by Bot Top ASN API","title":"GetBotAssessmentTopAsnResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTopAsnResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idGetBotAssessmentTopUrlsRequest":{"type":"object","description":"Any payload to be passed to the Bot Top URLs API","title":"GetBotAssessmentTopUrlsRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTopUrlsRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetBotAssessmentTopUrlsResponse":{"type":"object","description":"Any payload to be returned by Bot Top URLs API","title":"GetBotAssessmentTopUrlsResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTopUrlsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idGetBotAssessmentTransactionsRequest":{"type":"object","description":"Any payload to be passed to the Bot Transactions API","title":"GetBotAssessmentTransactionsRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTransactionsRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetBotAssessmentTransactionsResponse":{"type":"object","description":"Any payload to be returned by Bot Transactions API","title":"GetBotAssessmentTransactionsResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetBotAssessmentTransactionsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idGetDashboardByAgeRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Age API","title":"GetDashboardByAgeRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByAgeRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardByAgeResponse":{"type":"object","description":"Any payload to be return by Dashboard Age API","title":"GetDashboardByAgeResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByAgeResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardByApplicationsRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Application API","title":"GetDashboardByApplicationsRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByApplicationsRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardByApplicationsResponse":{"type":"object","description":"Any payload to be return by Dashboard Application API","title":"GetDashboardByApplicationsResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByApplicationsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardByAsnRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Asn API","title":"GetDashboardByAsnRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByAsnRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardByAsnResponse":{"type":"object","description":"Any payload to be return by Dashboard Asn API","title":"GetDashboardByAsnRequest","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByAsnResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardByCountryRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Country API","title":"GetDashboardByCountryRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByCountryRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardByCountryResponse":{"type":"object","description":"Any payload to be return by Dashboard Country API","title":"GetDashboardByAsnRequest","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByCountryResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardBySessionRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Session API","title":"GetDashboardBySessionRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardBySessionRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardBySessionResponse":{"type":"object","description":"Any payload to be return by Dashboard Session API","title":"GetDashboardBySessionResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardBySessionResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardByUaRequest":{"type":"object","description":"Any payload to be passed on the Dashboard UA API","title":"GetDashboardByUaRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByUaRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardByUaResponse":{"type":"object","description":"Any payload to be return by Dashboard UA API","title":"GetDashboardByUaResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardByUaResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetDashboardUniqueAccessRequest":{"type":"object","description":"Any payload to be passed on the Dashboard Unique API","title":"GetDashboardUniqueAccessRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardUniqueAccessRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported.\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idGetDashboardUniqueAccessResponse":{"type":"object","description":"Any payload to be return by Dashboard Unique API","title":"GetDashboardByUaResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.GetDashboardUniqueAccessResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetRegionsResponse":{"type":"object","description":"Any payload to be return by Get Regions API","title":"GetRegionsResponse","x-displayname":"Application Traffic Insights Regions Response","x-ves-proto-message":"ves.io.schema.shape.device_id.GetRegionsResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idGetStatusResponse":{"type":"object","description":"Any payload to be return by Get Provision API","title":"GetStatusResponse","x-displayname":"Application Traffic Insights Status Response","x-ves-proto-message":"ves.io.schema.shape.device_id.GetStatusResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"},"status":{"type":"string","description":" HTTP status as reported by the backend\n\nExample: ` \"200`","title":"Status","format":"int64","x-displayname":"Status"}}},"device_idUpdateApplicationRequest":{"type":"object","description":"Any payload to be passed to the Update Application API","title":"UpdateApplicationRequest","x-displayname":"Input ","x-ves-proto-message":"ves.io.schema.shape.device_id.UpdateApplicationRequest","properties":{"body":{"type":"string","description":" Data to be send as the body of request. Note that multipart/formdata is not supported. Body described in https://git.shpsec.com/shape-recognize/device-id-management/blob/master/deployment/openapi/openapi-prod.yaml\n\nExample: ` \"cGF5bG9hZAo=\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cGF5bG9hZAo="}}},"device_idUpdateApplicationResponse":{"type":"object","description":"Any payload to be returned by Update Application API","title":"UpdateApplicationResponse","x-displayname":"Output ","x-ves-proto-message":"ves.io.schema.shape.device_id.UpdateApplicationResponse","properties":{"body":{"type":"string","description":" Data received from the downstream server. Body is JSON as described in openapi: https://git.shpsec.com/shape-recognize/device-id-management/blob/master/deployment/openapi/openapi-prod.yaml\n\nExample: ` \"cmVwbHkK\"`","title":"Body","format":"byte","x-displayname":"Body","x-ves-example":"cmVwbHkK"}}},"device_idValidateSrcTagInjectionRequest":{"type":"object","description":"Request to verify shape Application Traffic Insights src tag injection","title":"ValidateSrcTagInjectionRequest","x-displayname":"Validate SrcTagInjection Request","x-ves-proto-message":"ves.io.schema.shape.device_id.ValidateSrcTagInjectionRequest","properties":{"src":{"type":"string","description":" Content to be present in customer webpage's source\n\nExample: ` \" ``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aaUvDJvRbA-65bd8ebd.js`` \"`","title":"Src","x-displayname":"src","x-ves-example":" ``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aaUvDJvRbA-65bd8ebd.js`` "},"url":{"type":"string","description":" Target webpage to check src tag injection\n\nExample: ` \" ``https://www.example.com`` \"`","title":"Url","x-displayname":"url","x-ves-example":" ``https://www.example.com`` "}}},"device_idValidateSrcTagInjectionResponse":{"type":"object","description":"Response to indicate whether customer webpage has\ncustom script tag to track devices been injected or not","title":"ValidateSrcTagInjectionResponse","x-displayname":"SrcTagInjection Response","x-ves-proto-message":"ves.io.schema.shape.device_id.ValidateSrcTagInjectionResponse","properties":{"message":{"type":"string","description":" Status about src script tag injected in customer's webpage\n\nExample: ` \"injected\"`","title":"Message","x-displayname":"message","x-ves-example":"injected"}}}}}}