{ "openapi": "3.0.3", "info": { "title": "Shape", "description": "Bot infrastructure policies with deployment tracking and subscription management. SafeAP protection against credential stuffing and account takeover. Mobile application shielding through SDK integration with OS-specific configurations. Real-time threat intelligence updates and automated response actions based on risk scoring and traffic patterns.", "version": "8.0.2", "contact": { "name": "F5 Distributed Cloud", "url": "https://docs.cloud.f5.com" }, "license": { "name": "Proprietary", "url": "https://www.f5.com/company/policies/eula" }, "x-f5xc-description-long": "Bot infrastructure policies with deployment tracking and subscription management. SafeAP protection against credential stuffing and account takeover. Mobile application shielding through SDK integration with OS-specific configurations. Real-time threat intelligence updates and automated response actions based on risk scoring and traffic patterns.", "x-f5xc-summary": "Threat recognition with behavioral analysis and device fingerprinting. Mobile SDK integration for application shielding.", "x-f5xc-cli-domain": "shape", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/advanced-security/shape-security", "description": "F5 XC Documentation - Shape Security" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Invalid request body", "resolution": "Validate JSON structure and required fields before submission", "prevention": "Use schema validation from OpenAPI spec" }, { "code": 401, "message": "Authentication failed", "resolution": "Verify API token is valid and not expired", "prevention": "Use environment variables for token management" }, { "code": 403, "message": "Permission denied", "resolution": "Check user role and namespace permissions", "prevention": "Verify RBAC policies before operations" }, { "code": 404, "message": "Resource not found", "resolution": "Verify resource name and namespace exist", "prevention": "List resources before attempting operations" }, { "code": 409, "message": "Resource already exists", "resolution": "Use unique name or delete existing resource", "prevention": "Check existence before creation" }, { "code": 429, "message": "Rate limit exceeded", "resolution": "Implement exponential backoff and retry logic", "prevention": "Batch operations and add delays between requests" } ], "security_notes": [ "Always use HTTPS for all API communications", "Store API tokens securely, never in source code", "Rotate API tokens regularly following security policies" ], "performance_tips": [ "Use pagination for large result sets", "Batch related operations when possible", "Cache read-only responses appropriately" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "data-intelligence" }, { "name": "mobile" }, { "name": "object_store" }, { "name": "shape" } ], "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idApplicationProvisionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.ApplicationProvision", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "App-provision resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "app-provision" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "app-provision" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "app_id", "description": "Target application ID to DELETE.", "in": "query", "required": false, "x-displayname": "App_id", "schema": { "type": "string" }, "x-f5xc-example": "``volt-testing_backenda949ef7c-eda1ab47``" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.DeleteApplication", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "application", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "application", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idUpdateApplicationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.UpdateApplication", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Application resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "application" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "application" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetApplications", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetBotAssessmentTopAsnRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopAsn", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asn resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asn" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetBotAssessmentTransactionsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTransactions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetBotAssessmentTopUrlsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetBotAssessmentTopUrls", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Url resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "url" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "url" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardByAgeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAge", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Age resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "age" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "age" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardByApplicationsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardByApplications", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Application resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "application" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "application" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardByAsnRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardByAsn", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asn resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asn" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardByCountryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardByCountry", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Country resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "country" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "country" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardBySessionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardBySession", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Session resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "session" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "session" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardByUaRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardByUa", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idGetDashboardUniqueAccessRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetDashboardUniqueAccess", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unique resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unique" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unique" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idEnableRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.Enable", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Enable resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "enable" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "enable" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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 available 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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetRegions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.GetStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "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": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_idValidateSrcTagInjectionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.device_id.CustomAPI.ValidateSrcTagInjection", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Src-tag-injection resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "src-tag-injection" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "src-tag-injection" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "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/alerts/namespaces/{metadata.namespace}/alert_gen_policys": { "post": { "summary": "Create Alert Generation Policy.", "description": "Create Alert Generation Policy.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Alert-gen-policy resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "alert-gen-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "alert-gen-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alert Generation Policy.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_gen_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{metadata.namespace}/alert_gen_policys/{metadata.name}": { "put": { "summary": "Replace Alert Generation Policy.", "description": "Replaces the content of an Alert Generation Policy object.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "alert-gen-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "alert-gen-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alert Generation Policy.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_gen_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_gen_policy/{name}/status": { "post": { "summary": "Clone Alert Template.", "description": "Clone the BRM Alert Template.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.CustomAPI.ChangeStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyChangeAlertStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nThe namespace in which the the alert is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" } }, { "name": "name", "description": "Name\n\nThe name of the alert.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyChangeAlertStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.CustomAPI.ChangeStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "statu" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alert Generation Policy.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_gen_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys": { "get": { "summary": "List BRM Alert Generation Policy.", "description": "List the set of alert_gen_policy in a namespace.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of alert_gen_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alert Generation Policy.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_gen_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_gen_policys/{name}": { "get": { "summary": "GET Alert Generation Policy.", "description": "GET Alert Generation Policy.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE BRM Alert Generation Policy.", "description": "DELETE the specified alert_gen_policy.", "operationId": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_gen_policyDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_gen_policy.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "alert-gen-policy", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "alert-gen-policy", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alert Generation Policy.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_gen_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{metadata.namespace}/alert_templates": { "post": { "summary": "Create Domain to protect.", "description": "Create Domain to protect.", "operationId": "ves.io.schema.shape.brmalerts.alert_template.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_template.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Alert-template resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "alert-template" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "alert-template" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alerts Alert Template.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_template.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_templates": { "get": { "summary": "List BRM Alerts Alert Template.", "description": "List the set of alert_template in a namespace.", "operationId": "ves.io.schema.shape.brmalerts.alert_template.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of alert_template.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_template.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alerts Alert Template.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_template.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_templates/{name}": { "get": { "summary": "GET Protected Domain.", "description": "GET Domain to protect.", "operationId": "ves.io.schema.shape.brmalerts.alert_template.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_template.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE BRM Alerts Alert Template.", "description": "DELETE the specified alert_template.", "operationId": "ves.io.schema.shape.brmalerts.alert_template.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_template.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "alert-template", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "alert-template", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alerts Alert Template.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_template.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/alerts/namespaces/{namespace}/alert_templates/{name}/clone": { "post": { "summary": "Clone Alert Template.", "description": "Clone the BRM Alert Template.", "operationId": "ves.io.schema.shape.brmalerts.alert_template.CustomAPI.Clone", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateCloneTemplateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nThe namespace in which the the alert template is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" } }, { "name": "name", "description": "Name\n\nThe name of the alert template to be cloned.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_templateCloneTemplateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.brmalerts.alert_template.CustomAPI.Clone", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Clone resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "clone" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "clone" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BRM Alerts Alert Template.", "x-ves-proto-service": "ves.io.schema.shape.brmalerts.alert_template.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules": { "post": { "summary": "Deploy Bot Detection Rules.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DeployBotDetectionRules", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleDeployBotDetectionRulesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleDeployBotDetectionRulesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DeployBotDetectionRules", "tags": [ "shape" ], "description": "DeployBotDetectionRules bot_detection_rules.", "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Bot-detection-rule resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "bot-detection-rule" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "bot-detection-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments": { "get": { "summary": "GET list of bot detection rule deployments.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeployments", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetBotDetectionRulesDeploymentsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "rules_deployment_status", "description": "The deployments will be filtered by the deployment status values provided. This field is optional. If no deployment status values are provided, all the deployments will be fetched\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch.", "in": "query", "required": false, "x-displayname": "Partially Initiated.", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DRAFT", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DEPLOYED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_FAILED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DISCARDED_DRAFT", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATION_FAILED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED" ] } }, "x-f5xc-example": "[BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED, BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED]" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeployments", "tags": [ "shape" ], "description": "GetBotDetectionRulesDeployments deployments.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/deployments/{deployment_id}": { "get": { "summary": "GET details of a bot detection rule deployment.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeploymentDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetBotDetectionRulesDeploymentDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "deployment_id", "description": "DeploymentID\n\nx-required\nUnique identifier for a bot detection rule(s) deployment.", "in": "path", "required": true, "x-displayname": "Deployment ID.", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDeploymentDetails", "tags": [ "shape" ], "description": "GetBotDetectionRulesDeploymentDetails deployments.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.deployment_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.deployment_id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/draft": { "get": { "summary": "GET bot detection rules which are in draft state.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDraft", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetBotDetectionRulesDraftResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesDraft", "tags": [ "shape" ], "description": "GetBotDetectionRulesDraft draft.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "Discard draft.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DiscardDraft", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ioschemaEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.DiscardDraft", "tags": [ "shape" ], "description": "DiscardDraft draft.", "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "draft", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "draft", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Save draft.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.SaveDraft", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleSaveDraftResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleDeployBotDetectionRulesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.SaveDraft", "tags": [ "shape" ], "description": "SaveDraft draft.", "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Draft resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "draft" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "draft" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/summary": { "get": { "summary": "GET summary of bot detection rules.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetBotDetectionRulesSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRulesSummary", "tags": [ "shape" ], "description": "GetBotDetectionRulesSummary summary.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_detection_rules": { "get": { "summary": "List Bot Detection Rule.", "description": "List the set of bot_detection_rule in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of bot_detection_rule.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_detection_rules/{id}/history": { "get": { "summary": "GET the change history for a bot detection rule.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRuleChangeHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetBotDetectionRuleChangeHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "id", "description": "ID\nx-required\nRule ID is the unique identifier for a Rule.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "Rule_CB_DUBEXLDQKV" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI.GetBotDetectionRuleChangeHistory", "tags": [ "shape" ], "description": "GetBotDetectionRuleChangeHistory history.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_detection_rules/{name}": { "get": { "summary": "GET Bot Detection Rule.", "description": "GET Bot Detection Rule.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_ruleGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Rule.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_detection_updates": { "get": { "summary": "GET bot detection updates.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.GetBotDetectionUpdates", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_updateGetBotDetectionUpdatesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.GetBotDetectionUpdates", "tags": [ "shape" ], "description": "GetBotDetectionUpdates bot_detection_updates.", "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Update.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_detection_updates/download_release_notes": { "get": { "summary": "Download BotDetection Updates Release Notes.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.DownloadBotDetectionUpdatesReleaseNotes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_detection_updateDownloadBotDetectionUpdatesReleaseNotesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "deployment_id", "description": "X-required\nUnique identifier for a deployment.", "in": "query", "required": false, "x-displayname": "Deployment ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8201a7f4be46" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI.DownloadBotDetectionUpdatesReleaseNotes", "tags": [ "shape" ], "description": "DownloadBotDetectionUpdatesReleaseNotes download_release_notes.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Detection Update.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_endpoint_policies": { "get": { "summary": "List All Bot Endpoint Policies And Versions.", "description": "GET all bot endpoint policies and versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPoliciesAndVersionsList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyGetPoliciesAndVersionsListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "deployment_mode", "description": "Deployment mode is used to scope the query\n\nBy default, the mode will be Reverse Proxy\nYou need to submit an XC support ticket to request for API mode.", "in": "query", "required": false, "x-displayname": "API", "schema": { "type": "string", "enum": [ "REVERSE_PROXY", "API_MODE" ], "default": "REVERSE_PROXY" }, "x-f5xc-example": "Reverse Proxy" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPoliciesAndVersionsList", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_endpoint_policys/{name}": { "put": { "summary": "Custom Replace Bot Endpoint Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.CustomReplace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyCustomReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyCustomReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.CustomReplace", "tags": [ "shape" ], "description": "CustomReplace bot_endpoint_policys.", "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-endpoint-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-endpoint-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/bot_endpoint_policys/{metadata.name}": { "put": { "summary": "Replace Bot Endpoint Policy.", "description": "Replace Bot Endpoint Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-endpoint-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-endpoint-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policy/{name}/versions": { "get": { "summary": "Bot Endpoint Policy Versions.", "description": "GET bot endpoint policy versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPolicyVersions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyPolicyVersionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Policy name\nPolicy name.", "in": "path", "required": true, "x-displayname": "Policy Name.", "schema": { "type": "string" }, "x-f5xc-example": "web_policy" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetEndpointPolicyVersions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policy/{name}/versions/{number}/mobile_base_config/{os}": { "get": { "summary": "GET Mobile Base Configuration File.", "description": "GET base config file for a mobile policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetMobileBaseConfigFile", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyGetMobileBaseConfigFileResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "mobile-policy" }, { "name": "number", "description": "Number\nVersion of the policy.", "in": "path", "required": true, "x-displayname": "Version number.", "schema": { "type": "string" }, "x-f5xc-example": "v1" }, { "name": "os", "description": "OS\nOS of the mobile platform.", "in": "path", "required": true, "x-displayname": "OS", "schema": { "type": "string", "enum": [ "MOBILE_OS_UNDEFINED", "ANDROID", "IOS" ] }, "x-f5xc-example": "android" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetMobileBaseConfigFile", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.number", "path.os" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.number", "path.os" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys": { "get": { "summary": "List Bot Endpoint Policy.", "description": "List the set of bot_endpoint_policy in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of bot_endpoint_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys/{name}": { "get": { "summary": "GET Bot Endpoint Policy.", "description": "GET Bot Endpoint Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_endpoint_policys/{name}/versions/{number}": { "get": { "summary": "GET Content.", "description": "GET the content of the specific policy version.", "operationId": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetContent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_endpoint_policyGetContentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "number", "description": "Number\nVersion of the policy.", "in": "path", "required": true, "x-displayname": "Version number.", "schema": { "type": "string" }, "x-f5xc-example": "v1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI.GetContent", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.number" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.number" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/bot_infrastructures": { "post": { "summary": "Create Bot Infrastructure.", "description": "Create Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Bot-infrastructure resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "bot-infrastructure" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "bot-infrastructure" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/bot_infrastructures/{metadata.name}": { "put": { "summary": "Replace Bot Infrastructure.", "description": "Replace Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-infrastructure" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-infrastructure" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures": { "get": { "summary": "List Bot Infrastructure.", "description": "List the set of bot_infrastructure in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of bot_infrastructure.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}": { "get": { "summary": "GET Bot Infrastructure.", "description": "GET Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/apply-certificate": { "put": { "summary": "Apply Certificate.", "description": "Apply custom certificate on Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.ApplyCertificate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureCertificateOperationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Bot Infrastructure Name\nx-required\nBot Infrastructure Name.", "in": "path", "required": true, "x-displayname": "Bot Infrastructure Name.", "schema": { "type": "string" }, "x-f5xc-example": "cluster_1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureApplyCertificateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.ApplyCertificate", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "apply-certificate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "apply-certificate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/deployment_history": { "get": { "summary": "Deployment History.", "description": "GET deployment history.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeploymentHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureDeploymentHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nx-required.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeploymentHistory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/deployment_status": { "get": { "summary": "Deployment Status.", "description": "GET deployment status.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeploymentStatusOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureDeploymentStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Name Space\nx-required\nName Space.", "in": "path", "required": true, "x-displayname": "Name Space.", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nx-required\nName Space.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeploymentStatusOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/policies": { "post": { "summary": "Deploy Policies to Bot Infra.", "description": "Deploy Policies to Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeployPoliciesToBotInfra", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureDeployPoliciesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Bot Infra Name\nBot Infra Name.", "in": "path", "required": true, "x-displayname": "Bot Infrastructure Name.", "schema": { "type": "string" }, "x-f5xc-example": "cluster_1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureDeployPoliciesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.DeployPoliciesToBotInfra", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Policie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "policie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "policie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_infrastructures/{name}/rollback-certificate-to-default": { "put": { "summary": "Rollback Certificate To Default.", "description": "Rollback to default certificate on Bot Infrastructure.", "operationId": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.RollbackCertificateToDefault", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureCertificateOperationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Bot Infrastructure Name\nx-required\nBot Infrastructure Name.", "in": "path", "required": true, "x-displayname": "Bot Infrastructure Name.", "schema": { "type": "string" }, "x-f5xc-example": "cluster_1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_infrastructureRollbackCertificateToDefaultRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI.RollbackCertificateToDefault", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "rollback-certificate-to-default" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "rollback-certificate-to-default" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Infrastructure.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_infrastructure.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/ti_packages": { "get": { "summary": "List bot threat intelligence packages.", "operationId": "ves.io.schema.shape.bot_defense.threat_intelligence.ti_package.CustomAPI.ListBotThreatIntelligencePackages", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ti_packageListBotThreatIntelligencePackagesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.threat_intelligence.ti_package.CustomAPI.ListBotThreatIntelligencePackages", "tags": [ "shape" ], "description": "ListBotThreatIntelligencePackages ti_packages.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot Threat Intelligence.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.threat_intelligence.ti_package.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_allowlist_policies": { "get": { "summary": "List All Bot Allowlist Policies And Versions.", "description": "GET all bot allowlist policies and versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetAllowlistPoliciesAndVersionsList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyGetPoliciesAndVersionsListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetAllowlistPoliciesAndVersionsList", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_allowlist_policys/{name}": { "put": { "summary": "Custom Replace Bot allowlist Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.CustomReplace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyCustomReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyCustomReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.CustomReplace", "tags": [ "shape" ], "description": "CustomReplace bot_allowlist_policys.", "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-allowlist-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-allowlist-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/bot_allowlist_policys/{metadata.name}": { "put": { "summary": "Replace Bot allowlist Policy.", "description": "Replace Bot allowlist Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-allowlist-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-allowlist-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policy/{name}/versions": { "get": { "summary": "Bot Allowlist Policy Versions.", "description": "GET bot allowlist policy versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetAllowlistPolicyVersions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyPolicyVersionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Policy name\nPolicy name.", "in": "path", "required": true, "x-displayname": "Policy Name.", "schema": { "type": "string" }, "x-f5xc-example": "web_policy" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetAllowlistPolicyVersions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys": { "get": { "summary": "List Bot allowlist Policy.", "description": "List the set of bot_allowlist_policy in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of bot_allowlist_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys/{name}": { "get": { "summary": "GET Bot allowlist Policy.", "description": "GET Bot allowlist Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_allowlist_policys/{name}/versions/{number}": { "get": { "summary": "GET Content.", "description": "GET the content of the specific policy version.", "operationId": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetContent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_allowlist_policyGetContentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "number", "description": "Number\nVersion of the policy.", "in": "path", "required": true, "x-displayname": "Version number.", "schema": { "type": "string" }, "x-f5xc-example": "v1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI.GetContent", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.number" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.number" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot allowlist Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_network_policies": { "get": { "summary": "List All Bot Network Policies And Versions.", "description": "GET all bot network policies and versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetNetworkPoliciesAndVersionsList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyGetPoliciesAndVersionsListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetNetworkPoliciesAndVersionsList", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/custom/namespaces/{namespace}/bot_network_policys/{name}": { "put": { "summary": "Custom Replace Bot network Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.CustomReplace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyCustomReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyCustomReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.CustomReplace", "tags": [ "shape" ], "description": "CustomReplace bot_network_policys.", "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-network-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-network-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/bot_network_policys/{metadata.name}": { "put": { "summary": "Replace Bot network Policy.", "description": "Replace Bot network Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "bot-network-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "bot-network-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_network_policy/{name}/versions": { "get": { "summary": "Bot Network Policy Versions.", "description": "GET bot network policy versions.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetNetworkPolicyVersions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyPolicyVersionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Policy name\nPolicy name.", "in": "path", "required": true, "x-displayname": "Policy Name.", "schema": { "type": "string" }, "x-f5xc-example": "web_policy" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetNetworkPolicyVersions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_network_policys": { "get": { "summary": "List Bot network Policy.", "description": "List the set of bot_network_policy in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of bot_network_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_network_policys/{name}": { "get": { "summary": "GET Bot network Policy.", "description": "GET Bot network Policy.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Configuration policy for resource behavior", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/bot_network_policys/{name}/versions/{number}": { "get": { "summary": "GET Content.", "description": "GET the content of the specific policy version.", "operationId": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetContent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bot_network_policyGetContentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "name", "description": "Name\nName of the policy.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "number", "description": "Number\nVersion of the policy.", "in": "path", "required": true, "x-displayname": "Version number.", "schema": { "type": "string" }, "x-f5xc-example": "v1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI.GetContent", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.number" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.number" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Bot network Policy.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/system/init": { "post": { "summary": "Enable Client-Side Defense.", "description": "Enable Client-Side Defense feature for the tenant.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.Init", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseInitResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseInitRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-deprecated": "Use Subscribe API", "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.Init", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Init resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "init" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "init" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/detectedDomains": { "post": { "summary": "List All Detected Domains.", "description": "List detected domains.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListDetectedDomains", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListDetectedDomainsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListDetectedDomainsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListDetectedDomains", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Detecteddomain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "detectedDomain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "detectedDomain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/detected_domains": { "get": { "summary": "GET Detected Domains.", "description": "GET the detected domains data for the tenant.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDetectedDomains", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetDetectedDomainsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "duration", "description": "Length in Days to fetch domain.", "in": "query", "required": false, "x-displayname": "Duration days.", "schema": { "type": "string" }, "x-f5xc-example": "15" }, { "name": "locations", "description": "List of locations if backend needs to filter with locations passed.", "in": "query", "required": false, "x-displayname": "Locations", "schema": { "type": "string" }, "x-f5xc-example": "location1.com,location2.com" }, { "name": "risk", "description": "GET the list of high risk domains, all domains is by default.", "in": "query", "required": false, "x-displayname": "Risk", "schema": { "type": "string" }, "x-f5xc-example": "high" }, { "name": "start_time", "description": "Format: unix epoch timestamp in seconds\nfetch domains with timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "Format: unix epoch timestamp in seconds\nfetch domains with timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" }, { "name": "page_size", "description": "Maximum number of domains per page.", "in": "query", "required": false, "x-displayname": "Page Size", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "500" }, { "name": "page_number", "description": "One-indexed page number (starts from 1), optional when page_token is specified.", "in": "query", "required": false, "x-displayname": "Page Number.", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "1" }, { "name": "page_token", "description": "Opaque token from previous response for pagination.", "in": "query", "required": false, "x-displayname": "Page Token.", "schema": { "type": "string" }, "x-f5xc-example": "cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDetectedDomains", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/domain_details": { "get": { "summary": "GET Domain Details.", "description": "GET the details of the domain provided.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDomainDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetDomainDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Name of the domain to GET the details.", "in": "query", "required": false, "x-displayname": "Domain Name.", "schema": { "type": "string" }, "x-f5xc-example": "domain.com", "x-required": true } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDomainDetails", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/domains": { "delete": { "summary": "Bulk DELETE Domains.", "description": "DELETE multiple domains from allow list or mitigated list.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.BulkDeleteDomains", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseBulkDeleteDomainsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseBulkDeleteDomainsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.BulkDeleteDomains", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "domain", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "domain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/formFields": { "get": { "summary": "List All Form Fields with GET method.", "description": "List form fields for all the scripts depending on start time and end time with GET method.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsGet", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListFormFieldsGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsGet", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "List All Form Fields.", "description": "List form fields for all the scripts depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFields", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListFormFieldsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListFormFieldsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFields", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Formfield resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "formField" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "formField" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/formFields/analysis": { "post": { "summary": "Update FormField Analysis.", "description": "Mark / unmark field sensitivity by customer.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateFieldAnalysis", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateFieldAnalysisResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateFieldAnalysisRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateFieldAnalysis", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Analysi resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "analysi" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "analysi" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/formFields/{id}": { "get": { "summary": "GET Form Field.", "description": "GET form field for the name of the form field.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetFormField", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetFormFieldResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nID of the form field.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "f-ssabcde" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetFormField", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/js_configuration": { "get": { "summary": "GET JS Injection Configuration.", "description": "GET JS Injection Configuration for this tenant.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetJsInjectionConfiguration", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetJsInjectionConfigurationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "name", "description": "Format we want the script to be returned in.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "scriptTag" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetJsInjectionConfiguration", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/reports": { "post": { "summary": "Create Report.", "description": "Create a report configuration.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.CreateReport", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseCreateReportResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseCreateReportRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.CreateReport", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Report resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "report" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "report" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/reports-history": { "get": { "summary": "List Reports With History.", "description": "List report configurations with their generation job history.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListReportsWithHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListReportsWithHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListReportsWithHistory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/reports/metadata/{job_id}/download": { "get": { "summary": "GET Report Download URL.", "description": "GET a presigned URL to download a report artifact.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDownloadReportPresignedUrl", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetDownloadReportPresignedUrlResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "job_id", "description": "Job_id\nx-required\nReport generation job identifier.", "in": "path", "required": true, "x-displayname": "Job ID", "schema": { "type": "string" }, "x-f5xc-example": "j-1234567" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetDownloadReportPresignedUrl", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.job_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.job_id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/script/justification/{justification_id}": { "delete": { "summary": "DELETE Script Justification.", "description": "DELETE the specified script justification.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.DeleteScriptJustification", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseDeleteScriptJustificationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "justification_id", "description": "Justification_id\nID of the justification.", "in": "path", "required": true, "x-displayname": "Justification ID.", "schema": { "type": "string" }, "x-f5xc-example": "j-1234567" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.DeleteScriptJustification", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.justification_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "justification", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.justification_id", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "justification", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts": { "get": { "summary": "List Scripts.", "description": "List all the scripts for the tenant depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListScriptsLegacy", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListScriptsLegacyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch scripts whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch scripts whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" }, { "name": "page_size", "description": "The maximum number of scripts to return per page.", "in": "query", "required": false, "x-displayname": "Page Size", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "500" }, { "name": "page_number", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "in": "query", "required": false, "x-displayname": "Page Number.", "schema": { "type": "integer", "format": "int32" }, "x-f5xc-example": "10" }, { "name": "page_token", "description": "Page_token is the value of listscriptsresponse.next_page_token from previous request.", "in": "query", "required": false, "x-displayname": "Page Token.", "schema": { "type": "string" }, "x-f5xc-example": "cGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListScriptsLegacy", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "List Scripts.", "description": "List all the scripts for the tenant depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListScripts", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListScriptsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListScriptsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListScripts", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Script resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "script" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "script" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/overview": { "get": { "summary": "GET Scripts Overview.", "description": "GET aggregated overview metrics for all scripts including approval status, mitigation status, and behavior metrics.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptsOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetScriptsOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "start_time", "description": "Format: unix epoch timestamp in seconds\nFetch scripts whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "Format: unix epoch timestamp in seconds\nFetch scripts whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptsOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/approval-status": { "post": { "summary": "Update Script Approval Status.", "description": "Update the approval status of a script.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptApprovalStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptApprovalStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nScript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-ssAH-Ji-oC" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptApprovalStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptApprovalStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Approval-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "approval-statu" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "approval-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/behaviors": { "get": { "summary": "List Behaviors By Script.", "description": "List all the behaviors for a script depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListBehaviorsByScript", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListBehaviorsByScriptResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nScript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" }, { "name": "type", "description": "X-required\nFilter based on type of behaviors\n\n- NEW: NEW\nNew Behaviors\n- ALL: ALL\nAll Behaviors.", "in": "query", "required": false, "x-displayname": "ALL", "schema": { "type": "string", "enum": [ "NEW", "ALL" ], "default": "NEW" }, "x-f5xc-example": "NEW" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListBehaviorsByScript", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/dashboard": { "get": { "summary": "GET Script Overview.", "description": "GET script overview data for a script depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetScriptOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nScript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" }, { "name": "type", "description": "X-required\nFilter events based on type of behaviors\n\n- NEW: NEW\nNew Behaviors\n- ALL: ALL\nAll Behaviors.", "in": "query", "required": false, "x-displayname": "ALL", "schema": { "type": "string", "enum": [ "NEW", "ALL" ], "default": "NEW" }, "x-f5xc-example": "NEW" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch behaviors whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetScriptOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/formFields": { "get": { "summary": "List Form Fields By Script.", "description": "List all the form fields for a script depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsByScript", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListFormFieldsByScriptResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nscript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch form fields whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListFormFieldsByScript", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/networkInteractions": { "get": { "summary": "List Network Interactions By Script.", "description": "List all the network interactions for a script depending on start time and end time.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListNetworkInteractionsByScript", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListNetworkInteractionsByScriptResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nscript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" }, { "name": "start_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch network interactions whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "X-required\nformat: unix epoch timestamp in seconds\nfetch network interactions whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListNetworkInteractionsByScript", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{id}/readStatus": { "post": { "summary": "Update Script FormFields ReadStatus.", "description": "Allow / block script from reading form fields.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptReadStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptReadStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "id", "description": "ID\nScript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptReadStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptReadStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Readstatu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "readStatu" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "readStatu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/affectedUsers": { "post": { "summary": "List Affected Users.", "description": "List affected users who have loaded this particular script.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListAffectedUsers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListAffectedUsersResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "script_id", "description": "Script_id\nx-required\nID of the script.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListAffectedUsersRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListAffectedUsers", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.script_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Affecteduser resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "affectedUser" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.script_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "affectedUser" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/inline": { "get": { "summary": "List Inline Scripts.", "description": "List all inline scripts with hash values for a given script ID.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.ListInlineScripts", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseListInlineScriptsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "script_id", "description": "Script_id\nscript ID.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" }, { "name": "start_time", "description": "Format: unix epoch timestamp in seconds\nfetch inline scripts whose timestamp >= start_time.", "in": "query", "required": false, "x-displayname": "Start Time.", "schema": { "type": "string" }, "x-f5xc-example": "1570194000" }, { "name": "end_time", "description": "Format: unix epoch timestamp in seconds\nfetch inline scripts whose timestamp <= end_time.", "in": "query", "required": false, "x-displayname": "End Time", "schema": { "type": "string" }, "x-f5xc-example": "1570194300" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.ListInlineScripts", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.script_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace", "path.script_id" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/scripts/{script_id}/justification": { "post": { "summary": "Update Script Justification.", "description": "Update justification for script found.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptJustification", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptJustificationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "script_id", "description": "Script_id\nx-required\nID of the script.", "in": "path", "required": true, "x-displayname": "Script ID", "schema": { "type": "string" }, "x-f5xc-example": "s-1234567" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateScriptJustificationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateScriptJustification", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.script_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Justification resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "justification" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.script_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "justification" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/status": { "get": { "summary": "GET Status.", "description": "GET Client-Side Defense status for the tenant.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/summary": { "get": { "summary": "GET Summary.", "description": "GET summary details for a given customer.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.GetSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseGetSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.GetSummary", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/testjs": { "post": { "summary": "Test JS", "description": "Validate JS script tag injection in the target URL.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.TestJS", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseTestJSResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseTestJSRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.TestJS", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Testj resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "testj" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "testj" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/update_domains": { "post": { "summary": "Update Domains.", "description": "Update domain from mitigated domains to allowed domains and vice versa.", "operationId": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateDomains", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateDomainsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client_side_defenseUpdateDomainsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.CustomAPI.UpdateDomains", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Update-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense APIs.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/{metadata.namespace}/allowed_domains": { "post": { "summary": "Create Allowed Domain.", "description": "Create allowed domain.", "operationId": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_domainCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_domainCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Allowed-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "allowed-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "allowed-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Allowed Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.allowed_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/allowed_domains": { "get": { "summary": "List Client-Side Defense Allowed Domain.", "description": "List the set of allowed_domain in a namespace.", "operationId": "ves.io.schema.shape.client_side_defense.allowed_domain.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_domainListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of allowed_domain.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.allowed_domain.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Allowed Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.allowed_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/allowed_domains/{name}": { "get": { "summary": "GET Allowed Domain.", "description": "GET allowed domain.", "operationId": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_domainGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Client-Side Defense Allowed Domain.", "description": "DELETE the specified allowed_domain.", "operationId": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/allowed_domainDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.allowed_domain.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "allowed-domain", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "allowed-domain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Allowed Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.allowed_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{metadata.namespace}/protected_domains": { "post": { "summary": "Create Domain to protect.", "description": "Create Domain to protect.", "operationId": "ves.io.schema.shape.client_side_defense.protected_domain.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_domainCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_domainCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.protected_domain.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Protected-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "protected-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "protected-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Domain to Protect.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.protected_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/protected_domains": { "get": { "summary": "List Client-Side Defense Domain to Protect.", "description": "List the set of protected_domain in a namespace.", "operationId": "ves.io.schema.shape.client_side_defense.protected_domain.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_domainListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of protected_domain.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.protected_domain.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Domain to Protect.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.protected_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/protected_domains/{name}": { "get": { "summary": "GET Protected Domain.", "description": "GET Domain to protect.", "operationId": "ves.io.schema.shape.client_side_defense.protected_domain.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_domainGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.protected_domain.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Client-Side Defense Domain to Protect.", "description": "DELETE the specified protected_domain.", "operationId": "ves.io.schema.shape.client_side_defense.protected_domain.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_domainDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.protected_domain.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "protected-domain", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "protected-domain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Domain to Protect.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.protected_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{metadata.namespace}/mitigated_domains": { "post": { "summary": "Create Mitigated Domain.", "description": "Create Mitigated Domain.", "operationId": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mitigated_domainCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mitigated_domainCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Mitigated-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "mitigated-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "mitigated-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Mitigated Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.mitigated_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/mitigated_domains": { "get": { "summary": "List Client-Side Defense Mitigated Domain.", "description": "List the set of mitigated_domain in a namespace.", "operationId": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mitigated_domainListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of mitigated_domain.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Mitigated Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.mitigated_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/{namespace}/mitigated_domains/{name}": { "get": { "summary": "GET Mitigated Domain.", "description": "GET Mitigated Domain.", "operationId": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mitigated_domainGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Client-Side Defense Mitigated Domain.", "description": "DELETE the specified mitigated_domain.", "operationId": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mitigated_domainDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.mitigated_domain.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "mitigated-domain", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "mitigated-domain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Mitigated Domain.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.mitigated_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/csd/namespaces/system/subscribe": { "post": { "summary": "Subscribe to Client-Side Defense.", "description": "Subscribe to Client-Side Defense.", "operationId": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_shape_client_side_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_shape_client_side_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI.Subscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/csd/namespaces/system/unsubscribe": { "post": { "summary": "Unsubscribe to Client-Side Defense.", "description": "Unsubscribe to Client-Side Defense.", "operationId": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_shape_client_side_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_shape_client_side_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI.Unsubscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Client-Side Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.client_side_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/add-to-csr": { "post": { "summary": "Add Certificate to CSR.", "description": "Add a certificate to an existing CSR.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.AddCertificateToCsr", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateAddCertificateToCsrResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateAddCertificateToCsrRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.AddCertificateToCsr", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Add-to-csr resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "add-to-csr" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "add-to-csr" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/add-with-private-key": { "post": { "summary": "Add Certificate with Private Key.", "description": "Add a new certificate with private key.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.AddCertificateWithPrivateKey", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateAddCertificateWithPrivateKeyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateAddCertificateWithPrivateKeyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.AddCertificateWithPrivateKey", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Add-with-private-key resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "add-with-private-key" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "add-with-private-key" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/csr/{csr_id}": { "get": { "summary": "GET CSR By ID.", "description": "GET CSR details by CSR ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GetCSRByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateGetCSRByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "csr_id", "description": "CSR ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "CSR ID", "schema": { "type": "string" }, "x-f5xc-example": "65b72ff6a44742000137f378" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GetCSRByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.csr_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.csr_id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE CSR By ID.", "description": "DELETE a CSR by its ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.DeleteCSRByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateDeleteCSRByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "csr_id", "description": "CSR ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "CSR ID", "schema": { "type": "string" }, "x-f5xc-example": "65b72ff6a44742000137f378" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.DeleteCSRByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.csr_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "csr", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.csr_id", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "csr", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/generate-csr": { "post": { "summary": "Generate CSR.", "description": "Generate a new CSR.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GenerateCSR", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateGenerateCSRResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateGenerateCSRRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GenerateCSR", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Generate-csr resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "generate-csr" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "generate-csr" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/list-certificate": { "get": { "summary": "List Certificates.", "description": "List all certificates for the enterprise.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ListCertificates", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateListCertificatesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ListCertificates", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/list-csr": { "get": { "summary": "List CSR", "description": "List all CSRs for the enterprise.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ListCSR", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateListCSRResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ListCSR", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}": { "get": { "summary": "GET Certificate By ID.", "description": "GET certificate details by certificate ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GetCertificateByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateGetCertificateByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" }, { "name": "cert_id", "description": "Certificate ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "Certificate ID.", "schema": { "type": "string" }, "x-f5xc-example": "65b73012a44742000137f379" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.GetCertificateByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.cert_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.cert_id", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Certificate By ID.", "description": "DELETE a certificate by its ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.DeleteCertificateByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateDeleteCertificateByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "cert_id", "description": "Certificate ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "Certificate ID.", "schema": { "type": "string" }, "x-f5xc-example": "65b73012a44742000137f379" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.DeleteCertificateByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.cert_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "certificate", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.cert_id", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "certificate", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}/archive": { "put": { "summary": "Archive Certificate By ID.", "description": "Archive a certificate by its ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ArchiveCertificateByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateArchiveCertificateByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "cert_id", "description": "Certificate ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "Certificate ID.", "schema": { "type": "string" }, "x-f5xc-example": "65b73012a44742000137f379" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateArchiveCertificateByIDRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.ArchiveCertificateByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.cert_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "archive" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.cert_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "archive" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/certificate/{cert_id}/unarchive": { "put": { "summary": "Unarchive Certificate By ID.", "description": "Unarchive a certificate by its ID.", "operationId": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.UnarchiveCertificateByID", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateUnarchiveCertificateByIDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "cert_id", "description": "Certificate ID\n\nx-required.", "in": "path", "required": true, "x-displayname": "Certificate ID.", "schema": { "type": "string" }, "x-f5xc-example": "65b73012a44742000137f379" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_certificateUnarchiveCertificateByIDRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI.UnarchiveCertificateByID", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.cert_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "unarchive" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.cert_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "unarchive" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Custom Certificate.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.custom_certificate.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/app-shield/namespaces/system/mobile-app-shield/addon/subscribe": { "post": { "summary": "Subscribe to Mobile App Shield.", "description": "Subscribe to Mobile App Shield.", "operationId": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_shape_mobile_app_shield_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_shape_mobile_app_shield_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI.Subscribe", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile App Shield Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/app-shield/namespaces/system/mobile-app-shield/addon/unsubscribe": { "post": { "summary": "Unsubscribe to Mobile App Shield.", "description": "Unsubscribe to Mobile App Shield.", "operationId": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_shape_mobile_app_shield_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_shape_mobile_app_shield_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI.Unsubscribe", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile App Shield Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.mobile_app_shield.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/integrator/namespaces/system/mobile-integrator/addon/subscribe": { "post": { "summary": "Subscribe to Mobile Integrator.", "description": "Subscribe to Mobile Integrator.", "operationId": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_shape_mobile_integrator_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_shape_mobile_integrator_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI.Subscribe", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile Integrator Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/integrator/namespaces/system/mobile-integrator/addon/unsubscribe": { "post": { "summary": "Unsubscribe to Mobile Integrator.", "description": "Unsubscribe to Mobile Integrator.", "operationId": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_shape_mobile_integrator_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_shape_mobile_integrator_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI.Unsubscribe", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile Integrator Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.mobile_integrator.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk": { "get": { "summary": "GET List Of Mobile SDKs.", "description": "ListMobileSDKs is an API to list all mobile SDKs available for download.", "operationId": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI.ListMobileSDKs", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectListObjectsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "object_type", "description": "Optional query parameter. Type of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" }, { "name": "name", "description": "Optional query parameter. Name of the stored_object.", "in": "query", "required": false, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-file, shared/example-file, example-ns/example-file" }, { "name": "query_type", "description": "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.", "in": "query", "required": false, "x-displayname": "PREFIX MATCH.", "schema": { "type": "string", "enum": [ "EXACT_MATCH", "PREFIX_MATCH" ], "default": "EXACT_MATCH" } }, { "name": "latest_version_only", "description": "Optional query parameter. If passed, returns only latest version of the objects.", "in": "query", "required": false, "x-displayname": "Latest Versions Only.", "schema": { "type": "boolean", "format": "boolean" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI.ListMobileSDKs", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/object_store/namespaces/{namespace}/stored_objects/mobile-sdk/{name}/{version}": { "get": { "summary": "GET Mobile SDK.", "description": "GetMobileSDK is an API to download particular version of SDK.", "operationId": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI.GetMobileSDK", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stored_objectGetObjectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the stored_object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nx-required\nName of the stored_object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "volt-api-specs" }, { "name": "version", "description": "Version\nVersion of the stored_object in \"v{n}-{YY}-{MM}-{DD}\" formatted string, where n is version number and YY/MM/DD is year, month and date.", "in": "path", "required": true, "x-displayname": "Version", "schema": { "type": "string" }, "x-f5xc-example": "v0-21-09-13" }, { "name": "object_type", "description": "X-required\nType of the stored_object.", "in": "query", "required": false, "x-displayname": "Object Type.", "schema": { "type": "string" }, "x-f5xc-example": "swagger" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI.GetMobileSDK", "tags": [ "object_store" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace", "path.version" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace", "path.version" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_sdk.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/security/namespaces/{metadata.namespace}/mobile_base_configs": { "post": { "summary": "Create Mobile SDK Base Configuration.", "description": "Create Mobile SDK Base Configuration.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Create", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Mobile-base-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "mobile-base-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "mobile-base-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK Base Configuration.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_base_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/mobile/security/namespaces/{metadata.namespace}/mobile_base_configs/{metadata.name}": { "put": { "summary": "Replace Mobile SDK Base Configuration.", "description": "Replace Mobile SDK Base Configuration.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Replace", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "mobile-base-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "mobile-base-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK Base Configuration.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_base_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/mobile/security/namespaces/{namespace}/mobile_base_config_file/{name}": { "get": { "summary": "GET Mobile Base Configuration File.", "description": "GET Mobile Base Configuration File.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.CustomAPI.GetMobileBaseConfigurationFile", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configMobileBaseConfigurationFileResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Mobile SDK Base Configuration name\nx-required\nMobile SDK Base Configuration name.", "in": "path", "required": true, "x-displayname": "Application Name.", "schema": { "type": "string" }, "x-f5xc-example": "App 8000" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.CustomAPI.GetMobileBaseConfigurationFile", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK Base Configuration.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_base_config.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/mobile/security/namespaces/{namespace}/mobile_base_configs": { "get": { "summary": "List Mobile SDK Base Configuration.", "description": "List the set of mobile_base_config in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of mobile_base_config.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.API.List", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK Base Configuration.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_base_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/mobile/security/namespaces/{namespace}/mobile_base_configs/{name}": { "get": { "summary": "GET Mobile SDK Base Configuration.", "description": "GET Mobile SDK Base Configuration.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Get", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Mobile SDK Base Configuration.", "description": "DELETE the specified mobile_base_config.", "operationId": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mobile_base_configDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.mobile_base_config.API.Delete", "tags": [ "mobile" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "mobile-base-config", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "mobile-base-config", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Mobile SDK Base Configuration.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.mobile_base_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/system/apikey": { "get": { "summary": "API Key", "description": "GET API key.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ApiKey", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationApiKeyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ApiKey", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/system/regions": { "get": { "summary": "Regions", "description": "GET protected apps regions list.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.RegionsList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationRegionsListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.RegionsList", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/protected_applications": { "post": { "summary": "Create Protected Application.", "description": "Create applications protected by Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.API.Create", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Protected-application resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "protected-application" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "protected-application" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{metadata.namespace}/protected_applications/{metadata.name}": { "put": { "summary": "Replace Protected Application.", "description": "Replace applications protected by Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.API.Replace", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "protected-application" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "protected-application" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/protected_applications": { "get": { "summary": "List Protected Application.", "description": "List the set of protected_application in a namespace.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of protected_application.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.API.List", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/protected_applications/{name}": { "get": { "summary": "GET Protected Application.", "description": "GET applications protected by Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.API.Get", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Protected Application.", "description": "DELETE the specified protected_application.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.API.Delete", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "protected-application", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "protected-application", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/protected_applications/{name}/config": { "get": { "summary": "Connector Configuration.", "description": "GET Connector config.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ConnectorConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationConnectorConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Application Name\nProtected application name.", "in": "path", "required": true, "x-displayname": "Application Name.", "schema": { "type": "string" }, "x-f5xc-example": "App 8000" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.ConnectorConfig", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/protected_applications/{name}/template": { "get": { "summary": "Template Connector.", "description": "GET iApp template.", "operationId": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.TemplateConnector", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/protected_applicationTemplateConnectorResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Application Name\nProtected application name.", "in": "path", "required": true, "x-displayname": "Application Name.", "schema": { "type": "string" }, "x-f5xc-example": "billing-app" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI.TemplateConnector", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Protected Application.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.protected_application.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/system/reporting/peers/check": { "post": { "summary": "Check Peer Status.", "description": "Check if the tenant has the peer or not.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeerStatusCheck", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeerStatusCheck", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Check resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "check" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "check" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/atb": { "get": { "summary": "ATB Status.", "description": "ATB Status.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATBStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingATBResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "virtual_host", "description": "Name of Virtual Host to scope traffic overview query.", "in": "query", "required": false, "x-displayname": "Virtual Host Name.", "schema": { "type": "string" }, "x-f5xc-example": "example-app-vh-1", "x-required": true } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATBStatus", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "ATB", "description": "Enable/disable ATB.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATB", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingATBResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingATBRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ATB", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Atb resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "atb" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "atb" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/config": { "get": { "summary": "Enterprise Config.", "description": "GET Enterprise Config.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EnterpriseConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEnterpriseConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EnterpriseConfig", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/consumption/summary": { "get": { "summary": "Consumption Summary.", "description": "GET Consumption summary.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ConsumptionSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingConsumptionSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic usage query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "start", "description": "Or \"2022-08-01\"\nThe start date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD.", "in": "query", "required": false, "x-displayname": "Start Date (YYYY-MM or YYYY-MM-DD)", "schema": { "type": "string" }, "x-f5xc-example": "2022-08" }, { "name": "end", "description": "Or \"2022-09-30\"\nThe end date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD.", "in": "query", "required": false, "x-displayname": "End Date (YYYY-MM or YYYY-MM-DD)", "schema": { "type": "string" }, "x-f5xc-example": "2022-09" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ConsumptionSummary", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories": { "post": { "summary": "Endpoint Categories.", "description": "GET Endpoint Category Breakdown.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategories", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEndpointCategoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategories", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Categorie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "categorie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "categorie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/categories/{category}": { "post": { "summary": "Endpoint Categories Label.", "description": "GET Endpoint Category Breakdown.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategoriesLabel", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEndpointCategoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "category", "description": "Category\nendpoint category label.", "in": "path", "required": true, "x-displayname": "Category", "schema": { "type": "string" }, "x-f5xc-example": "Login" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointCategoriesLabel", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.category", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Categorie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "categorie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.category", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "categorie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/list": { "post": { "summary": "All Protected Endpoints.", "description": "GET All Protected Endpoints.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEndpointListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointList", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "List resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "list" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "list" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/endpoint/summary": { "post": { "summary": "Endpoint Summary.", "description": "GET Endpoint Summary.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEndpointSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummary", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Summary resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "summary" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "summary" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/endpoints": { "post": { "summary": "Report Endpoints.", "description": "Report Endpoints.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ReportEndpoints", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingReportEndpointsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ReportEndpoints", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/insight/credential-stuffing-attack": { "post": { "summary": "Insight Event: Credential Stuffing Attack.", "description": "GET Insight Credential Stuffing Attack.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.CredentialStuffingAttack", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingCredentialStuffingAttackResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.CredentialStuffingAttack", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Credential-stuffing-attack resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "credential-stuffing-attack" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "credential-stuffing-attack" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/insight/event/bad-bot-reduction": { "post": { "summary": "Insight Bad Bot Reduction.", "description": "Insight Bad Bot Reduction.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightBadBotReduction", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightBadBotReductionResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightBadBotReduction", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Bad-bot-reduction resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "bad-bot-reduction" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "bad-bot-reduction" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/insight/event/unaddressed-automations": { "post": { "summary": "Insight Unaddressed Automations.", "description": "Insight Unaddressed Automations.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightUnaddressedAutomations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightUnaddressedAutomationsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightUnaddressedAutomations", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unaddressed-automation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unaddressed-automation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unaddressed-automation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/insight/personal-stats": { "post": { "summary": "Insight Personal Stats.", "description": "Insight Personal Stats.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightPersonalStats", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightPersonalStatsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.InsightPersonalStats", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Personal-stat resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "personal-stat" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "personal-stat" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/insight/total-automation": { "post": { "summary": "Insight Event: Total Automation.", "description": "GET Insight Total Automation data.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TotalAutomation", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTotalAutomationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nNamespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "default" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingInsightRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TotalAutomation", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Total-automation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "total-automation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "total-automation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/endpoints": { "post": { "summary": "Malicious Report Endpoints.", "description": "Malicious Report Endpoints.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpoints", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportEndpointsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpoints", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/asn": { "post": { "summary": "Malicious Report Transactions ASN.", "description": "Malicious Report Transactions ASN.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASN", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASN", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asn resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asn" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/browser": { "post": { "summary": "Malicious Report Transactions Browser.", "description": "Malicious Report Transactions Browser.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowser", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Browser resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "browser" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "browser" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ip": { "post": { "summary": "Malicious Report Transactions IP.", "description": "Malicious Report Transactions IP.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIP", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/os": { "post": { "summary": "Malicious Report Transactions OS.", "description": "Malicious Report Transactions OS.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOS", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOS", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "O resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "o" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "o" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/malicious/transactions/ua": { "post": { "summary": "Malicious Report Transactions UA.", "description": "Malicious Report Transactions UA.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUA", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUA", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/endpoints": { "post": { "summary": "Top Attacked Endpoints.", "description": "GET top attacked application endpoints.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpoints", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedEndpointsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpoints", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview": { "post": { "summary": "Top Latency Overview.", "description": "GET top latency overview.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopLatencyOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/latency/overview/apps": { "post": { "summary": "Top Latency Overview Apps.", "description": "GET top latency overview apps.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverviewApps", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopLatencyOverviewAppsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopLatencyOverviewApps", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "App resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "app" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "app" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/asorg": { "post": { "summary": "Top Malicious Bots by ASOrg.", "description": "GET top malicious bots by AS Organization.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrg", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByASOrgResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrg", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asorg resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asorg" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asorg" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/automation": { "post": { "summary": "Top Malicious Bot Automation Types.", "description": "GET top malicious bots automation types.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAutomationTypesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypes", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Automation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "automation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "automation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ip": { "post": { "summary": "Top Malicious Bots by IP address.", "description": "GET Top Malicious Bots by source IP address.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIP", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/malicious/ua": { "post": { "summary": "Top Malicious Bots by User Agent String.", "description": "GET top malicious bots by user agent string.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUA", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByUAResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUA", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/app": { "post": { "summary": "Top Transactions by Application.", "description": "GET Top Transactions by Application.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopTransactionsByApp", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopTransactionsByAppResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopTransactionsByApp", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "App resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "app" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "app" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/categories": { "post": { "summary": "Top Categories.", "description": "GET top flow label categories.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopCategories", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopCategoriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopCategories", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Categorie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "categorie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "categorie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/transactions/endpointlabels": { "post": { "summary": "Top Endpoint Labels.", "description": "GET top Endpoint labels.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopEndpointLabels", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopEndpointLabelsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopEndpointLabels", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpointlabel resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpointlabel" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpointlabel" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/good": { "post": { "summary": "Top Good Bots.", "description": "GET top good bots.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBots", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopGoodBotsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBots", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Good resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "good" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "good" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/browser": { "post": { "summary": "Top Human Browser.", "description": "GET top human browser.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowser", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanBrowserResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowser", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Browser resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "browser" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "browser" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/device": { "post": { "summary": "Top Human Device.", "description": "GET top human device.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDevice", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanDeviceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDevice", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Device resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "device" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "device" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/geolocation": { "post": { "summary": "Top Human Geolocation.", "description": "GET top human geolocation.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocation", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanGeolocationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocation", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Geolocation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "geolocation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "geolocation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/human/dimension/platform": { "post": { "summary": "Top Human Platform.", "description": "GET top human platform.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatform", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanPlatformResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatform", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Platform resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "platform" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "platform" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/app": { "post": { "summary": "Top Malicious Bots by Application.", "description": "GET Top Malicious Bots by Application.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByApp", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByAppResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByApp", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "App resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "app" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "app" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/apps/timeseries": { "post": { "summary": "Malicious Report APP Time Series.", "description": "Malicious Report APP Time Series.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeries", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportAPPTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeries", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg": { "post": { "summary": "Top Malicious Bots by ASOrg v2.", "description": "GET top malicious bots by AS Organization v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByASOrgResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asorg resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asorg" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asorg" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/asorg/{attack_type}": { "post": { "summary": "Top ASN of Attack Intent.", "description": "GET Top Malicious Bot Event by ASN of Attack Intent Type.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrg", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByASOrgResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrg", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asorg resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asorg" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asorg" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/attackintent": { "post": { "summary": "Top Malicious Bots by Attack Intent.", "description": "Top Malicious Bots by Attack Intent.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackIntentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntent", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Attackintent resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "attackintent" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "attackintent" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/automation": { "post": { "summary": "Top Malicious Bot Automation Types v2.", "description": "GET top malicious bots automation types v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAutomationTypesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Automation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "automation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "automation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/bfp": { "post": { "summary": "Top Attacked BFP.", "description": "Top Attacked BFP.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedBFP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedBFPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedBFP", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Bfp resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "bfp" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "bfp" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/endpoints": { "post": { "summary": "Top Attacked Endpoints v2.", "description": "GET top attacked application endpoints v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedEndpointsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip": { "post": { "summary": "Top Malicious Bots by IP address v2.", "description": "GET Top Malicious Bots by source IP address v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ip/{attack_type}": { "post": { "summary": "Top Source IP of Attack Intent.", "description": "GET Top Malicious Bot Event by Source IP of Attack Intent Type.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIP", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua": { "post": { "summary": "Top Malicious Bots by User Agent String v2.", "description": "GET top malicious bots by user agent string v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByUAResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/top/type/malicious/dimension/ua/{attack_type}": { "post": { "summary": "Top User Agent of Attack Intent.", "description": "GET Top Malicious Bot Event by UA of Attack Intent Type.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUA", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByUAResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUA", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/attackintent/timeseries": { "post": { "summary": "Attack Intent Time Series For All Traffic.", "description": "Attack Intent Time Series For All Traffic.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.AttackIntentTimeSeries", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingAttackIntentTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.AttackIntentTimeSeries", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/dimension/categories/timeseries": { "post": { "summary": "Categories Time Series For All Traffic.", "description": "Categories Time Series For All Traffic\nGET TimeSeries data list for all traffic breaking down by endpoint category.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.CategoriesTimeSeries", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingCategoriesTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.CategoriesTimeSeries", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/dimension/attackintent/timeseries": { "post": { "summary": "Malicious Bot Attack Intent Time Series.", "description": "Malicious Bot Attack Intent Time Series.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeries", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingAttackIntentTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeries", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/actions": { "post": { "summary": "Malicious Traffic Overview in actions.", "description": "GET Malicious Traffic Overview in Actions.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficOverviewActionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/metrics": { "post": { "summary": "Malicious Traffic Overview Metrics.", "description": "Malicious Traffic Overview Metrics.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficOverviewMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetrics", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/malicious/overview/timeseries/actions": { "post": { "summary": "Malicious Traffic Overview Timeseries in Actions.", "description": "GET Malicious Traffic Overview Timeseries in Actions.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficTimeseriesActionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview": { "post": { "summary": "Traffic Overview.", "description": "GET traffic overview.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/expanded": { "post": { "summary": "Expanded Traffic Overview.", "description": "GET expanded traffic overview.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpanded", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpanded", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Expanded resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "expanded" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "expanded" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/traffic/overview/timeseries": { "post": { "summary": "Traffic Overview Timeseries.", "description": "GET Traffic Overview Timeseries.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseries", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseries", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/reporting/usage/summary": { "get": { "summary": "Usage Summary.", "description": "GET transactions usage summary.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TransactionUsageSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTransactionUsageSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic usage query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "start", "description": "Or \"2022-08-01\"\nThe start date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD.", "in": "query", "required": false, "x-displayname": "Start Date (YYYY-MM or YYYY-MM-DD)", "schema": { "type": "string" }, "x-f5xc-example": "2022-08" }, { "name": "end", "description": "Or \"2022-09-30\"\nThe end date of the query period.\nFormat: YYYY-MM or YYYY-MM-DD.", "in": "query", "required": false, "x-displayname": "End Date (YYYY-MM or YYYY-MM-DD)", "schema": { "type": "string" }, "x-f5xc-example": "2022-09" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TransactionUsageSummary", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/forensic/fields": { "post": { "summary": "Forensic Fields.", "description": "GET", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ForensicFields", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingForensicFieldsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "namespace1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingForensicFieldsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ForensicFields", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Field resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "field" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "field" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/automated/overview/actions": { "post": { "summary": "Automated Traffic Overview in actions.", "description": "GET All Automated Traffic Actions.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.AutomatedTrafficActions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingAutomatedTrafficActionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.AutomatedTrafficActions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/active/ai": { "post": { "summary": "Active AI Known Bot.", "description": "GET Active AI Known Bot.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ActiveAIKnownBot", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingActiveAIKnownBotResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.ActiveAIKnownBot", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ai resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ai" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ai" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category": { "post": { "summary": "Known Bot Transactions Per Category.", "description": "GET Known Bot Transactions by Category.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotTransactionsPerCategory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotTransactionsPerCategoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotTransactionsPerCategory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Category resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "category" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "category" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions": { "post": { "summary": "Known Bot Actions Per Category.", "description": "GET Known Bot Actions Per Category.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotActionsPerCategory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingActionsPerCategoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotActionsPerCategory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/actions/ai": { "post": { "summary": "Known Bot Actions Per AI Category.", "description": "GET Known Bot Actions Per AI Category.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotActionsPerAICategory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingActionsPerCategoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotActionsPerAICategory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ai resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ai" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ai" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/category/timeseries": { "post": { "summary": "Known Bot Categories Over Time.", "description": "GET Known Bot Categories Over Time.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotCategoriesOverTime", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotCategoriesOverTimeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotCategoriesOverTime", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/endpoint": { "post": { "summary": "Known Bot Endpoint.", "description": "GET Known Bot Endpoint.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotEndpoint", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotEndpointResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotEndpoint", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/statistics/overview": { "post": { "summary": "Known Bot Overview Statistics.", "description": "GET overview statistics for known bot traffic.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotOverviewStatistics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotOverviewStatisticsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.KnownBotOverviewStatistics", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/top/type/known/active": { "post": { "summary": "Top Active Known Bot.", "description": "GET Top Active Known Bot.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopActiveKnownBot", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopActiveKnownBotResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingKnownBotRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopActiveKnownBot", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Active resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "active" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "active" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/endpoint/summary": { "post": { "summary": "Endpoint Summary V2.", "description": "GET Endpoint Summary V2 with Unevaluated Transactions.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummaryV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingEndpointSummaryResponseV2" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.EndpointSummaryV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Summary resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "summary" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "summary" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/endpoints": { "post": { "summary": "Malicious Report Endpoints V2.", "description": "Malicious Report Endpoints V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpointsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportEndpointsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportEndpointsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/asn": { "post": { "summary": "Malicious Report Transactions ASN V2.", "description": "Malicious Report Transactions ASN V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASNV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsASNV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asn resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asn" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/browser": { "post": { "summary": "Malicious Report Transactions Browser V2.", "description": "Malicious Report Transactions Browser V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowserV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsBrowserV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Browser resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "browser" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "browser" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ip": { "post": { "summary": "Malicious Report Transactions IP V2.", "description": "Malicious Report Transactions IP V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIPV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsIPV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/os": { "post": { "summary": "Malicious Report Transactions OS V2.", "description": "Malicious Report Transactions OS V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOSV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsOSV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "O resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "o" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "o" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/malicious/transactions/ua": { "post": { "summary": "Malicious Report Transactions UA V2.", "description": "Malicious Report Transactions UA V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUAV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportTransactionsUAV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/good": { "post": { "summary": "Top Good Bots V2.", "description": "GET top good bots V2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopGoodBotsResponseV2" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Good resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "good" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "good" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/browser": { "post": { "summary": "Top Human Browser V2.", "description": "GET top human browser v2 with sub-categories.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowserV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanBrowserResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanBrowserV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Browser resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "browser" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "browser" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/device": { "post": { "summary": "Top Human Device V2.", "description": "GET top human device v2 with sub-categories.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDeviceV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanDeviceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanDeviceV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Device resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "device" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "device" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/geolocation": { "post": { "summary": "Top Human Geolocation V2.", "description": "GET top human geolocation v2 with sub-categories.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocationV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanGeolocationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanGeolocationV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Geolocation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "geolocation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "geolocation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/human/dimension/platform": { "post": { "summary": "Top Human Platform V2.", "description": "GET top human platform v2 with sub-categories.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatformV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopHumanPlatformResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopHumanPlatformV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Platform resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "platform" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "platform" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/apps/timeseries": { "post": { "summary": "Malicious Report APP Time Series V2.", "description": "Malicious Report APP Time Series V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeriesV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousReportAPPTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousReportAPPTimeSeriesV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/asorg/{attack_type}": { "post": { "summary": "Top ASN of Attack Intent V2.", "description": "GET Top Malicious Bot Event by ASN of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrgV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByASOrgResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByASOrgV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asorg resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asorg" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asorg" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/attackintent": { "post": { "summary": "Top Malicious Bots by Attack Intent V2.", "description": "Top Malicious Bots by Attack Intent V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntentV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackIntentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotByAttackIntentV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Attackintent resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "attackintent" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "attackintent" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/endpoints": { "post": { "summary": "Top Attacked Endpoints v3.", "description": "GET top attacked application endpoints v3.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedEndpointsResponseV2" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ip/{attack_type}": { "post": { "summary": "Top Source IP of Attack Intent V2.", "description": "GET Top Malicious Bot Event by Source IP of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIPV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByIPV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/top/type/malicious/dimension/ua/{attack_type}": { "post": { "summary": "Top User Agent of Attack Intent V2.", "description": "GET Top Malicious Bot Event by UA of Attack Intent Type V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUAV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsAttackIntentByUAResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "attack_type", "description": "Attack Intent Type\nOptional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "in": "path", "required": true, "x-displayname": "Attack Intent Type.", "schema": { "type": "string" }, "x-f5xc-example": "AccountCreation" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequestAttackIntent" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsAttackIntentByUAV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.attack_type", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/dimension/attackintent/timeseries": { "post": { "summary": "Malicious Bot Attack Intent Time Series V2.", "description": "Malicious Bot Attack Intent Time Series V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeriesV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingAttackIntentTimeSeriesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousAttackIntentTimeSeriesV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/actions": { "post": { "summary": "Malicious Traffic Overview in actions V2.", "description": "GET Malicious Traffic Overview in Actions.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActionsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficOverviewActionsV2Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewActionsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/metrics": { "post": { "summary": "Malicious Traffic Overview Metrics V2.", "description": "Malicious Traffic Overview Metrics V2, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetricsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficOverviewMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficOverviewMetricsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/malicious/overview/timeseries/actions": { "post": { "summary": "Malicious Traffic Overview Timeseries in Actions V2.", "description": "GET Malicious Traffic Overview Timeseries in Actions\nGET the malicious traffic action details like Blocked, Challenged, Flagged, Redirected, Transformed, Undefined, etc.\nOver a chosen period. It can cater to the need to support dynamic malicious traffic action types,\nunlike supporting fixed action types in v1.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActionsV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingMaliciousTrafficTimeseriesActionsResponseV2" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.MaliciousTrafficTimeseriesActionsV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Action resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "action" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "action" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview": { "post": { "summary": "Traffic Overview V2.", "description": "GET traffic overview v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewV2Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/expanded": { "post": { "summary": "Expanded Traffic Overview V2.", "description": "GET expanded traffic overview v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Expanded resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "expanded" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "expanded" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v2/reporting/traffic/overview/timeseries": { "post": { "summary": "Traffic Overview Timeseries V2.", "description": "GET Traffic Overview Timeseries V2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV2", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesV2Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV2", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/good": { "post": { "summary": "Top Good Bots V3.", "description": "GET top good bots V3, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopGoodBotsResponseV2" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopGoodBotsV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Good resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "good" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "good" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/asorg": { "post": { "summary": "Top Malicious Bots by ASOrg v3.", "description": "GET top malicious bots by AS Organization v3, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByASOrgResponseV3" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByASOrgV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Asorg resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "asorg" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "asorg" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/automation": { "post": { "summary": "Top Malicious Bot Automation Types v3.", "description": "GET top malicious bots automation types v3, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAutomationTypesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAutomationTypesV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Automation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "automation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "automation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ip": { "post": { "summary": "Top Malicious Bots by IP address v3.", "description": "GET Top Malicious Bots by source IP address v3, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByIPResponseV3" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByIPV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/top/type/malicious/dimension/ua": { "post": { "summary": "Top Malicious Bots by User Agent String v3.", "description": "GET top malicious bots by user agent string v3.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByUAResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview": { "post": { "summary": "Traffic Overview V3.", "description": "GET traffic overview v3, v3response uses a dynamic structure and has traffic types of human, good bot, bad bot, trusted, untrusted and interstitual, also removed the percentage.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewV3Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/expanded": { "post": { "summary": "Expanded Traffic Overview V3.", "description": "GET expanded traffic overview v3.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Expanded resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "expanded" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "expanded" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v3/reporting/traffic/overview/timeseries": { "post": { "summary": "Traffic Overview Timeseries V3.", "description": "GET the traffic count details based on types like \"Humans, Automated, Allow listed, etc. Over a chosen period.\nIt can cater to the need to support dynamic traffic types, unlike supporting fixed types in v1 or v2.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV3", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesV3Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV3", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/endpoints": { "post": { "summary": "Top Attacked Endpoints v4.", "description": "GET top attacked application endpoints v4.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV4", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedEndpointsResponseV4" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV4", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v4/reporting/top/type/malicious/dimension/ua": { "post": { "summary": "Top Malicious Bots by User Agent String v4.", "description": "GET top malicious bots by user agent string v4, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV4", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopMaliciousBotsByUAResponseV4" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopMaliciousBotsByUAV4", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ua resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ua" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ua" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/expanded": { "post": { "summary": "Expanded Traffic Overview in Traffic Analyzer.", "description": "GET expanded Traffic overview in Traffic Analyzer. This version adds support for traffic types, and its subtypes,\naction taken. In addition, it will show additional traffic types for advanced customers.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV4", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV4", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Expanded resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "expanded" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "expanded" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/timeseries": { "post": { "summary": "Traffic Overview Timeseries V4.", "description": "GET the traffic count details based on types like Humans, Automated, Allow listed, etc. Over a chosen period.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV4", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesV3Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewV2Request" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewTimeseriesV4", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Timeserie resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "timeserie" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "timeserie" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v5/reporting/top/type/malicious/dimension/endpoints": { "post": { "summary": "Top Attacked Endpoints v5.", "description": "GET top attacked application endpoints v5, with the new definition of malicious bot for sub categories feature.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV5", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopAttackedEndpointsResponseV4" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTopRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TopAttackedEndpointsV5", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Endpoint resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "endpoint" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "endpoint" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/{namespace}/v5/reporting/traffic/overview/expanded": { "post": { "summary": "Expanded Traffic Overview V5.", "description": "GET expanded traffic overview v5 with global filters supported.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV5", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedV5Response" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query. Only virtual_host in given namespace will be considered.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "namespace1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingTrafficOverviewExpandedV5Request" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.TrafficOverviewExpandedV5", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Expanded resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "expanded" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "expanded" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/reporting/peers/threat-types": { "post": { "summary": "Peergroup By Threat Types.", "description": "GetThreat Types traffic count for Peergroup Benchmarking.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersThreatTypes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersThreatTypes", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Threat-type resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "threat-type" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "threat-type" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/reporting/peers/top-good-bots": { "post": { "summary": "Peer Group Top Good Bots.", "description": "GET Peer Group Top Good Bots.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopGoodBots", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopGoodBots", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Top-good-bot resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-good-bot" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-good-bot" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/reporting/peers/top-reason-codes": { "post": { "summary": "Peergroup Top Reason Codes.", "description": "GET Top Reason Codes.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopReasonCodes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTopReasonCodes", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Top-reason-code resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-reason-code" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-reason-code" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/reporting/peers/traffic/overview": { "post": { "summary": "Peer Group Traffic Overview.", "description": "GET traffic overview.", "operationId": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTrafficOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupTrafficOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportingPeerGroupRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.reporting.CustomAPI.PeersTrafficOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Reporting API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.reporting.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/system/bot-defense/addon/subscribe": { "post": { "summary": "Subscribe to Shape Bot Defense.", "description": "Subscribe to Shape Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_shape_bot_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_shape_bot_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/namespaces/system/bot-defense/addon/unsubscribe": { "post": { "summary": "Unsubscribe to Shape Bot Defense.", "description": "Unsubscribe to Shape Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_shape_bot_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_shape_bot_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/subscribe": { "post": { "summary": "Subscribe to Shape Bot Defense.", "description": "Subscribe to Shape Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe_post_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_shape_bot_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_shape_bot_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Subscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/bot/unsubscribe": { "post": { "summary": "Unsubscribe to Shape Bot Defense.", "description": "Unsubscribe to Shape Bot Defense.", "operationId": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe_post_1", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_shape_bot_defense_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_shape_bot_defense_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.bot_defense.subscription.CustomAPI.Unsubscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Bot Defense Subscription API.", "x-ves-proto-service": "ves.io.schema.shape.bot_defense.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/channel": { "post": { "summary": "Channel Dashboard.", "description": "GET channel chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Channel", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeChannelResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeChannelRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Channel", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Channel resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "channel" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "channel" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/conversion": { "post": { "summary": "Conversion Dashboard.", "description": "GET conversion chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Conversion", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeConversionResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeConversionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Conversion", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Conversion resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "conversion" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "conversion" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/enjoy": { "post": { "summary": "Enjoy Dashboard.", "description": "GET enjoy chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Enjoy", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeEnjoyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeEnjoyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Enjoy", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Enjoy resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "enjoy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "enjoy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_aggregation": { "post": { "summary": "Friction Aggregation Dashboard.", "description": "GET Friction Aggregation chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.FrictionAggregation", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeFrictionAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeFrictionAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.FrictionAggregation", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Friction-aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "friction-aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "friction-aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/friction_histogram": { "post": { "summary": "Friction Histogram Dashboard.", "description": "GET Histogram Aggregation chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.FrictionHistogram", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeFrictionHistogramResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeFrictionHistogramRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.FrictionHistogram", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Friction-histogram resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "friction-histogram" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "friction-histogram" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/health": { "get": { "summary": "Health Check.", "description": "Health Check.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Health", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeHealthResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Health", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/lift": { "post": { "summary": "Lift Dashboard.", "description": "GET lift chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Lift", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeLiftResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeLiftRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Lift", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Lift resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "lift" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "lift" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/rescue": { "post": { "summary": "Rescue Dashboard.", "description": "GET rescue chart data from shape recognize API.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Rescue", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeRescueResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeRescueRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Rescue", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Rescue resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "rescue" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "rescue" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/dashboard/top_reason_code": { "post": { "summary": "Top Reason Codes.", "description": "Top Reason Codes.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.TopReasonCodes", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeTopReasonCodesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeTopReasonCodesRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.TopReasonCodes", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Top-reason-code resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-reason-code" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-reason-code" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/provision": { "get": { "summary": "GET Recognize Provision Status Addon.", "description": "GET Recognize provision status as add-on service.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.GetStatusAddon", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeGetStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.GetStatusAddon", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/state": { "get": { "summary": "State", "description": "GET customer State if after or before.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.State", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeStateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.State", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/subscribe": { "post": { "summary": "Subscribe to Shape Recognize.", "description": "Subscribe to Shape Recognize as add-on service.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeSubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeSubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Subscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/unsubscribe": { "post": { "summary": "Unsubscribe to Shape Recognize.", "description": "Unsubscribe to Shape Recognize as add-on service.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeUnsubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeUnsubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.Unsubscribe", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/recognize/namespaces/system/recognize/addon/validate/src_tag_injection": { "post": { "summary": "ValidateSrcTagInjection Addon.", "description": "Validate src tag injection in the target URL.", "operationId": "ves.io.schema.shape.recognize.CustomAPI.ValidateSrcTagInjectionAddon", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeValidateSrcTagInjectionResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recognizeValidateSrcTagInjectionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.recognize.CustomAPI.ValidateSrcTagInjectionAddon", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Src-tag-injection resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "src-tag-injection" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "src-tag-injection" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape Recognize Proxy.", "x-ves-proto-service": "ves.io.schema.shape.recognize.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/audit": { "get": { "summary": "GET SAFE Block table list.", "description": "GET SAFE block table list.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockAudit", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeBlockAuditResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "dimt", "description": "Account_id/device_id how to apply the blocking rule.", "in": "query", "required": false, "x-displayname": "Dimt", "schema": { "type": "string" }, "x-f5xc-example": "account_id" }, { "name": "dimv", "description": "The relevant account_id/device_id.", "in": "query", "required": false, "x-displayname": "Dimv", "schema": { "type": "string" }, "x-f5xc-example": "goldcha" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockAudit", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/csv/audit": { "get": { "summary": "GET SAFE Analyst Block Audit as a CSV file.", "description": "GET Safe block audit as CSV file.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockAuditCsv", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeBlockAuditCsvResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "dimt", "description": "Account_id/device_id how to apply the blocking rule.", "in": "query", "required": false, "x-displayname": "Dimt", "schema": { "type": "string" }, "x-f5xc-example": "account_id" }, { "name": "dimv", "description": "The relevant account_id/device_id.", "in": "query", "required": false, "x-displayname": "Dimv", "schema": { "type": "string" }, "x-f5xc-example": "goldcha" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockAuditCsv", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/csv/table": { "get": { "summary": "GET SAFE Analyst Block Table as a CSV file.", "description": "GET Safe block table as CSV file.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockTableCsv", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeBlockTableCsvResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1639382940000" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" }, { "name": "action", "description": "The action type - can be block or allow.", "in": "query", "required": false, "x-displayname": "Action", "schema": { "type": "string" }, "x-f5xc-example": "block" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockTableCsv", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/details": { "get": { "summary": "GET SAFE Block Details.", "description": "GET SAFE block details.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeBlockDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "account_id", "description": "String representing the account ID.", "in": "query", "required": false, "x-displayname": "The account ID.", "schema": { "type": "string" }, "x-f5xc-example": "test123" }, { "name": "device_id", "description": "String representing the device ID.", "in": "query", "required": false, "x-displayname": "Device ID", "schema": { "type": "string" }, "x-f5xc-example": "device123" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockDetails", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/feedback": { "post": { "summary": "PostSafeBlockFeedback.", "description": "POST Safe block feedback.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeBlockFeedback", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeBlockFeedbackResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeBlockFeedbackRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeBlockFeedback", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Feedback resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "feedback" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "feedback" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/rule": { "post": { "summary": "PostSafeBlockRule.", "description": "Edit existing block rule.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeBlockRule", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeBlockRuleResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeBlockRuleRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeBlockRule", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Rule resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "rule" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/block/table": { "get": { "summary": "GET SAFE Block table list.", "description": "GET SAFE block table list.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockTable", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeBlockTableResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1639382940000" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" }, { "name": "action", "description": "The action type - can be block or allow.", "in": "query", "required": false, "x-displayname": "Action", "schema": { "type": "string" }, "x-f5xc-example": "block" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeBlockTable", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/ep": { "post": { "summary": "PostSafeEp.", "description": "POST Safe Analyst Station ep request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeEp", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeEpResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeEpRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeEp", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Ep resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "ep" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "ep" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/feedback": { "post": { "summary": "Update Fraud Feedback.", "description": "Update fraud feedback for a transaction or session.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostFeedback", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostFeedbackResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostFeedbackRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostFeedback", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Feedback resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "feedback" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "feedback" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/general_feedback": { "post": { "summary": "Update Fraud Feedback.", "description": "Update fraud feedback for a transaction or session.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostGeneralFeedback", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostGeneralFeedbackResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostGeneralFeedbackRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostGeneralFeedback", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "General-feedback resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "general-feedback" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "general-feedback" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/health": { "get": { "summary": "GetHealthRequest.", "description": "Returns 200 Ok if the service is health.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetHealth", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetHealth", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/provision": { "post": { "summary": "PostSafeProvision.", "description": "POST Safe Analyst Station provision.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeProvision", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeProvisionResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeProvisionRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeProvision", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Provision resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "provision" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "provision" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/overview": { "get": { "summary": "GET SAFE Overview.", "description": "GET SAFE Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeGeneralResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1639382940000" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "PostSafeOverview.", "description": "POST Safe Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeOverview", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeOverviewResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeOverviewRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeOverview", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Overview resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "overview" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "overview" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_locations": { "get": { "summary": "GET SAFE Top Locations.", "description": "GET SAFE Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeTopLocations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeGeneralResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "apc-namespace" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "limit", "description": "Limited number of records.", "in": "query", "required": false, "x-displayname": "Limit of results.", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "3" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v3" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeTopLocations", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "POST SAFE Top Locations.", "description": "POST SAFE Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTopLocations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeGeneralResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeStatsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTopLocations", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Top-location resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-location" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-location" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/top_sources": { "get": { "summary": "GET SAFE Top Sources.", "description": "GET SAFE Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeTopSources", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeGeneralResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "apc-namespace" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "limit", "description": "Limited number of records.", "in": "query", "required": false, "x-displayname": "Limit of results.", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "3" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v3" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeTopSources", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "POST SAFE Top Sources.", "description": "POST SAFE Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTopSources", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeGeneralResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeStatsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTopSources", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Top-source resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-source" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-source" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/stats/transactions_over_time": { "post": { "summary": "PostSafeTransactionsOverTime.", "description": "POST Safe Analyst Station Dashboard Transaction Breakdown request.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionsOverTime", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsOverTimeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsOverTimeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionsOverTime", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transactions-over-time resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transactions-over-time" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transactions-over-time" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/summary": { "get": { "summary": "GET SAFE Analyst Summary.", "description": "GET SAFE transaction summary for analysts.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "from", "description": "Timestamp representing start date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "Start date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1638320400000" }, { "name": "to", "description": "Timestamp representing end date of the requested period in millieseconds.", "in": "query", "required": false, "x-displayname": "End date of period (timestamp)", "schema": { "type": "string", "format": "int64" }, "x-f5xc-example": "1639382940000" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeSummary", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_details": { "get": { "summary": "GET SAFE Anayst Transaction Details.", "description": "GET a detailed information about the requested transaction.", "operationId": "ves.io.schema.shape.safe.CustomAPI.GetSafeTransactionDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safeGetSafeTransactionDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" }, { "name": "transaction_id", "description": "Transaction identifier.", "in": "query", "required": false, "x-displayname": "Transaction ID.", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "version", "description": "The API version to use.", "in": "query", "required": false, "x-displayname": "Requested API version.", "schema": { "type": "string" }, "x-f5xc-example": "v2" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.GetSafeTransactionDetails", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "PostSafeTransactionDetails.", "description": "POST Safe Analyst Station specific transaction details.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionDetailsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionDetails", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction-detail resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction-detail" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction-detail" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_device_history": { "post": { "summary": "PostSafeTransactionDeviceHistory.", "description": "POST Safe Analyst Station specific transaction device history.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionDeviceHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionDeviceHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionDeviceHistoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionDeviceHistory", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction-device-history resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction-device-history" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction-device-history" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_locations": { "post": { "summary": "PostSafeTransactionLocations.", "description": "POST Safe Analyst Station specific transaction locations.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionLocations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionLocationsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionLocationsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionLocations", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction-location resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction-location" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction-location" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_related_sessions": { "post": { "summary": "PostSafeTransactionRelatedSessions.", "description": "POST Safe Analyst Station specific transaction related sessions.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionRelatedSessions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionRelatedSessionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionRelatedSessionsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionRelatedSessions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction-related-session resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction-related-session" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction-related-session" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transaction_timeline": { "post": { "summary": "PostSafeTransactionTimeline.", "description": "POST Safe Analyst Station specific transaction timeline.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionTimeline", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionTimelineResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionTimelineRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionTimeline", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction-timeline resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction-timeline" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction-timeline" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transactions": { "post": { "summary": "List SAFE Analyst Transactions.", "description": "List SAFE transactions for analysts.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactions", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactions", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transaction resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transaction" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transaction" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/shape/safe/namespaces/{namespace}/safe/sas/transactions_csv": { "post": { "summary": "GET SAFE Analyst Transactions as a CSV file.", "description": "GET Safe transactions as CSV file.", "operationId": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionsCsv", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsCsvResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\n\nx-required\nnamespace is used to scope the query.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "payment-app-namespace-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/safePostSafeTransactionsCsvRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/shape/" }, "x-ves-proto-rpc": "ves.io.schema.shape.safe.CustomAPI.PostSafeTransactionsCsv", "tags": [ "shape" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Transactions-csv resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transactions-csv" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "transactions-csv" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Shape SAFE Analyst Station.", "x-ves-proto-service": "ves.io.schema.shape.safe.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "x-f5xc-description-medium": "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Application Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idApplicationProvisionRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Application Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idApplicationProvisionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "x-f5xc-description-medium": "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by DELETE Applications API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idDeleteApplicationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Region", "x-displayname": "Region", "x-ves-example": "``https://www.example.com``", "x-f5xc-example": "``https://www.example.com``", "x-f5xc-description-short": "Target webpage to check src tag injection.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idEnableRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idEnableResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "x-f5xc-description-medium": "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by Applications API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetApplicationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed to the Bot Top ASN API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTopAsnRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by Bot Top ASN API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTopAsnResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed to the Bot Top URLs API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTopUrlsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by Bot Top URLs API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTopUrlsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed to the Bot Transactions API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTransactionsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by Bot Transactions API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetBotAssessmentTransactionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard Age API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByAgeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard Age API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByAgeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard Application API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByApplicationsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard Application API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByApplicationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard ASN API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByAsnRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard ASN API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByAsnResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard Country API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByCountryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard Country API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByCountryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard Session API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardBySessionRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard Session API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardBySessionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard UA API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByUaRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard UA API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardByUaResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Dashboard Unique API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardUniqueAccessRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by Dashboard Unique API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetDashboardUniqueAccessResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by GET Regions API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetRegionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "HTTP status as reported by the backend.", "title": "Status", "format": "int64", "x-displayname": "Status", "x-f5xc-example": "\"200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be return by GET Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idGetStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "x-f5xc-description-medium": "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed to the Update Application API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idUpdateApplicationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "x-f5xc-description-medium": "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.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be returned by Update Application API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idUpdateApplicationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Src", "x-displayname": "Src", "x-ves-example": "``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aauvdjvrba-65bd8ebd.js``", "x-f5xc-example": "``https://dip.zeronaught.com/__imp_apg__/js/f5cs-a_aauvdjvrba-65bd8ebd.js``", "x-f5xc-description-short": "Content to be present in customer webpage's source.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "Target webpage to check src tag injection.", "title": "Url", "x-displayname": "URL", "x-ves-example": "``https://www.example.com``", "x-f5xc-example": "``https://www.example.com``", "x-f5xc-description-short": "Target webpage to check src tag injection.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to verify shape Application Traffic Insights src tag injection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idValidateSrcTagInjectionRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "Message", "x-displayname": "Message", "x-ves-example": "Injected", "x-f5xc-example": "injected", "x-f5xc-description-short": "Status about src script tag injected in customer's webpage.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to indicate whether customer webpage has custom script tag to track devices been injected or not.", "x-f5xc-description-medium": "Response to indicate whether customer webpage has custom script tag to track devices been injected or not.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for device_idValidateSrcTagInjectionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "alert_gen_policyAlertStatus": { "type": "string", "description": "List of alert statuses\n\nActive\nInactive.", "title": "AlertStatus", "enum": [ "ALERT_ACTIVE", "ALERT_INACTIVE" ], "default": "ALERT_ACTIVE", "x-displayname": "Alert Status.", "x-ves-proto-enum": "ves.io.schema.shape.brmalerts.alert_gen_policy.AlertStatus", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyAlertStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ALERT_ACTIVE\"", "example_yaml": "ALERT_ACTIVE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyChangeAlertStatusRequest": { "type": "object", "description": "Request to change status of alert.", "title": "ChangeAlertStatusRequest", "x-displayname": "Change Alert Status Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ChangeAlertStatusRequest", "properties": { "name": { "type": "string", "description": "The name of the alert.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace in which the the alert is present.", "title": "namespace", "x-displayname": "Namespace", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "The namespace in which the the alert is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyAlertStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyChangeAlertStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyChangeAlertStatusResponse": { "type": "object", "description": "Response to change status of alert.", "title": "ChangeAlertStatusResponse", "x-displayname": "Enable Alert Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ChangeAlertStatusResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyChangeAlertStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of alert_gen_policy", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_gen_policyCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_gen_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a alert_gen_policy", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read alert_gen_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_gen_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_gen_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of alert_gen_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/alert_gen_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyListResponseItem": { "type": "object", "description": "By default a summary of alert_gen_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of alert_gen_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this alert_gen_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this alert_gen_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this alert_gen_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this alert_gen_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates alert_gen_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates alert_gen_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_gen_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this alert_gen_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this alert_gen_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this alert_gen_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_gen_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this alert_gen_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this alert_gen_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of alert_gen_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of alert_gen_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyNotificationDetail": { "type": "object", "description": "Notification Details.", "title": "Notification Details", "x-displayname": "Notification Details.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.NotificationDetail", "properties": { "alert_message": { "type": "string", "description": "Alert Message.", "title": "Alert Message", "maxLength": 512, "x-displayname": "Alert Message.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_message_details": { "type": "string", "description": "Detailed message of the alert.", "title": "Alert Message Details", "x-displayname": "Alert Message Details.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_name": { "type": "string", "description": "Alert Name.", "title": "Alert Name", "maxLength": 16, "x-displayname": "Alert Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/alert_policySeverity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyNotificationDetail", "required_fields": [ "alert_message", "alert_message_details", "alert_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"alert_message\": \"value\",\n \"alert_message_details\": \"value\",\n \"alert_name\": \"example-resource\"\n}", "example_yaml": "alert_message: value\nalert_message_details: value\nalert_name: example-resource" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a alert_gen_policy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_gen_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_gen_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_gen_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_policySeverity": { "type": "string", "description": "List of alert severities\n\nMinor\nMajor\nCritical.", "title": "Severity", "enum": [ "MINOR", "MAJOR", "CRITICAL" ], "default": "MINOR", "x-displayname": "Severity", "x-ves-proto-enum": "ves.io.schema.alert_policy.Severity", "x-f5xc-description-short": "List of alert severities Minor Major Critical.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policySeverity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"MINOR\"", "example_yaml": "MINOR\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "brmalertsalert_gen_policyCreateSpecType": { "type": "object", "description": "Create Alert Generation Policy.", "title": "Create Alert Generation Policy", "x-displayname": "Create Alert Generation Policy.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.CreateSpecType", "properties": { "alert_status": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyAlertStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "details": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyNotificationDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for brmalertsalert_gen_policyCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "brmalertsalert_gen_policyGetSpecType": { "type": "object", "description": "GET Alert Generation Policy.", "title": "Get Alert Generation Policy", "x-displayname": "GET Alert Generation Policy.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.GetSpecType", "properties": { "alert_status": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyAlertStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "details": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyNotificationDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for brmalertsalert_gen_policyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "brmalertsalert_gen_policyReplaceSpecType": { "type": "object", "description": "Replaces the content of an Alert Generation Policy object.", "title": "Replace Alert Generation Policy", "x-displayname": "Replace Alert Generation Policy.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_gen_policy.ReplaceSpecType", "properties": { "alert_status": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyAlertStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "details": { "allOf": [ { "$ref": "#/components/schemas/alert_gen_policyNotificationDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replaces the content of an Alert Generation Policy object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for brmalertsalert_gen_policyReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectRefType": { "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)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "alert_templateCloneTemplateRequest": { "type": "object", "description": "Request to clone template.", "title": "CloneTemplateRequest", "x-displayname": "Clone Template Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CloneTemplateRequest", "properties": { "name": { "type": "string", "description": "The name of the alert template to be cloned.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "The name of the alert template to be cloned.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace in which the the alert template is present.", "title": "namespace", "x-displayname": "Namespace", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "The namespace in which the the alert template is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateCloneTemplateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateCloneTemplateResponse": { "type": "object", "description": "Response to clone template.", "title": "CloneTemplateResponse", "x-displayname": "Clone Template Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CloneTemplateResponse", "properties": { "alert_name": { "type": "string", "description": "The name of the alert created from template.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "The name of the alert created from template.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateCloneTemplateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of alert_template", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_templateCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_templateGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a alert_template", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read alert_template", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/alert_templateCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_templateGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_templateStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of alert_template", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/alert_templateListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateListResponseItem": { "type": "object", "description": "By default a summary of alert_template is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of alert_template", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this alert_template.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this alert_template.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this alert_template.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this alert_template.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates alert_template is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates alert_template is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/brmalertsalert_templateGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this alert_template.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this alert_template.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this alert_template.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_templateStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this alert_template.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of alert_template is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of alert_template is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "alert_templateStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_templateStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "brmalertsalert_templateCreateSpecType": { "type": "object", "description": "Create Domain to protect.", "title": "Create Domain to protect", "x-displayname": "Create Domain to protect.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.CreateSpecType", "properties": { "alert_message": { "type": "string", "description": "Alert Message.", "maxLength": 512, "x-displayname": "Alert Message.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_message_details": { "type": "string", "description": "Detailed message of the alert.", "x-displayname": "Alert Message Details.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_name": { "type": "string", "description": "Alert Name.", "maxLength": 16, "x-displayname": "Alert Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/alert_policySeverity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for brmalertsalert_templateCreateSpecType", "required_fields": [ "alert_message", "alert_message_details", "alert_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"alert_message\": \"value\",\n \"alert_message_details\": \"value\",\n \"alert_name\": \"example-resource\"\n}", "example_yaml": "alert_message: value\nalert_message_details: value\nalert_name: example-resource" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "brmalertsalert_templateGetSpecType": { "type": "object", "description": "GET Domain to protect.", "title": "Get Domain to protect", "x-displayname": "GET Protected Domain.", "x-ves-proto-message": "ves.io.schema.shape.brmalerts.alert_template.GetSpecType", "properties": { "alert_message": { "type": "string", "description": "Alert Message.", "maxLength": 512, "x-displayname": "Alert Message.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_message_details": { "type": "string", "description": "Detailed message of the alert.", "x-displayname": "Alert Message Details.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "alert_name": { "type": "string", "description": "Alert Name.", "maxLength": 16, "x-displayname": "Alert Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/alert_policySeverity" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for brmalertsalert_templateGetSpecType", "required_fields": [ "alert_message", "alert_message_details", "alert_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"alert_message\": \"value\",\n \"alert_message_details\": \"value\",\n \"alert_name\": \"example-resource\"\n}", "example_yaml": "alert_message: value\nalert_message_details: value\nalert_name: example-resource" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_ruleBotDetectionRuleChangeType": { "type": "string", "description": "Type of bot detection rule change.", "title": "BotDetectionRuleChangeType", "enum": [ "BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN", "BOT_DETECTION_RULE_CHANGE_TYPE_CREATION", "BOT_DETECTION_RULE_CHANGE_TYPE_MODIFICATION", "BOT_DETECTION_RULE_CHANGE_TYPE_DELETION" ], "default": "BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN", "x-displayname": "Bot Detection Rule Change Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleChangeType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleChangeType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN\"", "example_yaml": "BOT_DETECTION_RULE_CHANGE_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfig": { "type": "object", "description": "Rule configuration.", "title": "BotDetectionRuleConfig", "x-displayname": "Rule configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfig", "properties": { "mitigation": { "type": "boolean", "description": "Mitigation - true(ON) / false(OFF)", "title": "Mitigation", "format": "boolean", "x-displayname": "Mitigation.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfigChange": { "type": "object", "description": "Bot Detection Rule Config Change.", "title": "BotDetectionRuleConfigChange", "x-displayname": "Bot Detection Rule Config Change.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChange", "properties": { "deploy_to": { "type": "array", "description": "Environments to which new rule configuration has to be deployed onto.", "title": "Deploy To", "items": { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" }, "x-displayname": "Deploy To", "x-f5xc-description-short": "Environments to which new rule configuration has to be deployed onto.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "desired_rule_config": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "desired_rule_config_per_bot_infra": { "type": "array", "title": "Desired Rule Configuration Per Bot Infra", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra" }, "x-displayname": "Desired Rule Configuration Per Bot Infra.", "description": "Rule or policy definition", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "existing_rule_config_per_bot_infra": { "type": "array", "title": "Existing Rule Configuration Per Bot Infra", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra" }, "x-displayname": "Existing Rule Configuration Per Bot Infra.", "description": "Rule or policy definition", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_modified_at": { "type": "string", "description": "Last Modified At as per SAPI's database.", "title": "Last Modified At", "format": "date-time", "x-displayname": "Last Modified At.", "x-f5xc-description-short": "Last Modified At as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChangeReason" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 43, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "rule_id": { "type": "string", "description": "Unique identifier for a bot detection rule as per SAPI's database.", "title": "Rule ID", "x-displayname": "Rule ID", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Unique identifier for a bot detection rule as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "rule_name": { "type": "string", "title": "Rule Name", "x-displayname": "Rule Name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfigChange", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfigChangeReason": { "type": "object", "description": "Reason for changing the bot detection rule configuration.", "title": "BotDetectionRuleConfigChangeReason", "x-displayname": "Bot Detection Rule Config Change Reason.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChangeReason", "properties": { "comments": { "type": "string", "description": "Comments are required when the reason type is selected as 'Other'", "title": "Comments", "x-displayname": "Comments", "x-f5xc-description-short": "Comments are required when the reason type is selected as 'Other'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reasons": { "type": "array", "description": "List of reasons why the rule configuration is changed.", "title": "Reasons", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChangeReasonType" }, "x-displayname": "Reasons", "x-f5xc-description-short": "List of reasons why the rule configuration is changed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Reason for changing the bot detection rule configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfigChangeReason", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfigChangeReasonType": { "type": "string", "description": "Reason type for changing the bot detection rule configuration.", "title": "BotDetectionRuleConfigChangeReasonType", "enum": [ "BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN", "BOT_DETECTION_RULE_CHANGE_REASON_FALSE_POSITIVE", "BOT_DETECTION_RULE_CHANGE_REASON_TRUE_POSITIVE", "BOT_DETECTION_RULE_CHANGE_REASON_TESTING", "BOT_DETECTION_RULE_CHANGE_REASON_OTHER" ], "default": "BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN", "x-displayname": "Bot Detection Rule Config Change Reason Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigChangeReasonType", "x-f5xc-description-short": "Reason type for changing the bot detection rule configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfigChangeReasonType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN\"", "example_yaml": "BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN\n..." }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfigDeploymentDetailsPerBotInfra": { "type": "object", "title": "BotDetectionRuleConfigDeploymentDetailsPerBotInfra", "x-displayname": "Rule configuration per bot infrastructure.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigDeploymentDetailsPerBotInfra", "properties": { "bot_detection_rule_config": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_infra_deployment_details": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfraDeploymentDetails" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfigDeploymentDetailsPerBotInfra", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleConfigPerBotInfra": { "type": "object", "description": "Bot detection rule configuration per bot infrastructure.", "title": "BotDetectionRuleConfigPerBotInfra", "x-displayname": "Bot detection rule configuration per bot infrastructure.", "x-ves-oneof-field-rule_config": "[\"bot_detection_rule_config\",\"k8s_cluster_rule_config\",\"region_rule_config\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleConfigPerBotInfra", "properties": { "bot_detection_rule_config": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster_rule_config", "region_rule_config" ] }, "bot_infra_id": { "type": "string", "description": "Bot Infrastructure ID as per SAPI's database.", "title": "Bot Infrastructure ID", "x-displayname": "Bot Infrastructure ID.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Bot Infrastructure ID as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "bot_infra_name": { "type": "string", "description": "Name of the bot infrastructure as per SAPI's database.", "title": "BotInfraName", "x-displayname": "Bot Infrastructure Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the bot infrastructure as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_infrastructure_type": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfrastuctureType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "environment_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "k8s_cluster_rule_config": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleK8sClusterRuleConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_detection_rule_config", "region_rule_config" ] }, "region_rule_config": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleRegionRuleConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_detection_rule_config", "k8s_cluster_rule_config" ] } }, "x-f5xc-description-short": "Bot detection rule configuration per bot infrastructure.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleConfigPerBotInfra", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRuleType": { "type": "string", "title": "BotDetectionRuleType", "enum": [ "BOT_DETECTION_RULE_TYPE_UNKNOWN", "BOT_DETECTION_RULE_TYPE_ENFORCED_BLOCKING", "BOT_DETECTION_RULE_TYPE_CONTROL_BLOCKING" ], "default": "BOT_DETECTION_RULE_TYPE_UNKNOWN", "x-displayname": "Bot Detection Rule Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRuleType", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRuleType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_DETECTION_RULE_TYPE_UNKNOWN\"", "example_yaml": "BOT_DETECTION_RULE_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRulesDeployment": { "type": "object", "description": "Bot detection rules deployment.", "title": "BotDetectionRulesDeployment", "x-displayname": "Bot Detection Rules Deployment.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRulesDeployment", "properties": { "bot_infrastructures": { "type": "array", "title": "Bot Infrastructures", "items": { "$ref": "#/components/schemas/threat_intelligenceBotInfrastructure" }, "x-displayname": "Bot Infrastructures.", "description": "Infrastructure configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "comments": { "type": "string", "description": "Comments provided by official for making the changes to rule configuration.", "title": "Comments", "x-displayname": "Comments", "x-f5xc-description-short": "Comments provided by official for making the changes to rule configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_id": { "type": "string", "description": "Unique identifier for a deployment batch.", "title": "Deployment Id", "x-displayname": "Deployment ID.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Unique identifier for a deployment batch.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_time": { "type": "string", "description": "Timestamp at which the deployment was initiated.", "title": "DeploymentTime", "format": "date-time", "x-displayname": "Deployment Time.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Timestamp at which the deployment was initiated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modified_by": { "type": "string", "description": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'", "title": "Modified By", "x-displayname": "Modified By.", "x-f5xc-description-short": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'", "x-f5xc-description-medium": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "number_of_rules": { "type": "integer", "title": "Number of rules", "format": "int64", "x-displayname": "Number of rules.", "description": "Rule or policy definition", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rules": { "type": "array", "description": "List of rules that went in the deployment.", "title": "Rules", "items": { "type": "string" }, "x-displayname": "Rules", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of rules that went in the deployment.", "x-f5xc-constraints": { "constraintType": "array", "category": "policy", "minItems": 0, "maxItems": 100, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_types": { "type": "array", "title": "Traffic Types", "items": { "$ref": "#/components/schemas/bot_infrastructureTrafficType" }, "x-displayname": "Traffic Types.", "description": "Configuration parameter for traffic types", "x-f5xc-description-short": "Configuration parameter for traffic types.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRulesDeployment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleBotDetectionRulesDeploymentStatus": { "type": "string", "description": "Deployment status of bot detection rule(s)\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch.", "title": "BotDetectionRulesDeploymentStatus", "enum": [ "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DRAFT", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DEPLOYED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_FAILED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_DISCARDED_DRAFT", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_INITIATION_FAILED", "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_PARTIALLY_INITIATED" ], "default": "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN", "x-displayname": "Bot Detection Rules Deployment Status.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.BotDetectionRulesDeploymentStatus", "x-f5xc-description-short": "Deployment status of bot detection rule(s) Initiated represents the status when SAPI returns successful deployment acknowledgement for all the...", "x-f5xc-description-medium": "Deployment status of bot detection rule(s) Initiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch Deployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch Failed...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleBotDetectionRulesDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN\"", "example_yaml": "BOT_DETECTION_RULES_DEPLOYMENT_STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleDeployBotDetectionRulesRequest": { "type": "object", "description": "Request for deploy bot detection rules.", "title": "DeployBotDetectionRulesRequest", "x-displayname": "Deploy Bot Detection Rules Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesRequest", "properties": { "comments": { "type": "string", "description": "Deployment Comments.", "title": "Comments", "x-displayname": "Comments", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "config_change_per_bot_detection_rule": { "type": "array", "description": "Config change per bot detection rules.", "title": "Config Change Per Bot Detection Rules", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange" }, "x-displayname": "Config Change Per Bot Detection Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "namespace", "minLength": 1, "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "system", "x-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" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleDeployBotDetectionRulesRequest", "required_fields": [ "config_change_per_bot_detection_rule", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"config_change_per_bot_detection_rule\": [\n {}\n ],\n \"namespace\": \"system\"\n}", "example_yaml": "config_change_per_bot_detection_rule:\n- {}\nnamespace: system" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleDeployBotDetectionRulesResponse": { "type": "object", "description": "Response for deploy bot detection rules.", "title": "DeployBotDetectionRulesResponse", "x-displayname": "Deploy Bot Detection Rules Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DeployBotDetectionRulesResponse", "properties": { "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for deploy bot detection rules.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleDeployBotDetectionRulesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleDraftRuleCounts": { "type": "object", "description": "Rule summary of bot detection rules in draft state.", "title": "Draft Rule Counts", "x-displayname": "Draft Rule Counts.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.DraftRuleCounts", "properties": { "total": { "type": "integer", "description": "Total number of rules.", "title": "Total", "format": "int64", "x-displayname": "Total", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Rule summary of bot detection rules in draft state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleDraftRuleCounts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleEnvironmentRuleCounts": { "type": "object", "description": "Rule summary of bot detection rules in per environment.", "title": "Environment Rule Counts", "x-displayname": "Environment Rule Counts.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.EnvironmentRuleCounts", "properties": { "mobile": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleRuleStateCounts" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleRuleStateCounts" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Rule summary of bot detection rules in per environment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleEnvironmentRuleCounts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetBotDetectionRuleChangeHistoryResponse": { "type": "object", "description": "Response for GET bot detection rule change history.", "title": "GetBotDetectionRuleChangeHistoryResponse", "x-displayname": "GET Bot Detection Rule Change History Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRuleChangeHistoryResponse", "properties": { "rule_changes": { "type": "array", "description": "Rule changes holds the details for changes made to a bot detection rule.", "title": "RuleChanges", "items": { "$ref": "#/components/schemas/bot_detection_ruleRuleChange" }, "x-displayname": "Rule Changes.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Rule changes holds the details for changes made to a bot detection rule.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for GET bot detection rule change history.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetBotDetectionRuleChangeHistoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetBotDetectionRulesDeploymentDetailsResponse": { "type": "object", "description": "Response for GET bot detection rules deployment deployment.", "title": "GetBotDetectionRulesDeploymentDetailsResponse", "x-displayname": "GET details of a bot detection rule(s) deployment response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDeploymentDetailsResponse", "properties": { "config_change_per_bot_detection_rule": { "type": "array", "description": "Config change per bot detection rule.", "title": "Config Change Per Bot Detection Rule", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange" }, "x-displayname": "Config Change Per Bot Detection Rule.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deploy_to": { "type": "array", "description": "Environments to which new rule configuration has to be deployed onto.", "title": "Deploy To", "items": { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" }, "x-displayname": "Deploy To", "x-f5xc-description-short": "Environments to which new rule configuration has to be deployed onto.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployed_by": { "type": "string", "description": "Deployed By.", "title": "Deployed By", "x-displayname": "Deployed By.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_details_per_bot_infra": { "type": "array", "description": "Deployment details per bot infrastructure.", "title": "DeploymentDetailsPerBotInfra", "items": { "$ref": "#/components/schemas/threat_intelligenceBotInfraDeploymentDetails" }, "x-displayname": "Deployment Details Per Bot Infrastructure.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Deployment details per bot infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRulesDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_time": { "type": "string", "description": "Timestamp at which the deployment was initiated.", "title": "DeploymentTime", "format": "date-time", "x-displayname": "Deployment Time.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Timestamp at which the deployment was initiated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for GET bot detection rules deployment deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetBotDetectionRulesDeploymentDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetBotDetectionRulesDeploymentsResponse": { "type": "object", "description": "Response for GET bot detection rules deployments.", "title": "GetBotDetectionRulesDeploymentsResponse", "x-displayname": "GET list of bot detection rule deployments response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDeploymentsResponse", "properties": { "bot_detection_rules_deployments": { "type": "array", "description": "List of bot detection rules deployments.", "title": "Deployments", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRulesDeployment" }, "x-displayname": "Deployments.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of bot detection rules deployments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for GET bot detection rules deployments.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetBotDetectionRulesDeploymentsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetBotDetectionRulesDraftResponse": { "type": "object", "description": "Response for GET bot detection rules draft.", "title": "GetBotDetectionRulesDraftResponse", "x-displayname": "GET bot detection rules draft response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesDraftResponse", "properties": { "comments": { "type": "string", "description": "Comments", "title": "Comments", "x-displayname": "Comments", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "config_change_per_bot_detection_rule": { "type": "array", "description": "Config change per bot detection rule.", "title": "Config Change Per Bot Detection Rule", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigChange" }, "x-displayname": "Config Change Per Bot Detection Rule.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for GET bot detection rules draft.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetBotDetectionRulesDraftResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetBotDetectionRulesSummaryResponse": { "type": "object", "description": "Response for GET bot detection rules summary.", "title": "GetBotDetectionRulesSummaryResponse", "x-displayname": "GET BotDetection Rules Summary Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetBotDetectionRulesSummaryResponse", "properties": { "rule_summary": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleRuleSummary" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for GET bot detection rules summary.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetBotDetectionRulesSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read bot_detection_rule", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligencebot_detection_ruleGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleK8sClusterRuleConfig": { "type": "object", "description": "Kubernetes cluster rule config.", "title": "K8sClusterRuleConfig", "x-displayname": "Kubernetes Cluster Rule Config.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.K8sClusterRuleConfig", "properties": { "in_used_k8s_cluster_rule_config": { "type": "object", "title": "In-Used Kubernetes Cluster Rule Config", "x-displayname": "In-Used Kubernetes Cluster Rule Config.", "description": "Cluster or grouping configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sync_status_per_k8s_cluster": { "type": "object", "title": "Sync status for k8s cluster", "x-displayname": "Sync Status.", "description": "Cluster or grouping configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "target_k8s_cluster_rule_config": { "type": "object", "title": "Target Kubernetes Cluster Rule Config", "x-displayname": "Target Kubernetes Cluster Rule Config.", "description": "Cluster or grouping configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleK8sClusterRuleConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of bot_detection_rule", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/bot_detection_ruleListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleListResponseItem": { "type": "object", "description": "By default a summary of bot_detection_rule is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of bot_detection_rule", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this bot_detection_rule.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this bot_detection_rule.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this bot_detection_rule.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this bot_detection_rule.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates bot_detection_rule is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates bot_detection_rule is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligencebot_detection_ruleGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this bot_detection_rule.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this bot_detection_rule.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this bot_detection_rule.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this bot_detection_rule.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this bot_detection_rule.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of bot_detection_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of bot_detection_rule is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleRegionRuleConfig": { "type": "object", "description": "Rule config per region.", "title": "RegionRuleConfig", "x-displayname": "Rule Config Per Region.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RegionRuleConfig", "properties": { "region_config": { "type": "object", "description": "Configuration settings and parameters", "title": "Rule Config Per Region", "x-displayname": "Rule Config Per Region.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.map.min_pairs": "1", "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.map.min_pairs": "1", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleRegionRuleConfig", "required_fields": [ "region_config" ], "mutually_exclusive_groups": [], "example_json": "{\n \"region_config\": {}\n}", "example_yaml": "region_config: {}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleRuleChange": { "type": "object", "description": "Rule change holds the details of the changes made to a bot detection rule.", "title": "RuleChange", "x-displayname": "Rule Change.", "x-ves-oneof-field-change": "[\"creation\",\"deletion\",\"modification\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleChange", "properties": { "change_type": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleChangeType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "changed_by": { "type": "string", "description": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'", "title": "Changed By", "x-displayname": "Changed By.", "x-f5xc-description-short": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'", "x-f5xc-description-medium": "EmailID of the official who made the change. In case the changed is made by F5 official, the value will be 'F5'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creation": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "deletion", "modification" ] }, "deletion": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "creation", "modification" ] }, "modification": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleRuleChangeTypeModification" } ], "x-f5xc-description-short": "Configuration parameter for modification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "creation", "deletion" ] }, "timestamp": { "type": "string", "description": "Timestamp at which the change was made.", "title": "Timestamp", "format": "date-time", "x-displayname": "Timestamp", "x-f5xc-example": "2025-01-15T10:30:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Rule change holds the details of the changes made to a bot detection rule.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleRuleChange", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleRuleChangeTypeModification": { "type": "object", "description": "Rule change type - Modification.", "title": "RuleChangeTypeModification", "x-displayname": "Rule change type - Modification.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleChangeTypeModification", "properties": { "comments": { "type": "string", "description": "Comments provided for when making changes to the configuration of a rule.", "title": "Comments", "x-displayname": "Comments", "x-f5xc-description-short": "Comments provided for when making changes to the configuration of a rule.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reasons": { "type": "array", "description": "List of reasons why the rule configuration was changed.", "title": "Reasons", "items": { "type": "string" }, "x-displayname": "Reasons", "x-f5xc-description-short": "List of reasons why the rule configuration was changed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_config_deployment_details_per_bot_infra": { "type": "array", "title": "Rule configuration deployment details per bot infrastructure", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigDeploymentDetailsPerBotInfra" }, "x-displayname": "Rule configuration deployment details per bot infrastructure.", "description": "Rule or policy definition", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleRuleChangeTypeModification", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleRuleStateCounts": { "type": "object", "description": "Rule summary of bot detection rules for per state.", "title": "Rule State Counts", "x-displayname": "Rule State Counts.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleStateCounts", "properties": { "off": { "type": "integer", "description": "Number of rules which are Off.", "title": "Off", "format": "int64", "x-displayname": "Off", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "on": { "type": "integer", "description": "Number of rules which are On.", "title": "On", "format": "int64", "x-displayname": "On", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Rule summary of bot detection rules for per state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleRuleStateCounts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleRuleSummary": { "type": "object", "description": "Rule summary of bot detection rules.", "title": "RuleSummary", "x-displayname": "Rule Summary.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.RuleSummary", "properties": { "draft": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleDraftRuleCounts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prod": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleEnvironmentRuleCounts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "test": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleEnvironmentRuleCounts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleRuleSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_detection_ruleSaveDraftResponse": { "type": "object", "description": "Response for save draft.", "title": "SaveDraftResponse", "x-displayname": "Save Draft Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.SaveDraftResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_ruleSaveDraftResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_infrastructureEnvironmentType": { "type": "string", "description": "Identifies the environment as either Production or Testing. Production environments have two infrastructure regions in an Active-Active configuration where traffic is routed equally between the two regions. Test environments have a single infrastructure region.\n\nProduction Protect live production applications and services from automated attacks.\nTest Evaluate new features, settings, and system performance.", "title": "EnvironmentType", "enum": [ "PRODUCTION", "TESTING" ], "default": "PRODUCTION", "x-displayname": "Environment Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.EnvironmentType", "x-f5xc-description-short": "Identifies the environment as either Production or Testing.", "x-f5xc-description-medium": "Identifies the environment as either Production or Testing. Production environments have two infrastructure regions in an Active-Active configuration where traffic is routed equally between the two regions. Test environments have a single infrastructure region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureEnvironmentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PRODUCTION\"", "example_yaml": "PRODUCTION\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureTrafficType": { "type": "string", "description": "The type of traffic that is routed to and processed by this infrastructure (Web or Mobile).\n\nOnly web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure.\nOnly mobile traffic from native mobile apps with the Bot Defense SDK are routed through this Bot Defense infrastructure.", "title": "TrafficType", "enum": [ "WEB", "MOBILE" ], "default": "WEB", "x-displayname": "Traffic Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.TrafficType", "x-f5xc-description-short": "The type of traffic that is routed to and processed by this infrastructure (Web or Mobile).", "x-f5xc-description-medium": "The type of traffic that is routed to and processed by this infrastructure (Web or Mobile). Only web traffic, including browser-based traffic from mobile devices, is routed through this Bot Defense infrastructure. Only mobile traffic from native mobile apps with the Bot Defense SDK are routed...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureTrafficType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"WEB\"", "example_yaml": "WEB\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "ioschemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceBotInfraDeploymentDetails": { "type": "object", "description": "Bot Infrastructure Deployment Details.", "title": "BotInfraDeploymentDetails", "x-displayname": "Bot Infrastructure Deployment Details.", "x-ves-oneof-field-status": "[\"bot_infra_status\",\"k8s_cluster_status\",\"region_status\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentDetails", "properties": { "bot_infra_name": { "type": "string", "description": "Name of the bot infrastructure as per SAPI's database.", "title": "BotInfraName", "x-displayname": "Bot Infrastructure Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the bot infrastructure as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_infra_status": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfraDeploymentStatusDetails" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_cluster_status", "region_status" ] }, "bot_infrastructure_type": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfrastuctureType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "environment": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" } ], "x-f5xc-description-short": "Configuration parameter for environment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "k8s_cluster_status": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceK8sClusterDeliveryStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_infra_status", "region_status" ] }, "region_status": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceRegionStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_infra_status", "k8s_cluster_status" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceBotInfraDeploymentDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceBotInfraDeploymentStatus": { "type": "string", "description": "Deployment status of bot-infrastructure\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for the cluster\nSuccess represents the status when SAPI's deployment status API returns success for the cluster\nFailed represents the status when SAPI's deployment status API returns failure for the cluster\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for the cluster.", "title": "BotInfraDeploymentStatus", "enum": [ "BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN", "BOT_INFRA_DEPLOYMENT_STATUS_INITIATED", "BOT_INFRA_DEPLOYMENT_STATUS_SUCCESS", "BOT_INFRA_DEPLOYMENT_STATUS_FAILED", "BOT_INFRA_DEPLOYMENT_STATUS_INITIATION_FAILED" ], "default": "BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN", "x-displayname": "Bot-Infra Deployment Status.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentStatus", "x-f5xc-description-short": "Deployment status of bot-infrastructure Initiated represents the status when SAPI returns successful deployment acknowledgement for the cluster...", "x-f5xc-description-medium": "Deployment status of bot-infrastructure Initiated represents the status when SAPI returns successful deployment acknowledgement for the cluster Success represents the status when SAPI's deployment status API returns success for the cluster Failed represents the status when SAPI's deployment...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceBotInfraDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN\"", "example_yaml": "BOT_INFRA_DEPLOYMENT_STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceBotInfraDeploymentStatusDetails": { "type": "object", "description": "Bot Infrastructure Deployment Status Details.", "title": "BotInfraDeploymentStatusDetails", "x-displayname": "Bot Infrastructure Deployment Status Details.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.BotInfraDeploymentStatusDetails", "properties": { "bot_infra_deployment_status": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfraDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_message": { "type": "string", "description": "Status message. In case of error, this would contain error details.", "title": "StatusMessage", "x-displayname": "Status Message.", "x-f5xc-description-short": "Status message. In case of error, this would contain error details.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot Infrastructure Deployment Status Details.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceBotInfraDeploymentStatusDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceBotInfrastructure": { "type": "object", "description": "Bot Infrastructure.", "title": "Bot Infrastructure", "x-displayname": "Bot Infrastructure.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.BotInfrastructure", "properties": { "environment_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the bot-infrastructure.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceBotInfrastructure", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceBotInfrastuctureType": { "type": "string", "description": "Type of the Bot Infrastructure\n\n- BOT_INFRA_TYPE_UNKNOWN: Unknown\n\n- BOT_INFRA_TYPE_CLOUD_HOSTED: F5 Cloud Hosted\n\n- BOT_INFRA_TYPE_HOSTED: F5 Hosted\n\n- BOT_INFRA_TYPE_ON_PREM: F5 On Premises\n\n- BOT_INFRA_TYPE_K8S_CLUSTER: Kubernetes Cluster.", "title": "BotInfrastructureType", "enum": [ "BOT_INFRA_TYPE_UNKNOWN", "BOT_INFRA_TYPE_CLOUD_HOSTED", "BOT_INFRA_TYPE_HOSTED", "BOT_INFRA_TYPE_ON_PREM", "BOT_INFRA_TYPE_K8S_CLUSTER" ], "default": "BOT_INFRA_TYPE_UNKNOWN", "x-displayname": "Bot Infrastructure Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.BotInfrastuctureType", "x-f5xc-description-short": "Type of the Bot Infrastructure - BOT_INFRA_TYPE_UNKNOWN: Unknown - BOT_INFRA_TYPE_CLOUD_HOSTED: F5 Cloud Hosted - BOT_INFRA_TYPE_HOSTED: F5 Hosted...", "x-f5xc-description-medium": "Type of the Bot Infrastructure - BOT_INFRA_TYPE_UNKNOWN: Unknown - BOT_INFRA_TYPE_CLOUD_HOSTED: F5 Cloud Hosted - BOT_INFRA_TYPE_HOSTED: F5 Hosted - BOT_INFRA_TYPE_ON_PREM: F5 On Premises - BOT_INFRA_TYPE_K8S_CLUSTER: Kubernetes Cluster.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceBotInfrastuctureType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BOT_INFRA_TYPE_UNKNOWN\"", "example_yaml": "BOT_INFRA_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceRegionStatus": { "type": "object", "description": "The status of each bot infrastructure per region.", "title": "Bot Infra Deployment Status Per Region", "x-displayname": "Bot Infra Deployment Status Per Region.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.RegionStatus", "properties": { "region_status_details": { "type": "object", "description": "Bot Infra Deployment Status Details Per Region.", "title": "Bot Infra Deployment Status Details Per Region", "x-displayname": "Bot Infra Deployment Status Details Per Region.", "x-f5xc-description-short": "Bot Infra Deployment Status Details Per Region.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The status of each bot infrastructure per region.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceRegionStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligencebot_detection_ruleGetSpecType": { "type": "object", "description": "GET Bot Detection Rule.", "title": "Get Bot Detection Rule", "x-displayname": "GET Bot Detection Rule.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_rule.GetSpecType", "properties": { "bot_detection_rule_configs_per_bot_infras": { "type": "array", "items": { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleConfigPerBotInfra" }, "x-displayname": "Rule configurations per Bot-Infras.", "description": "Rule or policy definition", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "classification": { "type": "array", "description": "Classification or category data", "items": { "type": "string" }, "x-displayname": "Classification.", "x-ves-example": "[\"environment\", \"execution\", \"timing\"]", "x-f5xc-example": "\"[\"environment\", \"execution\", \"timing\"]\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cluster_groups": { "type": "array", "description": "Cluster or grouping configuration", "items": { "type": "string" }, "x-displayname": "Cluster Groups.", "x-ves-example": "[Add to cart, login]", "x-f5xc-example": "[Add to cart, login]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "created_at": { "type": "string", "description": "Created at as per SAPI's database.", "format": "date-time", "x-displayname": "Created At.", "x-f5xc-example": "2025-01-15T10:30:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Human-readable description text", "x-displayname": "Description.", "x-ves-example": "Detection of signal payload.", "x-f5xc-example": "Detection of signal payload", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "last_modified_at": { "type": "string", "description": "Last modified at as per SAPI's database.", "format": "date-time", "x-displayname": "Last Modified At.", "x-f5xc-description-short": "Last modified at as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_modified_by": { "type": "string", "description": "Last Modified By as per SAPI's database.", "x-displayname": "Last Modified By.", "x-f5xc-description-short": "Last Modified By as per SAPI's database.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_name": { "type": "string", "description": "Human-readable name for the resource", "x-displayname": "Rule Name", "x-ves-example": "Rule_CB_DUBEXLDQKV.", "x-f5xc-example": "Rule_CB_DUBEXLDQKV", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_type": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_ruleBotDetectionRuleType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "integer", "description": "Version number or identifier", "format": "int64", "x-displayname": "Version", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 1, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligencebot_detection_ruleGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "threat_intelligenceK8sClusterDeliveryStatus": { "type": "object", "description": "Kubernetes Cluster Deliver Status.", "title": "Kubernetes Cluster Deliver Status", "x-displayname": "Kubernetes Cluster Deliver Status.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.K8sClusterDeliveryStatus", "properties": { "bot_infra_delivery_status": { "allOf": [ { "$ref": "#/components/schemas/threat_intelligenceBotInfraDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "generated_url": { "type": "string", "description": "Generated URL for the deployment.", "title": "Generated URL", "x-displayname": "Generated URL.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "k8s_cluster_tags": { "type": "array", "description": "List of K8s cluster_tag belongs the bot infra.", "title": "K8s Cluster Names", "items": { "type": "string" }, "x-displayname": "K8s Cluster Names.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of K8s cluster_tag belongs the bot infra.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_id": { "type": "string", "description": "Policy ID associated with the deployment.", "title": "Policy ID", "x-displayname": "Policy ID", "x-f5xc-description-short": "Policy ID associated with the deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "status_message": { "type": "string", "description": "Status message. In case of error, this would contain error details.", "title": "Status Message", "x-displayname": "Status Message.", "x-f5xc-description-short": "Status message. In case of error, this would contain error details.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for threat_intelligenceK8sClusterDeliveryStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateBotDetectionUpdate": { "type": "object", "description": "Bot detection update holds details of a new threat intelligence package deployment.", "title": "BotDetectionUpdate", "x-displayname": "Bot Detection Update.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.BotDetectionUpdate", "properties": { "bot_infrastructures": { "type": "array", "description": "Bot Infrastructure(s) impacted by the release if a new theat intelligence package.", "title": "Bot Infrastructures", "items": { "$ref": "#/components/schemas/threat_intelligenceBotInfrastructure" }, "x-displayname": "Bot Infrastructures.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Bot Infrastructure(s) impacted by the release if a new theat intelligence package.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_id": { "type": "string", "description": "Deployment ID is used to uniquely identify a deployment/scheduled deployment.", "title": "Deployment Id", "x-displayname": "Deployment ID.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Deployment ID is used to uniquely identify a deployment/scheduled deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deployment_range": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_updateDeploymentRange" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_updateThreatIntelligencePackageDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot detection update holds details of a new threat intelligence package deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateBotDetectionUpdate", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateDeploymentRange": { "type": "object", "description": "Deployment range holds the different types of deployment timing i.e deploy at a specific time, deploy within a time range, etc.", "title": "DeploymentRange", "x-displayname": "Deployment Range.", "x-ves-oneof-field-type": "[\"initiated_time\",\"time_range\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.DeploymentRange", "properties": { "initiated_time": { "type": "string", "description": "Exclusive with [time_range]\nTimestamp at which the deployment is initiated - Relevant when deployment status is 'Initiated', 'Initiation Failed', 'Partially Initiated', 'Deployed', 'Failed', 'Partially Deployed'", "title": "Initiated Time", "format": "date-time", "x-displayname": "Initiated Time.", "x-f5xc-description-short": "Exclusive with [time_range] Timestamp at which the deployment is initiated - Relevant when deployment status is 'Initiated', 'Initiation Failed'...", "x-f5xc-description-medium": "Exclusive with [time_range] Timestamp at which the deployment is initiated - Relevant when deployment status is 'Initiated', 'Initiation Failed', 'Partially Initiated', 'Deployed', 'Failed', 'Partially Deployed'.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "time_range" ] }, "time_range": { "allOf": [ { "$ref": "#/components/schemas/bot_detection_updateTimeRange" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "initiated_time" ] } }, "x-f5xc-description-short": "Deployment range holds the different types of deployment timing i.e deploy at a specific time, deploy within a time range, etc.", "x-f5xc-description-medium": "Deployment range holds the different types of deployment timing i.e deploy at a specific time, deploy within a time range, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateDeploymentRange", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateDownloadBotDetectionUpdatesReleaseNotesResponse": { "type": "object", "description": "Response for download bot detection updates release notes.", "title": "DownloadBotDetectionUpdatesReleaseNotesResponse", "x-displayname": "Download bot detection updates release notes response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.DownloadBotDetectionUpdatesReleaseNotesResponse", "properties": { "pre_signed_url": { "type": "string", "description": "Pre-Signed URL for the release notes PDF. The expiration of this URL is controlled by config.", "title": "Pre-Signed URL", "x-displayname": "Pre-Signed URL.", "x-f5xc-description-short": "Pre-Signed URL for the release notes PDF. The expiration of this URL is controlled by config.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for download bot detection updates release notes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateDownloadBotDetectionUpdatesReleaseNotesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateGetBotDetectionUpdatesResponse": { "type": "object", "description": "Response for GET bot detection updates.", "title": "GetBotDetectionUpdatesResponse", "x-displayname": "GET bot detection updates response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.GetBotDetectionUpdatesResponse", "properties": { "bot_detection_updates": { "type": "array", "description": "Bot detection updates holds details of a new threat intelligence package deployment.", "title": "Bot Detection Updates", "items": { "$ref": "#/components/schemas/bot_detection_updateBotDetectionUpdate" }, "x-displayname": "Bot Detection Updates.", "x-f5xc-description-short": "Bot detection updates holds details of a new threat intelligence package deployment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateGetBotDetectionUpdatesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateThreatIntelligencePackageDeploymentStatus": { "type": "string", "description": "Deployment status of a new threat intelligence package\n\nInitiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch\nDeployed represents the status when SAPI's deployment status API returns success for all the clusters within the batch\nFailed represents the status when SAPI's deployment status API returns failure for all the clusters within the batch\nPartially Deployed represents the status when SAPI's deployment status API returns success for some clusters while failure for other clusters within the batch\nInitiation failed represents the status when SAPI returns failed deployment acknowledgement for all the clusters within the batch\nPartially initiated represents the status when SAPI returns success deployment acknowledgement for some clusters while failed deployment acknowledgement for other clusters within the batch\nPending Submission represents the status when the threat intelligence package details are loaded into the database and before initiating the SAPI deployment.", "title": "ThreatIntelligencePackageDeploymentStatus", "enum": [ "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_INITIATED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_DEPLOYED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_FAILED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PARTIALLY_DEPLOYED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_INITIATION_FAILED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PARTIALLY_INITIATED", "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_PENDING_SUBMISSION" ], "default": "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN", "x-displayname": "Threat Intelligence Package Deployment Status.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.ThreatIntelligencePackageDeploymentStatus", "x-f5xc-description-short": "Deployment status of a new threat intelligence package Initiated represents the status when SAPI returns successful deployment acknowledgement for...", "x-f5xc-description-medium": "Deployment status of a new threat intelligence package Initiated represents the status when SAPI returns successful deployment acknowledgement for all the clusters within the batch Deployed represents the status when SAPI's deployment status API returns success for all the clusters within the...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateThreatIntelligencePackageDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN\"", "example_yaml": "THREAT_INTELLIGENCE_PACKAGE_DEPLOYMENT_STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_detection_updateTimeRange": { "type": "object", "description": "Time range holds the start time and end time.", "title": "TimeRange", "x-displayname": "Time Range.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.bot_detection_update.TimeRange", "properties": { "end_time": { "type": "string", "title": "End Time", "format": "date-time", "x-displayname": "End Time", "description": "Configuration parameter for end time", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "x-displayname": "Start Time.", "description": "Configuration parameter for start time", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Time range holds the start time and end time.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_detection_updateTimeRange", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseBlockActionHttpStatusCode": { "type": "string", "description": "HTTP response status codes for block action\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nSwitching Protocols status code\nProcessing (WebDAV) status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIM Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nURI Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\n418 I'm a teapot (RFC 2324) status code\nEnhance Your Calm (Twitter) status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nReserved for WebDAV status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nNo Response (NGINX) status code\nRetry With (Microsoft) status code\nRetry With (Microsoft) status code\nUnavailable For Legal Reasons status code\nClient Closed Request (NGINX) status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHTTP Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nBandwidth Limit Exceeded (Apache) status code\nNot Extended status code\nNetwork Authentication Required status code\nNetwork read timeout error status code\nNetwork Connect Timeout Error status code.", "title": "HttpStatusCode for block action", "enum": [ "EmptyStatusCode", "Continue", "SwitchingProtocols", "Processing", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "PayloadTooLarge", "URITooLong", "UnsupportedMediaType", "RangeNotSatisfiable", "ExpectationFailed", "TeaPot", "EnhanceYourCalm", "UnprocessableEntity", "Locked", "FailedDependency", "ReservedforWebDAV", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "NoResponse", "RetryWith", "Blockedby", "UnavailableForLegalReasons", "ClientClosedRequest", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HTTPVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "BandwidthLimitExceeded", "NotExtended", "NetworkAuthenticationRequired", "NetworkReadRimeoutError", "NetworkConnectTimeoutError" ], "default": "EmptyStatusCode", "x-displayname": "HTTP Status Code.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.BlockActionHttpStatusCode", "x-f5xc-description-short": "HTTP response status codes for block action EmptyStatusCode response codes means it is not specified Continue status code Switching Protocols...", "x-f5xc-description-medium": "HTTP response status codes for block action EmptyStatusCode response codes means it is not specified Continue status code Switching Protocols status code Processing (WebDAV) status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseBlockActionHttpStatusCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EmptyStatusCode\"", "example_yaml": "EmptyStatusCode\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseComparisonOperator": { "type": "string", "description": "Select from one of the Comparison Operator.\n\n- EXACT: exact value\n\n- CONTAIN: contain value\n\n- START_WITH: start with value\n\n- END_WITH: end with value.", "title": "Domain Comparison Operator", "enum": [ "EXACT", "CONTAIN", "START_WITH", "END_WITH" ], "default": "EXACT", "x-displayname": "Comparison Operator.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.ComparisonOperator", "x-f5xc-description-short": "Select from one of the Comparison Operator. - EXACT: exact value - CONTAIN: contain value - START_WITH: start with value - END_WITH: end with value.", "x-f5xc-description-medium": "Select from one of the Comparison Operator. - EXACT: exact value - CONTAIN: contain value - START_WITH: start with value - END_WITH: end with value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseComparisonOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EXACT\"", "example_yaml": "EXACT\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieDefinition": { "type": "object", "description": "Cookie name and description records for endpoint policies.", "title": "Cookie Definition", "x-displayname": "Cookies", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieDefinition", "properties": { "description": { "type": "string", "description": "Human‐readable explanation of what the cookie does.", "title": "Cookie Description", "x-displayname": "Description.", "x-f5xc-description-short": "Human‐readable explanation of what the cookie does.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "The name of the cookie.", "title": "Cookie Name", "x-displayname": "Name", "x-ves-validation-rules": { "ves.io.schema.rules.string.cookie_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.cookie_name": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Cookie name and description records for endpoint policies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieDefinition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieMatcher": { "type": "object", "description": "Cookie matcher Choice.", "title": "Cookie Matcher", "x-displayname": "Cookie Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieMatcher", "properties": { "cookie_match_v2": { "type": "array", "description": "Cookie Matchers.", "title": "Cookie Matchers", "items": { "$ref": "#/components/schemas/bot_defenseCookieMatcherTypeV2" }, "x-displayname": "Cookie Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieMatcher", "required_fields": [ "cookie_match_v2" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cookie_match_v2\": [\n {\n \"value\": \"value\"\n }\n ]\n}", "example_yaml": "cookie_match_v2:\n- value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieMatcherTypeV2": { "type": "object", "title": "Cookie Matcher Type", "x-displayname": "Cookie Matcher Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieMatcherTypeV2", "properties": { "case_sensitive": { "type": "boolean", "title": "Case sensitive", "format": "boolean", "x-displayname": "Case Sensitive.", "description": "Configuration parameter for case sensitive", "x-f5xc-description-short": "Configuration parameter for case sensitive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not": { "type": "boolean", "title": "Check not", "format": "boolean", "x-displayname": "Not(!)", "description": "Configuration parameter for not", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operator": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Response Header Matcher Value", "minLength": 1, "maxLength": 256, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieMatcherTypeV2", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieOperator": { "type": "object", "description": "Cookie matcher choice.", "title": "Cookies Operator", "x-displayname": "Cookies Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieOperator", "properties": { "cookie_operator": { "type": "array", "description": "Configuration parameter for cookie operator", "title": "Cookies", "items": { "$ref": "#/components/schemas/bot_defenseCookieV2" }, "x-displayname": "Cookies", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Configuration parameter for cookie operator.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieOperator", "required_fields": [ "cookie_operator" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cookie_operator\": [\n {\n \"name\": \"example-resource\"\n }\n ]\n}", "example_yaml": "cookie_operator:\n- name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieOperatorChoice": { "type": "object", "description": "Operator", "title": "Operator", "x-displayname": "Operator", "x-ves-oneof-field-cookiechoice": "[\"cookie_and\",\"cookie_anything\",\"cookie_none\",\"cookie_not_present\",\"cookie_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieOperatorChoice", "properties": { "cookie_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookie_anything", "cookie_none", "cookie_not_present", "cookie_or" ] }, "cookie_anything": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for cookie anything.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookie_and", "cookie_none", "cookie_not_present", "cookie_or" ] }, "cookie_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieMatcher" } ], "x-f5xc-description-short": "Configuration parameter for cookie none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookie_and", "cookie_anything", "cookie_not_present", "cookie_or" ] }, "cookie_not_present": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for cookie not present.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookie_and", "cookie_anything", "cookie_none", "cookie_or" ] }, "cookie_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookie_and", "cookie_anything", "cookie_none", "cookie_not_present" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieOperatorChoice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookieV2": { "type": "object", "title": "Cookie", "x-displayname": "Cookie", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.CookieV2", "properties": { "cookie": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieOperatorChoice" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Operator Name.", "title": "Operator Name", "x-displayname": "Cookie Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.cookie_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.cookie_name": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookieV2", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-resource\"\n}", "example_yaml": "name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseCookies": { "type": "object", "title": "Cookies", "x-displayname": "Cookies", "x-ves-displayorder": "1", "x-ves-oneof-field-cookieschoice": "[\"cookies_all\",\"cookies_and\",\"cookies_none\",\"cookies_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.Cookies", "properties": { "cookies_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for cookies all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookies_and", "cookies_none", "cookies_or" ] }, "cookies_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieOperator" } ], "x-f5xc-description-short": "Configuration parameter for cookies and.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookies_all", "cookies_none", "cookies_or" ] }, "cookies_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieOperator" } ], "x-f5xc-description-short": "Configuration parameter for cookies none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookies_all", "cookies_and", "cookies_or" ] }, "cookies_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookieOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cookies_all", "cookies_and", "cookies_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseCookies", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseDeploymentMode": { "type": "string", "description": "Deployment Mode\n\nBy default, the mode will be Reverse Proxy\nYou need to submit an XC support ticket to request for API mode.", "title": "DeploymentMode", "enum": [ "REVERSE_PROXY", "API_MODE" ], "default": "REVERSE_PROXY", "x-displayname": "Deployment Mode.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.DeploymentMode", "x-f5xc-description-short": "Deployment Mode By default, the mode will be Reverse Proxy You need to submit an XC support ticket to request for API mode.", "x-f5xc-description-medium": "Deployment Mode By default, the mode will be Reverse Proxy You need to submit an XC support ticket to request for API mode.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseDeploymentMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"REVERSE_PROXY\"", "example_yaml": "REVERSE_PROXY\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseDomainMatcher": { "type": "object", "description": "Domain matcher Choice.", "title": "Domain Matcher", "x-displayname": "Domain Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.DomainMatcher", "properties": { "domain_match": { "type": "array", "description": "Domain Matchers.", "title": "Domain Matchers", "items": { "$ref": "#/components/schemas/shapebot_defenseDomainMatcherType" }, "x-displayname": "Domain Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseDomainMatcher", "required_fields": [ "domain_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain_match\": [\n {\n \"value\": \"value\"\n }\n ]\n}", "example_yaml": "domain_match:\n- value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseDomainOperator": { "type": "object", "description": "Domain Operators.", "title": "Domain Operators", "x-displayname": "Operator", "x-ves-displayorder": "1", "x-ves-oneof-field-domain_operator_choice": "[\"all_domain\",\"domain_and\",\"domain_none\",\"domain_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.DomainOperator", "properties": { "all_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain_and", "domain_none", "domain_or" ] }, "domain_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDomainMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_domain", "domain_none", "domain_or" ] }, "domain_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDomainMatcher" } ], "x-f5xc-description-short": "Configuration parameter for domain none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_domain", "domain_and", "domain_or" ] }, "domain_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDomainMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_domain", "domain_and", "domain_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseDomainOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseHeaderMatcher": { "type": "object", "description": "A list of Header Matcher.", "title": "Header Matchers", "x-displayname": "Request Body Matcher(s)", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.HeaderMatcher", "properties": { "header_match": { "type": "array", "description": "Header Matchers.", "title": "Header Matchers", "items": { "$ref": "#/components/schemas/bot_defenseMatcherType" }, "x-displayname": "Header Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseHeaderMatcher", "required_fields": [ "header_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"header_match\": [\n {}\n ]\n}", "example_yaml": "header_match:\n- {}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseHeaderNameValuePair": { "type": "object", "title": "Header Name and Value Pair", "x-displayname": "Header Name and Value Pairs.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.HeaderNameValuePair", "properties": { "header_name": { "type": "string", "description": "Enter the Header Name.", "title": "Header Name", "x-displayname": "Header", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "header_value": { "type": "string", "description": "Enter the Header Value.", "title": "Header Value", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseHeaderNameValuePair", "required_fields": [ "header_name", "header_value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"header_name\": \"example-resource\",\n \"header_value\": \"value\"\n}", "example_yaml": "header_name: example-resource\nheader_value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseHeaderOperator": { "type": "object", "description": "Header Operators.", "title": "Header Operators", "x-displayname": "Operator", "x-ves-oneof-field-header_operator_choice": "[\"all_header\",\"header_and\",\"header_none\",\"header_or\",\"not_present_header\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.HeaderOperator", "properties": { "all_header": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderOperatorEmptyType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_and", "header_none", "header_or", "not_present_header" ] }, "header_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_header", "header_none", "header_or", "not_present_header" ] }, "header_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderMatcher" } ], "x-f5xc-description-short": "Configuration parameter for header none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_header", "header_and", "header_or", "not_present_header" ] }, "header_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_header", "header_and", "header_none", "not_present_header" ] }, "name": { "type": "string", "description": "Operator Name.", "title": "Operator Name", "x-displayname": "Name", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "not_present_header": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderOperatorEmptyType" } ], "x-f5xc-description-short": "Configuration parameter for not present header.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_header", "header_and", "header_none", "header_or" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseHeaderOperator", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-resource\"\n}", "example_yaml": "name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseHeaderOperatorChoice": { "type": "object", "description": "Operator", "title": "Operator", "x-displayname": "Operator", "x-ves-displayorder": "1", "x-ves-oneof-field-header_operator_choice": "[\"header_and\",\"header_anything\",\"header_none\",\"header_not_present\",\"header_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.HeaderOperatorChoice", "properties": { "header_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_anything", "header_none", "header_not_present", "header_or" ] }, "header_anything": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for header anything.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_and", "header_none", "header_not_present", "header_or" ] }, "header_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderMatcher" } ], "x-f5xc-description-short": "Configuration parameter for header none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_and", "header_anything", "header_not_present", "header_or" ] }, "header_not_present": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for header not present.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_and", "header_anything", "header_none", "header_or" ] }, "header_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "header_and", "header_anything", "header_none", "header_not_present" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseHeaderOperatorChoice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseHeaderOperatorEmptyType": { "type": "object", "description": "This can be used for the header operator choice where no values are needed.", "title": "Header Operator Empty Type", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.HeaderOperatorEmptyType", "x-f5xc-description-short": "Can be used for the header operator choice where no values are needed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseHeaderOperatorEmptyType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseKnownBotAllowDenyActionType": { "type": "object", "title": "KnownBotAllowDenyActionType", "x-displayname": "Known Bot Allow And/Or Deny Action Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.KnownBotAllowDenyActionType", "properties": { "allow_list": { "type": "array", "description": "Select Known Bots to allow to proceed to the origin.", "title": "Allow List", "items": { "type": "string" }, "x-displayname": "Allow Known Bots.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select Known Bots to allow to proceed to the origin.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deny_list": { "type": "array", "description": "Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.", "title": "Deny List", "items": { "type": "string" }, "x-displayname": "Deny Known Bots.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform).", "x-f5xc-description-medium": "Deny list actions will only take effect when the Mitigation Action above is set (e.g., block, redirect, transform). If mitigation action above is set to Continue, Known bots will be flagged.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "text_block": { "type": "string", "title": "All others text_block", "x-displayname": "All others (not in Allow or Deny)", "description": "Blocking or denial configuration", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseKnownBotAllowDenyActionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseMatcherType": { "type": "object", "description": "Matcher", "title": "Matcher Type", "x-displayname": "Matcher", "x-ves-oneof-field-match_type_choice": "[\"contain_value\",\"end_with_value\",\"exact_value\",\"start_with_value\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.MatcherType", "properties": { "contain_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for contain value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "end_with_value", "exact_value", "start_with_value" ] }, "end_with_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for end with value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "exact_value", "start_with_value" ] }, "exact_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for exact value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "end_with_value", "start_with_value" ] }, "start_with_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for start with value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "end_with_value", "exact_value" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseMatcherType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseMatcherValue": { "type": "object", "description": "Atcher Value.", "title": "Matcher Value", "x-displayname": "Value", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.MatcherValue", "properties": { "case_insensitive": { "type": "boolean", "description": "Case insensitive checker.", "title": "Check case insensitive", "format": "boolean", "x-displayname": "Case-Insensitive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not": { "type": "boolean", "description": "Not checker.", "title": "Check not", "format": "boolean", "x-displayname": "Not(!)", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Query Matcher Value.", "title": "Query Matcher Value", "minLength": 1, "maxLength": 256, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseMatcherValue", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseNegationOperator": { "type": "string", "description": "Select from one of the Negation Operator.\n\n- NO: No\n\n- YES: Yes.", "title": "Domain Negation Operator", "enum": [ "NO", "YES" ], "default": "NO", "x-displayname": "Negation Operator.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.NegationOperator", "x-f5xc-description-short": "Select from one of the Negation Operator. - NO: No - YES: Yes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseNegationOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NO\"", "example_yaml": "'NO'" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensePathMatcher": { "type": "object", "description": "A list of Path Matcher.", "title": "Path Matchers", "x-displayname": "Path Matcher(s)", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.PathMatcher", "properties": { "path_match": { "type": "array", "description": "Path Matchers.", "title": "Path Matchers", "items": { "$ref": "#/components/schemas/shapebot_defensePathMatcherType" }, "x-displayname": "Path Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensePathMatcher", "required_fields": [ "path_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"path_match\": [\n {}\n ]\n}", "example_yaml": "path_match:\n- {}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensePathMatcherValue": { "type": "object", "description": "Path Matcher Value.", "title": "Path Matcher Value", "x-displayname": "Value", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.PathMatcherValue", "properties": { "case_insensitive": { "type": "boolean", "description": "Case insensitive checker.", "title": "Check case insensitive", "format": "boolean", "x-displayname": "Case-Insensitive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not": { "type": "boolean", "description": "Not checker.", "title": "Check not", "format": "boolean", "x-displayname": "Not(!)", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Path Matcher Value.", "title": "Path Matcher Value", "minLength": 1, "maxLength": 2048, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensePathMatcherValue", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensePathOperator": { "type": "object", "description": "Path Operators.", "title": "Path Operators", "x-displayname": "Operator", "x-ves-displayorder": "1", "x-ves-oneof-field-path_operator_choice": "[\"all_path\",\"path_and\",\"path_none\",\"path_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.PathOperator", "properties": { "all_path": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "path_and", "path_none", "path_or" ] }, "path_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_path", "path_none", "path_or" ] }, "path_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_path", "path_and", "path_or" ] }, "path_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_path", "path_and", "path_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensePathOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensePolicyVersion": { "type": "object", "description": "Policy version.", "title": "PolicyVersion", "x-displayname": "Policy Version.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.PolicyVersion", "properties": { "bot_infras_name": { "type": "array", "description": "Bot Infrastructure Name.", "title": "Bot Infrastructure Name", "items": { "type": "string" }, "x-displayname": "Bot Infrastructure.", "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "update_time": { "type": "string", "description": "Policy last updated time.", "title": "Last Updated", "format": "date-time", "x-displayname": "Last Updated.", "x-ves-example": "2021-09-21:44:34.171543432Z.", "x-f5xc-example": "2021-09-21:44:34.171543432Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "update_user": { "type": "string", "description": "Last Modified By the user email.", "title": "Last Modified By", "x-displayname": "Last Modified By.", "x-ves-example": "[Services] F5 or dana@example.com.", "x-f5xc-example": "[Services] F5 or dana@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version_number": { "type": "string", "description": "Policy Version Number.", "title": "Policy Version Number", "x-displayname": "Version", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version_status": { "type": "string", "description": "Version status: in use, published, not published.", "title": "Policy Version status", "x-displayname": "Policy Version Status.", "x-f5xc-description-short": "Version status: in use, published, not published.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensePolicyVersion", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseProtectedEndpoints": { "type": "object", "description": "Configures Endpoint Policy Content.", "title": "Endpoint Policy Content", "x-displayname": "Protected Endpoint.", "x-ves-displayorder": "4,1", "x-ves-oneof-field-endpoint_type_choice": "[\"protected_mobile_endpoints\",\"protected_web_endpoints\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ProtectedEndpoints", "properties": { "js_download_path": { "type": "string", "description": "Web client will fetch F5 Client JavaScript from this path.\nThis path must not conflict with any other website/application paths.", "title": "JavaScript Download Path", "x-displayname": "Web Client JavaScript Path.", "x-ves-example": "/common.js?single.", "x-f5xc-example": "/common.js?single", "x-f5xc-description-short": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "x-f5xc-description-medium": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protected_mobile_endpoints": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseProtectedMobileEndpointList" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "protected_web_endpoints" ] }, "protected_web_endpoints": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseProtectedWebEndpointList" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "protected_mobile_endpoints" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseProtectedEndpoints", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseProtectedMobileEndpoint": { "type": "object", "description": "Protected Application Endpoint.", "title": "ProtectedMobileEndpoint", "x-displayname": "Protected Mobile Endpoints.", "x-ves-displayorder": "1,16,3,4,5,19,21,22,23,8,30,9", "x-ves-oneof-field-known_bot_controls_action_type": "[\"allow_deny\",\"regular_request\"]", "x-ves-oneof-field-mobile_client_action_type": "[\"block\",\"continue\",\"transform\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ProtectedMobileEndpoint", "properties": { "allow_deny": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseKnownBotAllowDenyActionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regular_request" ] }, "block": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientBlockMitigationActionType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue", "transform" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientContinueMitigationActionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block", "transform" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDomainOperator" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "flow_label_choice": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelCategoriesChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "header": { "type": "array", "description": "Header matcher.", "title": "Header", "items": { "$ref": "#/components/schemas/bot_defenseHeaderOperator" }, "x-displayname": "Header", "x-f5xc-constraints": { "constraintType": "array", "category": "http", "minItems": 0, "maxItems": 50, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_methods": { "type": "array", "description": "List of HTTP methods.", "title": "HTTP Methods", "minItems": 1, "maxItems": 9, "items": { "$ref": "#/components/schemas/schemaBotPolicyHttpMethod" }, "x-displayname": "HTTP Methods.", "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.max_items": "9", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.max_items": "9", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 9, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathOperator" } ], "x-f5xc-example": "/api/v1/resources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "query": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseQueryOperator" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "regular_request": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for regular request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_deny" ] }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseRequestBodyOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transaction_result_criteria": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseTransactionResult" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transform": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientTransformMitigationActionChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block", "continue" ] }, "usernames": { "type": "array", "description": "Add the field name where you store username on the Request Body.", "title": "Username Reporting", "maxItems": 64, "items": { "$ref": "#/components/schemas/bot_defenseUserNameType" }, "x-displayname": "Username Reporting.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Add the field name where you store username on the Request Body.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseProtectedMobileEndpoint", "required_fields": [ "http_methods" ], "mutually_exclusive_groups": [], "example_json": "{\n \"http_methods\": [\n \"BP_METHOD_GET\"\n ]\n}", "example_yaml": "http_methods:\n- BP_METHOD_GET" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseProtectedMobileEndpointList": { "type": "object", "description": "Protected Mobile Endpoints List.", "title": "Protected Mobile Endpoints List", "x-displayname": "Protected Mobile Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ProtectedMobileEndpointList", "properties": { "protected_mobile_endpoints": { "type": "array", "description": "Endpoint or connection point", "title": "Protected Mobile Endpoints List", "items": { "$ref": "#/components/schemas/bot_defenseProtectedMobileEndpoint" }, "x-displayname": "Protected Endpoints.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseProtectedMobileEndpointList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseProtectedWebEndpoint": { "type": "object", "description": "Protected Application Endpoint.", "title": "ProtectedWebEndpoint", "x-displayname": "Protected Web Endpoints.", "x-ves-displayorder": "1,18,3,4,5,19,20,22,23,8,30,9", "x-ves-oneof-field-known_bot_controls_action_type": "[\"allow_deny\",\"regular_request\"]", "x-ves-oneof-field-web_client_action_type": "[\"block\",\"continue\",\"redirect\",\"transform\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ProtectedWebEndpoint", "properties": { "allow_deny": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseKnownBotAllowDenyActionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regular_request" ] }, "block": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientBlockMitigationActionType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue", "redirect", "transform" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientContinueMitigationActionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block", "redirect", "transform" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDomainOperator" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "flow_label_choice": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelCategoriesChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "header": { "type": "array", "description": "Header matcher.", "title": "Header", "items": { "$ref": "#/components/schemas/bot_defenseHeaderOperator" }, "x-displayname": "Header", "x-f5xc-constraints": { "constraintType": "array", "category": "http", "minItems": 0, "maxItems": 50, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_methods": { "type": "array", "description": "List of HTTP methods.", "title": "HTTP Methods", "minItems": 1, "maxItems": 9, "items": { "$ref": "#/components/schemas/schemaBotPolicyHttpMethod" }, "x-displayname": "HTTP Methods.", "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.max_items": "9", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.max_items": "9", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 9, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathOperator" } ], "x-f5xc-example": "/api/v1/resources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "query": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseQueryOperator" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "redirect": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientRedirectMitigationActionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block", "continue", "transform" ] }, "regular_request": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for regular request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "allow_deny" ] }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseRequestBodyOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transaction_result_criteria": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseTransactionResult" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transform": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientTransformMitigationActionChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block", "continue", "redirect" ] }, "usernames": { "type": "array", "description": "Add the field name where you store username on the Request Body.", "title": "Username Reporting", "maxItems": 64, "items": { "$ref": "#/components/schemas/bot_defenseUserNameType" }, "x-displayname": "Username Reporting.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Add the field name where you store username on the Request Body.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseProtectedWebEndpoint", "required_fields": [ "http_methods" ], "mutually_exclusive_groups": [], "example_json": "{\n \"http_methods\": [\n \"BP_METHOD_GET\"\n ]\n}", "example_yaml": "http_methods:\n- BP_METHOD_GET" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseProtectedWebEndpointList": { "type": "object", "description": "Protected Web Endpoints List.", "title": "Protected Web Endpoints List", "x-displayname": "Protected Web Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ProtectedWebEndpointList", "properties": { "protected_web_endpoints": { "type": "array", "description": "Endpoint or connection point", "title": "Protected Web Endpoints List", "items": { "$ref": "#/components/schemas/bot_defenseProtectedWebEndpoint" }, "x-displayname": "Protected Endpoints.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseProtectedWebEndpointList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseQueryMatcher": { "type": "object", "description": "A list of Query Matcher.", "title": "Query Matchers", "x-displayname": "Query Matcher(s)", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.QueryMatcher", "properties": { "query_match": { "type": "array", "description": "Query Matchers.", "title": "Query Matchers", "items": { "$ref": "#/components/schemas/bot_defenseMatcherType" }, "x-displayname": "Query Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseQueryMatcher", "required_fields": [ "query_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"query_match\": [\n {}\n ]\n}", "example_yaml": "query_match:\n- {}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseQueryOperator": { "type": "object", "description": "Query Operators.", "title": "Query Operators", "x-displayname": "Operator", "x-ves-displayorder": "1", "x-ves-oneof-field-query_operator_choice": "[\"all_query\",\"query_and\",\"query_none\",\"query_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.QueryOperator", "properties": { "all_query": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "query_and", "query_none", "query_or" ] }, "query_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseQueryMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_query", "query_none", "query_or" ] }, "query_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseQueryMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_query", "query_and", "query_or" ] }, "query_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseQueryMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_query", "query_and", "query_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseQueryOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseRequestBodyMatcher": { "type": "object", "description": "A list of RequestBody Matcher.", "title": "RequestBody Matchers", "x-displayname": "Request Body Matcher(s)", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.RequestBodyMatcher", "properties": { "request_body_match": { "type": "array", "description": "RequestBody Matchers.", "title": "RequestBody Matchers", "items": { "$ref": "#/components/schemas/bot_defenseMatcherType" }, "x-displayname": "Request Body Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseRequestBodyMatcher", "required_fields": [ "request_body_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"request_body_match\": [\n {}\n ]\n}", "example_yaml": "request_body_match:\n- {}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseRequestBodyOperator": { "type": "object", "description": "RequestBody Operators.", "title": "RequestBody Operators", "x-displayname": "Operator", "x-ves-displayorder": "1", "x-ves-oneof-field-request_body_operator_choice": "[\"all_request_body\",\"request_body_and\",\"request_body_none\",\"request_body_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.RequestBodyOperator", "properties": { "all_request_body": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "request_body_and", "request_body_none", "request_body_or" ] }, "request_body_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseRequestBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_request_body", "request_body_none", "request_body_or" ] }, "request_body_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseRequestBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_request_body", "request_body_and", "request_body_or" ] }, "request_body_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseRequestBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_request_body", "request_body_and", "request_body_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseRequestBodyOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseBody": { "type": "object", "title": "Response Body", "x-displayname": "Response Body.", "x-ves-displayorder": "1", "x-ves-oneof-field-responsebodychoice": "[\"responseBody_all\",\"responseBody_and\",\"responseBody_none\",\"responseBody_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseBody", "properties": { "responseBody_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseBody_and", "responseBody_none", "responseBody_or" ] }, "responseBody_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseBody_all", "responseBody_none", "responseBody_or" ] }, "responseBody_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseBody_all", "responseBody_and", "responseBody_or" ] }, "responseBody_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseBodyMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseBody_all", "responseBody_and", "responseBody_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseBody", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseBodyMatcher": { "type": "object", "description": "Response Body matcher Choice.", "title": "Response Body Matcher", "x-displayname": "Response Body Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseBodyMatcher", "properties": { "response_body_match_v2": { "type": "array", "description": "Response Body Matchers.", "title": "Response Body Matchers", "items": { "$ref": "#/components/schemas/bot_defenseResponseBodyMatcherTypeV2" }, "x-displayname": "Response Body Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseBodyMatcher", "required_fields": [ "response_body_match_v2" ], "mutually_exclusive_groups": [], "example_json": "{\n \"response_body_match_v2\": [\n {\n \"value\": \"value\"\n }\n ]\n}", "example_yaml": "response_body_match_v2:\n- value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseBodyMatcherTypeV2": { "type": "object", "title": "Response Body Matcher Type", "x-displayname": "Response Body Matcher Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseBodyMatcherTypeV2", "properties": { "case_sensitive": { "type": "boolean", "title": "Case sensitive", "format": "boolean", "x-displayname": "Case Sensitive.", "description": "Configuration parameter for case sensitive", "x-f5xc-description-short": "Configuration parameter for case sensitive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not": { "type": "boolean", "title": "Check not", "format": "boolean", "x-displayname": "Not(!)", "description": "Configuration parameter for not", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operator": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Response Body Matcher Value", "minLength": 1, "maxLength": 256, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseBodyMatcherTypeV2", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseCode": { "type": "object", "title": "response code", "x-displayname": "Response Code.", "x-ves-displayorder": "1", "x-ves-oneof-field-responsecodechoice": "[\"responseCode_all\",\"responseCode_and\",\"responseCode_none\",\"responseCode_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseCode", "properties": { "responseCode_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseCode_and", "responseCode_none", "responseCode_or" ] }, "responseCode_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseCodeMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseCode_all", "responseCode_none", "responseCode_or" ] }, "responseCode_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseCodeMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseCode_all", "responseCode_and", "responseCode_or" ] }, "responseCode_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseCodeMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "responseCode_all", "responseCode_and", "responseCode_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseCodeMatcher": { "type": "object", "description": "Response Header matcher choice.", "title": "Response Code Matcher", "x-displayname": "Response Code Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseCodeMatcher", "properties": { "responseCode_match": { "type": "array", "description": "Response Code Matchers.", "title": "Response Code Matchers", "items": { "$ref": "#/components/schemas/bot_defenseResponseCodeMatcherType" }, "x-displayname": "Response Code Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseCodeMatcher", "required_fields": [ "responseCode_match" ], "mutually_exclusive_groups": [], "example_json": "{\n \"responseCode_match\": [\n {\n \"value\": 0\n }\n ]\n}", "example_yaml": "responseCode_match:\n- value: 0" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseCodeMatcherType": { "type": "object", "title": "Response Code Matcher Type", "x-displayname": "Response Code Matcher Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseCodeMatcherType", "properties": { "operator": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseCodeOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "integer", "description": "Configuration parameter for value", "title": "Response code Matcher Value", "format": "int64", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseCodeMatcherType", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": 0\n}", "example_yaml": "value: 0" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseCodeOperator": { "type": "string", "description": "- CODE_EQUALS: EQUALS value\n\n- CODE_NOT_EQUAL_TO: NOT_EQUAL_TO value\n\n- CODE_LESS_THAN: LESS_THAN value\n\n- CODE_GREATER_THAN: GREATER_THAN value\n\n- CODE_LESS_THAN_OR_EQUAlS_TO: LESS_THAN_OR_EQUAlS_TO value\n\n- CODE_GREATER_THAN_OR_EQUAlS_TO: GREATER_THAN_OR_EQUAlS_TO value.", "title": "Response Code Comparison Operator", "enum": [ "CODE_EQUALS", "CODE_NOT_EQUAL_TO", "CODE_LESS_THAN", "CODE_GREATER_THAN", "CODE_LESS_THAN_OR_EQUAlS_TO", "CODE_GREATER_THAN_OR_EQUAlS_TO" ], "default": "CODE_EQUALS", "x-displayname": "Comparison Operator.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.ResponseCodeOperator", "x-f5xc-description-short": "- CODE_EQUALS: EQUALS value - CODE_NOT_EQUAL_TO: NOT_EQUAL_TO value - CODE_LESS_THAN: LESS_THAN value - CODE_GREATER_THAN: GREATER_THAN value ...", "x-f5xc-description-medium": "- CODE_EQUALS: EQUALS value - CODE_NOT_EQUAL_TO: NOT_EQUAL_TO value - CODE_LESS_THAN: LESS_THAN value - CODE_GREATER_THAN: GREATER_THAN value - CODE_LESS_THAN_OR_EQUAlS_TO: LESS_THAN_OR_EQUAlS_TO value - CODE_GREATER_THAN_OR_EQUAlS_TO: GREATER_THAN_OR_EQUAlS_TO value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseCodeOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"CODE_EQUALS\"", "example_yaml": "CODE_EQUALS\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseHeaderMatcher": { "type": "object", "description": "Response Header matcher Choice.", "title": "Response Header Matcher", "x-displayname": "Header Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseHeaderMatcher", "properties": { "response_header_match_v2": { "type": "array", "description": "Response Header Matchers.", "title": "Response Header Matchers", "items": { "$ref": "#/components/schemas/bot_defenseResponseHeaderMatcherTypeV2" }, "x-displayname": "Response Header Matcher(s)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseHeaderMatcher", "required_fields": [ "response_header_match_v2" ], "mutually_exclusive_groups": [], "example_json": "{\n \"response_header_match_v2\": [\n {\n \"value\": \"value\"\n }\n ]\n}", "example_yaml": "response_header_match_v2:\n- value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseHeaderMatcherTypeV2": { "type": "object", "title": "Response Header Matcher Type", "x-displayname": "Response Header Matcher Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseHeaderMatcherTypeV2", "properties": { "case_sensitive": { "type": "boolean", "title": "Case sensitive", "format": "boolean", "x-displayname": "Case Sensitive.", "description": "Configuration parameter for case sensitive", "x-f5xc-description-short": "Configuration parameter for case sensitive.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "not": { "type": "boolean", "title": "Check not", "format": "boolean", "x-displayname": "Not(!)", "description": "Configuration parameter for not", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operator": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Response Header Matcher Value", "minLength": 1, "maxLength": 256, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseHeaderMatcherTypeV2", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseHeaderOperator": { "type": "object", "description": "Response Header matcher choice.", "title": "Response Header Operator", "x-displayname": "Response Header Matcher.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseHeaderOperator", "properties": { "response_header_operator": { "type": "array", "description": "Configuration parameter for response header operator", "title": "Response Header", "items": { "$ref": "#/components/schemas/bot_defenseResponseHeaderV2" }, "x-displayname": "Response Header.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Configuration parameter for response header operator.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseHeaderOperator", "required_fields": [ "response_header_operator" ], "mutually_exclusive_groups": [], "example_json": "{\n \"response_header_operator\": [\n {\n \"name\": \"example-resource\"\n }\n ]\n}", "example_yaml": "response_header_operator:\n- name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseHeaderV2": { "type": "object", "description": "Response Header values.", "title": "Response Header Name Operator Pair", "x-displayname": "Response Header Values.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseHeaderV2", "properties": { "header": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseHeaderOperatorChoice" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Header Name.", "title": "Header Name", "x-displayname": "Header Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.http_header_field": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseHeaderV2", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-resource\"\n}", "example_yaml": "name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseHeaders": { "type": "object", "title": "Response Headers", "x-displayname": "Response Headers.", "x-ves-displayorder": "1", "x-ves-oneof-field-responseheaderchoice": "[\"response_header_all\",\"response_header_and\",\"response_header_none\",\"response_header_or\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ResponseHeaders", "properties": { "response_header_all": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for response header all.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "response_header_and", "response_header_none", "response_header_or" ] }, "response_header_and": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderOperator" } ], "x-f5xc-description-short": "Configuration parameter for response header and.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "response_header_all", "response_header_none", "response_header_or" ] }, "response_header_none": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderOperator" } ], "x-f5xc-description-short": "Configuration parameter for response header none.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "response_header_all", "response_header_and", "response_header_or" ] }, "response_header_or": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaderOperator" } ], "x-f5xc-description-short": "Configuration parameter for response header or.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "response_header_all", "response_header_and", "response_header_none" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseHeaders", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseResponseOperator": { "type": "string", "description": "- RESPONSE_OPERATOR_EQUALS_TO: EQUALS_TO value\n\n- RESPONSE_OPERATOR_CONTAINS: CONTAINS value\n\n- RESPONSE_OPERATOR_STARTS_WITH: STARTS_WITH value\n\n- RESPONSE_OPERATOR_ENDS_WITH: ENDS_WITH value.", "title": "Transaction Details Comparison Operator for Body, Header and Cookies", "enum": [ "RESPONSE_OPERATOR_EQUALS_TO", "RESPONSE_OPERATOR_CONTAINS", "RESPONSE_OPERATOR_STARTS_WITH", "RESPONSE_OPERATOR_ENDS_WITH" ], "default": "RESPONSE_OPERATOR_EQUALS_TO", "x-displayname": "Comparison Operator.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.ResponseOperator", "x-f5xc-description-short": "- RESPONSE_OPERATOR_EQUALS_TO: EQUALS_TO value - RESPONSE_OPERATOR_CONTAINS: CONTAINS value - RESPONSE_OPERATOR_STARTS_WITH: STARTS_WITH value ...", "x-f5xc-description-medium": "- RESPONSE_OPERATOR_EQUALS_TO: EQUALS_TO value - RESPONSE_OPERATOR_CONTAINS: CONTAINS value - RESPONSE_OPERATOR_STARTS_WITH: STARTS_WITH value - RESPONSE_OPERATOR_ENDS_WITH: ENDS_WITH value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseResponseOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"RESPONSE_OPERATOR_EQUALS_TO\"", "example_yaml": "RESPONSE_OPERATOR_EQUALS_TO\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseTransactionResult": { "type": "object", "description": "Transaction Result.", "title": "Transaction Result", "x-displayname": "Transaction Result.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.TransactionResult", "properties": { "transaction_result_failure": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseTransactionResultType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transaction_result_success": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseTransactionResultType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseTransactionResult", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseTransactionResultType": { "type": "object", "description": "Transaction Result Type.", "title": "Transaction Result Type", "x-displayname": "Transaction Result Type.", "x-ves-displayorder": "26,30,31,27", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.TransactionResultType", "properties": { "cookie_v2": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseCookies" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "responseBody": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseBody" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "responseCode": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "response_header_v2": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseResponseHeaders" } ], "x-f5xc-description-short": "Configuration parameter for response header v2.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseTransactionResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseUserNameType": { "type": "object", "title": "Username Type", "x-displayname": "Username Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.UserNameType", "properties": { "encryption_type": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseUsernameEncryptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "username_reporting": { "type": "string", "description": "Human-readable name for the resource", "title": "Username Reporting", "minLength": 1, "maxLength": 256, "x-displayname": "Field", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseUserNameType", "required_fields": [ "username_reporting" ], "mutually_exclusive_groups": [], "example_json": "{\n \"username_reporting\": \"example-resource\"\n}", "example_yaml": "username_reporting: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseUsernameEncryptionType": { "type": "string", "description": "Encryption Type for username reporting\n\n- PlainText: plaintext\n\n- Hashed: hashed.", "title": "Encryption Type", "enum": [ "PlainText", "Hashed" ], "default": "PlainText", "x-displayname": "Encryption Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.UsernameEncryptionType", "x-f5xc-description-short": "Encryption Type for username reporting - PlainText: plaintext - Hashed: hashed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseUsernameEncryptionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PlainText\"", "example_yaml": "PlainText\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientAddHeaderToRequest": { "type": "object", "description": "Add a header name value pair.", "title": "WebClientAddHeaderToRequest", "x-displayname": "Add Header Name and Value Pair.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientAddHeaderToRequest", "properties": { "name_value_pair": { "type": "array", "description": "Request Header Pair.", "title": "Request Header", "items": { "$ref": "#/components/schemas/bot_defenseHeaderNameValuePair" }, "x-displayname": "Add Header Name and Value Pair.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientAddHeaderToRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientBlockMitigationActionType": { "type": "object", "description": "Web Client Block request and respond with custom content.", "title": "WebClientBlockMitigationActionType", "x-displayname": "Block bot mitigation.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientBlockMitigationActionType", "properties": { "body": { "type": "string", "description": "Request or response body content", "title": "body", "maxLength": 4096, "x-displayname": "Body", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "\"

Your request was blocked

\".", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name_value_pair": { "type": "array", "description": "Response Header Pair.", "title": "Response Header", "items": { "$ref": "#/components/schemas/bot_defenseHeaderNameValuePair" }, "x-displayname": "Response Header Name and Value Pair.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseBlockActionHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Web Client Block request and respond with custom content.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientBlockMitigationActionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientContinueMitigationActionType": { "type": "object", "description": "Continue mitigation action.", "title": "WebClientContinueMitigationActionType", "x-displayname": "Continue Bot Mitigation Action.", "x-ves-oneof-field-send_headers_choice": "[\"append_headers\",\"no_headers\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientContinueMitigationActionType", "properties": { "append_headers": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientContinueMitigationHeader" } ], "x-f5xc-description-short": "Configuration parameter for append headers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_headers" ] }, "no_headers": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "append_headers" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientContinueMitigationActionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientContinueMitigationHeader": { "type": "object", "description": "Append flag mitigation headers to forwarded request.", "title": "WebClientContinueMitigationHeader", "x-displayname": "Append Flag Mitigation Headers.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientContinueMitigationHeader", "properties": { "auto_type_header_name": { "type": "string", "description": "A case-insensitive HTTP header name.", "title": "auto_type_header_name", "maxLength": 256, "x-displayname": "Automation Type Header Name.", "x-ves-example": "Bot-Automation-Type.", "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" }, "x-f5xc-example": "Bot-Automation-Type", "x-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" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Append flag mitigation headers to forwarded request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientContinueMitigationHeader", "required_fields": [ "auto_type_header_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"auto_type_header_name\": \"Bot-Automation-Type\"\n}", "example_yaml": "auto_type_header_name: Bot-Automation-Type" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientRedirectMitigationActionType": { "type": "object", "description": "Web Client Redirect request to a custom URI.", "title": "WebClientRedirectMitigationTypeAction", "x-displayname": "Redirect bot mitigation.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientRedirectMitigationActionType", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uri": { "type": "string", "description": "URI location for redirect may be relative or absolute.", "title": "URI Location", "x-displayname": "Location", "x-ves-example": "Enter URI", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-example": "Enter URI", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-description-short": "URI location for redirect may be relative or absolute.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Web Client Redirect request to a custom URI.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientRedirectMitigationActionType", "required_fields": [ "uri" ], "mutually_exclusive_groups": [], "example_json": "{\n \"uri\": \"Enter URI\"\n}", "example_yaml": "uri: Enter URI" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseWebClientTransformMitigationActionChoiceType": { "type": "object", "description": "Transform mitigation action.", "title": "WebClientTransformMitigationActionChoiceType", "x-displayname": "Transform Bot Mitigation Action.", "x-ves-oneof-field-add_headers_choice": "[\"add_headers\",\"no_headers\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.WebClientTransformMitigationActionChoiceType", "properties": { "add_headers": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseWebClientAddHeaderToRequest" } ], "x-f5xc-description-short": "Configuration parameter for add headers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_headers" ] }, "no_headers": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "add_headers" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseWebClientTransformMitigationActionChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensebot_endpoint_policyGetSpecType": { "type": "object", "description": "GET Bot Endpoint Policy.", "title": "Get Bot Endpoint Policy", "x-displayname": "GET Bot Endpoint Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetSpecType", "properties": { "cookies": { "type": "array", "description": "The cookie names and corresponding descriptions for this policy.", "items": { "$ref": "#/components/schemas/bot_defenseCookieDefinition" }, "x-displayname": "Cookies", "x-f5xc-description-short": "The cookie names and corresponding descriptions for this policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_mode": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDeploymentMode" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseProtectedEndpoints" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "latest_version": { "type": "string", "description": "The version number to Endpoint Policy Version for the latest version.", "x-displayname": "Version", "x-f5xc-description-short": "The version number to Endpoint Policy Version for the latest version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensebot_endpoint_policyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensebot_endpoint_policyReplaceSpecType": { "type": "object", "description": "Replace Bot Endpoint Policy.", "title": "Replace Bot Endpoint Policy", "x-displayname": "Replace Bot Endpoint Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceSpecType", "properties": { "endpoint_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseProtectedEndpoints" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensebot_endpoint_policyReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_endpoint_policyCustomReplaceRequest": { "type": "object", "title": "CustomReplaceRequest is used to replace contents of a bot_endpoint_policy", "x-displayname": "Custom Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomReplaceRequest", "properties": { "name": { "type": "string", "description": "Name of the policy.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_endpoint_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyCustomReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyCustomReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.CustomReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyCustomReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyGetContentResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetContentResponse", "properties": { "endpoint_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseProtectedEndpoints" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyGetContentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyGetMobileBaseConfigFileResponse": { "type": "object", "description": "Mobile base config file response.", "title": "GetMobileBaseConfigFileResponse", "x-displayname": "GetMobileBaseConfigFileResponse.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetMobileBaseConfigFileResponse", "properties": { "content": { "type": "string", "description": "Mobile SDK Base Configuration content.", "title": "Mobile SDK Base Configuration content", "format": "byte", "x-displayname": "Mobile SDK Base Configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Mobile SDK Base Configuration file name.", "title": "Mobile SDK Base Configuration file name", "x-displayname": "Mobile SDK Base Configuration file name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Mobile SDK Base Configuration file name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyGetMobileBaseConfigFileResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyGetPoliciesAndVersionsListResponse": { "type": "object", "description": "List All Bot Policies And Versions Response.", "title": "GetPoliciesAndVersionsListResponse", "x-displayname": "List All Bot Policies And Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetPoliciesAndVersionsListResponse", "properties": { "policies": { "type": "array", "description": "Policy", "title": "Policy", "items": { "$ref": "#/components/schemas/bot_endpoint_policyPolicy" }, "x-displayname": "Policy", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List All Bot Policies And Versions Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyGetPoliciesAndVersionsListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read bot_endpoint_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/bot_endpoint_policyReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_endpoint_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_endpoint_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of bot_endpoint_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/bot_endpoint_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyListResponseItem": { "type": "object", "description": "By default a summary of bot_endpoint_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of bot_endpoint_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this bot_endpoint_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this bot_endpoint_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this bot_endpoint_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this bot_endpoint_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates bot_endpoint_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates bot_endpoint_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_endpoint_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this bot_endpoint_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this bot_endpoint_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this bot_endpoint_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_endpoint_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this bot_endpoint_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this bot_endpoint_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of bot_endpoint_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of bot_endpoint_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyPolicy": { "type": "object", "description": "Policy name and versions.", "title": "Policy", "x-displayname": "Policy", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.Policy", "properties": { "policy_name": { "type": "string", "title": "Policy name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyPolicy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyPolicyVersionsResponse": { "type": "object", "description": "Policy versions response.", "title": "PolicyVersionsResponse", "x-displayname": "Policy Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.PolicyVersionsResponse", "properties": { "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyPolicyVersionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a bot_endpoint_policy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_endpoint_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_endpoint_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_endpoint_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_endpoint_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "schemaBotPolicyFlowLabelAccountManagementChoiceType": { "type": "object", "description": "Flow Label Account Management Category.", "title": "Bot Policy FlowLabelAccountManagementChoiceType", "x-displayname": "Account Management Category.", "x-ves-oneof-field-label_choice": "[\"change_password\",\"check_eligibility\",\"create\",\"exists\",\"password_forgot\",\"password_recover\",\"password_reset\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelAccountManagementChoiceType", "properties": { "change_password": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for change password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "check_eligibility", "create", "exists", "password_forgot", "password_recover", "password_reset" ] }, "check_eligibility": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for check eligibility.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "create", "exists", "password_forgot", "password_recover", "password_reset" ] }, "create": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "check_eligibility", "exists", "password_forgot", "password_recover", "password_reset" ] }, "exists": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "check_eligibility", "create", "password_forgot", "password_recover", "password_reset" ] }, "password_forgot": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for password forgot.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "check_eligibility", "create", "exists", "password_recover", "password_reset" ] }, "password_recover": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for password recover.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "check_eligibility", "create", "exists", "password_forgot", "password_reset" ] }, "password_reset": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for password reset.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_password", "check_eligibility", "create", "exists", "password_forgot", "password_recover" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelAccountManagementChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelAuthenticationChoiceType": { "type": "object", "description": "Flow Label Authentication Category.", "title": "Bot Policy FlowLabelCategoryChoiceType", "x-displayname": "Authentication Category.", "x-ves-oneof-field-label_choice": "[\"login\",\"login_alexa\",\"login_mfa\",\"login_partner\",\"logout\",\"token_refresh\",\"token_validate\",\"zelle_retrieve_token\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelAuthenticationChoiceType", "properties": { "login": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login_alexa", "login_mfa", "login_partner", "logout", "token_refresh", "token_validate", "zelle_retrieve_token" ] }, "login_alexa": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for login alexa.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_mfa", "login_partner", "logout", "token_refresh", "token_validate", "zelle_retrieve_token" ] }, "login_mfa": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_partner", "logout", "token_refresh", "token_validate", "zelle_retrieve_token" ] }, "login_partner": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for login partner.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_mfa", "logout", "token_refresh", "token_validate", "zelle_retrieve_token" ] }, "logout": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_mfa", "login_partner", "token_refresh", "token_validate", "zelle_retrieve_token" ] }, "token_refresh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for token refresh.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_mfa", "login_partner", "logout", "token_validate", "zelle_retrieve_token" ] }, "token_validate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for token validate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_mfa", "login_partner", "logout", "token_refresh", "zelle_retrieve_token" ] }, "zelle_retrieve_token": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for zelle retrieve token.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_alexa", "login_mfa", "login_partner", "logout", "token_refresh", "token_validate" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelAuthenticationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelCategoriesChoiceType": { "type": "object", "description": "Bot Endpoint Policy Flow Label Category allows to associate traffic with selected category.", "title": "Bot policy FlowLabelCategoryChoiceType", "x-displayname": "Bot Policy Flow Label Category.", "x-ves-oneof-field-flow_label_choice": "[\"account_management\",\"authentication\",\"credit_card\",\"delivery_services\",\"financial_services\",\"flight\",\"guest_session\",\"loyalty\",\"mailing_list\",\"media\",\"miscellaneous\",\"profile_management\",\"quotes\",\"search\",\"shopping_gift_cards\",\"socials\",\"undefined_flow_label\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelCategoriesChoiceType", "properties": { "account_management": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelAccountManagementChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for account management.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "authentication": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelAuthenticationChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "credit_card": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelCreditCardChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for credit card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "delivery_services": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelDeliveryServicesChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for delivery services.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "financial_services": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelFinancialServicesChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for financial services.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "flight": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelFlightChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "guest_session": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelGuestSessionChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for guest session.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "loyalty": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelLoyaltyChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "mailing_list": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelMailingListChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "media": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelMediaChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "miscellaneous": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelMiscellaneousChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for miscellaneous.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "profile_management", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "profile_management": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelProfileManagementChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for profile management.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "quotes", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "quotes": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelQuotesChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "search", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "search": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelSearchChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "shopping_gift_cards", "socials", "undefined_flow_label" ] }, "shopping_gift_cards": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelShoppingGiftCardsChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for shopping gift cards.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "socials", "undefined_flow_label" ] }, "socials": { "allOf": [ { "$ref": "#/components/schemas/schemaBotPolicyFlowLabelSocialsChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "undefined_flow_label" ] }, "undefined_flow_label": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "credit_card", "delivery_services", "financial_services", "flight", "guest_session", "loyalty", "mailing_list", "media", "miscellaneous", "profile_management", "quotes", "search", "shopping_gift_cards", "socials" ] } }, "x-f5xc-description-short": "Bot Endpoint Policy Flow Label Category allows to associate traffic with selected category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelCategoriesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelCreditCardChoiceType": { "type": "object", "description": "Flow Label Credit Card Category.", "title": "Bot Policy FlowLabelCreditCardChoiceType", "x-displayname": "Credit Card Category.", "x-ves-oneof-field-label_choice": "[\"activate\",\"apply\",\"apply_to_account\",\"view_history\",\"view_list\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelCreditCardChoiceType", "properties": { "activate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "apply", "apply_to_account", "view_history", "view_list" ] }, "apply": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "activate", "apply_to_account", "view_history", "view_list" ] }, "apply_to_account": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "activate", "apply", "view_history", "view_list" ] }, "view_history": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "activate", "apply", "apply_to_account", "view_list" ] }, "view_list": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "activate", "apply", "apply_to_account", "view_history" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelCreditCardChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelDeliveryServicesChoiceType": { "type": "object", "description": "Flow Label Delivery Services Category.", "title": "Bot Policy FlowLabelDeliveryServicesListChoiceType", "x-displayname": "Delivery Services Category.", "x-ves-oneof-field-label_choice": "[\"hold\",\"incorrectly_routed\",\"view_items\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelDeliveryServicesChoiceType", "properties": { "hold": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "incorrectly_routed", "view_items" ] }, "incorrectly_routed": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for incorrectly routed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hold", "view_items" ] }, "view_items": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "hold", "incorrectly_routed" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelDeliveryServicesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelFinancialServicesChoiceType": { "type": "object", "description": "Flow Label Financial Services Category.", "title": "Bot Policy FlowLabelFinancialServicesChoiceType", "x-displayname": "Financial Services Category.", "x-ves-oneof-field-label_choice": "[\"account_apply\",\"loan_personal_apply\",\"money_send\",\"money_transfer\",\"ofx\",\"request_credit_score\",\"student_apply\",\"zelle_execute_transaction\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelFinancialServicesChoiceType", "properties": { "account_apply": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for account apply.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "loan_personal_apply", "money_send", "money_transfer", "ofx", "request_credit_score", "student_apply", "zelle_execute_transaction" ] }, "loan_personal_apply": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for loan personal apply.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "money_send", "money_transfer", "ofx", "request_credit_score", "student_apply", "zelle_execute_transaction" ] }, "money_send": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_transfer", "ofx", "request_credit_score", "student_apply", "zelle_execute_transaction" ] }, "money_transfer": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for money transfer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_send", "ofx", "request_credit_score", "student_apply", "zelle_execute_transaction" ] }, "ofx": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_send", "money_transfer", "request_credit_score", "student_apply", "zelle_execute_transaction" ] }, "request_credit_score": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for request credit score.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_send", "money_transfer", "ofx", "student_apply", "zelle_execute_transaction" ] }, "student_apply": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for student apply.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_send", "money_transfer", "ofx", "request_credit_score", "zelle_execute_transaction" ] }, "zelle_execute_transaction": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_apply", "loan_personal_apply", "money_send", "money_transfer", "ofx", "request_credit_score", "student_apply" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelFinancialServicesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelFlightChoiceType": { "type": "object", "description": "Flow Label Flight Category.", "title": "Bot Policy FlowLabelFlightChoiceType", "x-displayname": "Flight Category.", "x-ves-oneof-field-label_choice": "[\"change_flight\",\"checkin\",\"flight_status\",\"submit_travel_documents\",\"time_table\",\"view_flight\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelFlightChoiceType", "properties": { "change_flight": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for change flight.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "checkin", "flight_status", "submit_travel_documents", "time_table", "view_flight" ] }, "checkin": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_flight", "flight_status", "submit_travel_documents", "time_table", "view_flight" ] }, "flight_status": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_flight", "checkin", "submit_travel_documents", "time_table", "view_flight" ] }, "submit_travel_documents": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for submit travel documents.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_flight", "checkin", "flight_status", "time_table", "view_flight" ] }, "time_table": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_flight", "checkin", "flight_status", "submit_travel_documents", "view_flight" ] }, "view_flight": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for view flight.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "change_flight", "checkin", "flight_status", "submit_travel_documents", "time_table" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelFlightChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelGuestSessionChoiceType": { "type": "object", "description": "Flow Label Guest Session Category.", "title": "Bot Policy FlowLabelGuestSessionListChoiceType", "x-displayname": "Guest Session Category.", "x-ves-oneof-field-label_choice": "[\"create\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelGuestSessionChoiceType", "properties": { "create": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelGuestSessionChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelLoyaltyChoiceType": { "type": "object", "description": "Flow Label Loyalty Category.", "title": "Bot Policy FlowLabelLoyaltyChoiceType", "x-displayname": "Loyalty Category.", "x-ves-oneof-field-label_choice": "[\"conversion\",\"reset_miles\",\"view_account\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelLoyaltyChoiceType", "properties": { "conversion": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "reset_miles", "view_account" ] }, "reset_miles": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for reset miles.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "conversion", "view_account" ] }, "view_account": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "conversion", "reset_miles" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelLoyaltyChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelMailingListChoiceType": { "type": "object", "description": "Flow Label Mailing List Category.", "title": "Bot Policy FlowLabelMailingListChoiceType", "x-displayname": "Mailing List Category.", "x-ves-oneof-field-label_choice": "[\"create_password\",\"signup\",\"unsubscribe\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelMailingListChoiceType", "properties": { "create_password": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for create password.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "signup", "unsubscribe" ] }, "signup": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create_password", "unsubscribe" ] }, "unsubscribe": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for unsubscribe.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create_password", "signup" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelMailingListChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelMediaChoiceType": { "type": "object", "description": "Flow Label Media Category.", "title": "Bot Policy FlowLabelMediaChoiceType", "x-displayname": "Media Category.", "x-ves-oneof-field-label_choice": "[\"content\",\"play\",\"record\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelMediaChoiceType", "properties": { "content": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "play", "record" ] }, "play": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "content", "record" ] }, "record": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "content", "play" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelMediaChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelMiscellaneousChoiceType": { "type": "object", "description": "Flow Label Miscellaneous Category.", "title": "Bot Policy FlowLabelMiscellaneousChoiceType", "x-displayname": "Miscellaneous Category.", "x-ves-oneof-field-label_choice": "[\"contact_us\",\"ratings\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelMiscellaneousChoiceType", "properties": { "contact_us": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ratings" ] }, "ratings": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contact_us" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelMiscellaneousChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelProfileManagementChoiceType": { "type": "object", "description": "Flow Label Profile Management Category.", "title": "Bot Policy FlowLabelProfileManagementChoiceType", "x-displayname": "Profile Management Category.", "x-ves-oneof-field-label_choice": "[\"create\",\"update\",\"view\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelProfileManagementChoiceType", "properties": { "create": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "update", "view" ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create", "view" ] }, "view": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create", "update" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelProfileManagementChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelQuotesChoiceType": { "type": "object", "description": "Flow Label Quotes Category.", "title": "Bot Policy FlowLabelQuotesChoiceType", "x-displayname": "Quotes Category.", "x-ves-oneof-field-label_choice": "[\"insurance_fire_request\",\"request\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelQuotesChoiceType", "properties": { "insurance_fire_request": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for insurance fire request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "request" ] }, "request": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "insurance_fire_request" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelQuotesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelSearchChoiceType": { "type": "object", "description": "Flow Label Search Category.", "title": "Bot Policy FlowLabelSearchChoiceType", "x-displayname": "Flow Label Search Category.", "x-ves-oneof-field-label_choice": "[\"fare_search\",\"find_user\",\"flight_search\",\"location_search\",\"product_search\",\"room_search\",\"shipment_search\",\"ticket_search\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelSearchChoiceType", "properties": { "fare_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for fare search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "find_user", "flight_search", "location_search", "product_search", "room_search", "shipment_search", "ticket_search" ] }, "find_user": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "flight_search", "location_search", "product_search", "room_search", "shipment_search", "ticket_search" ] }, "flight_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for flight search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "location_search", "product_search", "room_search", "shipment_search", "ticket_search" ] }, "location_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for location search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "flight_search", "product_search", "room_search", "shipment_search", "ticket_search" ] }, "product_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for product search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "flight_search", "location_search", "room_search", "shipment_search", "ticket_search" ] }, "room_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for room search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "flight_search", "location_search", "product_search", "shipment_search", "ticket_search" ] }, "shipment_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "flight_search", "location_search", "product_search", "room_search", "ticket_search" ] }, "ticket_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for ticket search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "fare_search", "find_user", "flight_search", "location_search", "product_search", "room_search", "shipment_search" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelSearchChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelShoppingGiftCardsChoiceType": { "type": "object", "description": "Flow Label Shopping & Gift Cards Category.", "title": "Bot Policy FlowLabelShoppingGiftCardsChoiceType", "x-displayname": "Shopping & Gift Cards Category.", "x-ves-oneof-field-label_choice": "[\"gift_card_check_balance\",\"gift_card_make_purches_with_card\",\"gift_card_purchase_card\",\"shop_add_to_cart\",\"shop_apply_gift_card\",\"shop_apply_promo_code\",\"shop_checkout\",\"shop_choose_seat\",\"shop_enter_drawing_submission\",\"shop_hold_inventory\",\"shop_make_payment\",\"shop_offer\",\"shop_order\",\"shop_price_inquiry\",\"shop_purchase_gift_card\",\"shop_return\",\"shop_schedule_pickup\",\"shop_track_order\",\"shop_update_quantity\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelShoppingGiftCardsChoiceType", "properties": { "gift_card_check_balance": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for gift card check balance.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "gift_card_make_purches_with_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for gift card make purches with card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "gift_card_purchase_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for gift card purchase card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_add_to_cart": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop add to cart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_apply_gift_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop apply gift card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_apply_promo_code": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop apply promo code.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_checkout": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop checkout.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_choose_seat": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop choose seat.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_enter_drawing_submission": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop enter drawing submission.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_hold_inventory": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop hold inventory.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_make_payment": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop make payment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_offer": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_order": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_price_inquiry": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop price inquiry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_purchase_gift_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop purchase gift card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_return", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_return": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop return.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_schedule_pickup", "shop_track_order", "shop_update_quantity" ] }, "shop_schedule_pickup": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop schedule pickup.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_track_order", "shop_update_quantity" ] }, "shop_track_order": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop track order.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_update_quantity" ] }, "shop_update_quantity": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop update quantity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_check_balance", "gift_card_make_purches_with_card", "gift_card_purchase_card", "shop_add_to_cart", "shop_apply_gift_card", "shop_apply_promo_code", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_hold_inventory", "shop_make_payment", "shop_offer", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_return", "shop_schedule_pickup", "shop_track_order" ] } }, "x-f5xc-description-short": "Flow Label Shopping & Gift Cards Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelShoppingGiftCardsChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyFlowLabelSocialsChoiceType": { "type": "object", "description": "Flow Label Socials Category.", "title": "Bot Policy FlowLabelSocialsChoiceType", "x-displayname": "Socials Category.", "x-ves-oneof-field-label_choice": "[\"follow\",\"like\",\"message\"]", "x-ves-proto-message": "ves.io.schema.BotPolicyFlowLabelSocialsChoiceType", "properties": { "follow": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "like", "message" ] }, "like": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "follow", "message" ] }, "message": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "follow", "like" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyFlowLabelSocialsChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotPolicyHttpMethod": { "type": "string", "description": "Specifies the HTTP method used for PC.\n\nGET method for XMLHttpRequest or Fetch\nPOST method\nPUT method\nPATCH method\nDELETE method\nGET method for HTML document\nHEAD method\nOPTIONS method\nTRACE method.", "title": "BotPolicyHttpMethod", "enum": [ "BP_METHOD_GET", "BP_METHOD_POST", "BP_METHOD_PUT", "BP_METHOD_PATCH", "BP_METHOD_DELETE", "BP_METHOD_GET_DOCUMENT", "BP_METHOD_HEAD", "BP_METHOD_OPTIONS", "BP_METHOD_TRACE" ], "default": "BP_METHOD_GET", "x-displayname": "HTTP Method.", "x-ves-proto-enum": "ves.io.schema.BotPolicyHttpMethod", "x-f5xc-description-medium": "Specifies the HTTP method used for PC. GET method for XMLHttpRequest or Fetch POST method PUT method PATCH method DELETE method GET method for HTML document HEAD method OPTIONS method TRACE method.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotPolicyHttpMethod", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BP_METHOD_GET\"", "example_yaml": "BP_METHOD_GET\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaHttpStatusCode": { "type": "string", "description": "HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nURI Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHTTP Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code.", "title": "HttpStatusCode", "enum": [ "EmptyStatusCode", "Continue", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "PayloadTooLarge", "URITooLong", "UnsupportedMediaType", "RangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HTTPVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "default": "EmptyStatusCode", "x-displayname": "HTTP Status Code.", "x-ves-proto-enum": "ves.io.schema.HttpStatusCode", "x-f5xc-description-short": "HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code...", "x-f5xc-description-medium": "HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaHttpStatusCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EmptyStatusCode\"", "example_yaml": "EmptyStatusCode\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "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.", "title": "description", "maxLength": 256, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "This is the name of the message.\nThe value of name has to follow DNS-1035 format.", "title": "name", "minLength": 1, "x-displayname": "Name", "x-ves-example": "Example-corp-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" }, "x-f5xc-example": "example-corp-web", "x-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" }, "x-f5xc-description-short": "Name of the message. The value of name has to follow DNS-1035 format.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "MessageMetaType is metadata (common attributes) of a message that only certain messages have.", "x-f5xc-description-medium": "MessageMetaType is metadata (common attributes) of a message that only certain messages have. This information is propagated to the metadata of a child object that gets created from the containing message during view processing. The information in this type can be specified by user during create...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaMessageMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "shapebot_defenseDomainMatcherType": { "type": "object", "description": "Matcher", "title": "Domain Matcher Type", "x-displayname": "Domain Matcher Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.DomainMatcherType", "properties": { "negation": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseNegationOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operator": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseComparisonOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Domain Matcher Value.", "title": "Domain Matcher Value", "minLength": 1, "maxLength": 256, "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for shapebot_defenseDomainMatcherType", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "shapebot_defensePathMatcherType": { "type": "object", "description": "Matcher", "title": "Matcher", "x-displayname": "Matcher", "x-ves-oneof-field-match_type_choice": "[\"contain_value\",\"end_with_value\",\"exact_value\",\"start_with_value\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.PathMatcherType", "properties": { "contain_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for contain value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "end_with_value", "exact_value", "start_with_value" ] }, "end_with_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for end with value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "exact_value", "start_with_value" ] }, "exact_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for exact value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "end_with_value", "start_with_value" ] }, "start_with_value": { "allOf": [ { "$ref": "#/components/schemas/bot_defensePathMatcherValue" } ], "x-f5xc-description-short": "Configuration parameter for start with value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "contain_value", "end_with_value", "exact_value" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for shapebot_defensePathMatcherType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensebot_infrastructureGetSpecType": { "type": "object", "description": "GET Bot Infrastructure.", "title": "Get Bot Infrastructure", "x-displayname": "GET Bot Infrastructure.", "x-ves-oneof-field-bot_infra_choice": "[\"cloud_hosted\",\"kubernetes\",\"on_prem\",\"physical_hosted\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.GetSpecType", "properties": { "bot_allowlist_policy_metadata": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructurePolicyMetadata" } ], "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_endpoint_policy_metadata": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEndpointPolicyMetadata" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_network_policy_metadata": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructurePolicyMetadata" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_ti_package_information": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTIPackageInformation" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cloud_hosted": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraCloudHosted" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "kubernetes", "on_prem", "physical_hosted" ] }, "cluster_state": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureClusterState" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_mode": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseDeploymentMode" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "environment_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "on_prem": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraF5HostedOnPrem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_hosted", "kubernetes", "physical_hosted" ] }, "physical_hosted": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraF5HostedOnPrem" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_hosted", "kubernetes", "on_prem" ] }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensebot_infrastructureGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensebot_infrastructureLocation": { "type": "string", "description": "Region location\n\nAP_NORTHEAST_1\nAP_NORTHEAST_3\nAP_SOUTH_1\nAP_SOUTH_2\nAP_SOUTHEAST_1\nAP_SOUTHEAST_2\nAP_SOUTHEAST_3\nEU_CENTRAL_1\nEU_NORTH_1\nEU_WEST_1\nME_SOUTH_1\nME_CENTRAL_1\nSA_EAST_1\nUS_EAST_1\nUS_EAST_2\nUS_WEST_1\nUS_WEST_2\nAF_SOUTH_1\nASIA_EAST1\nASIA_EAST2\nASIA_NORTHEAST1\nASIA_NORTHEAST2\nASIA_NORTHEAST3\nASIA_SOUTH1\nASIA_SOUTHEAST1\nASIA_SOUTHEAST2\nAUSTRALIA_SOUTHEAST1\nEUROPE_WEST1\nEUROPE_WEST2\nEUROPE_WEST3\nNORTHAMERICA_NORTHEAST1\nNORTHAMERICA_NORTHEAST2\nSOUTHAMERICA_EAST1\nSOUTHAMERICA_WEST1\nUS_CENTRAL1\nUS_EAST1\nUS_EAST4\nUS_WEST1\nUS_WEST2.", "title": "Location", "enum": [ "AP_NORTHEAST_1", "AP_NORTHEAST_3", "AP_SOUTH_1", "AP_SOUTH_2", "AP_SOUTHEAST_1", "AP_SOUTHEAST_2", "AP_SOUTHEAST_3", "EU_CENTRAL_1", "EU_NORTH_1", "EU_WEST_1", "ME_SOUTH_1", "ME_CENTRAL_1", "SA_EAST_1", "US_EAST_1", "US_EAST_2", "US_WEST_1", "US_WEST_2", "AF_SOUTH_1", "GCP_ASIA_EAST1", "GCP_ASIA_EAST2", "GCP_ASIA_NORTHEAST1", "GCP_ASIA_NORTHEAST2", "GCP_ASIA_NORTHEAST3", "GCP_ASIA_SOUTH1", "GCP_ASIA_SOUTHEAST1", "GCP_ASIA_SOUTHEAST2", "GCP_AUSTRALIA_SOUTHEAST1", "GCP_EUROPE_WEST1", "GCP_EUROPE_WEST2", "GCP_EUROPE_WEST3", "GCP_NORTHAMERICA_NORTHEAST1", "GCP_NORTHAMERICA_NORTHEAST2", "GCP_SOUTHAMERICA_EAST1", "GCP_SOUTHAMERICA_WEST1", "GCP_US_CENTRAL1", "GCP_US_EAST1", "GCP_US_EAST4", "GCP_US_WEST1", "GCP_US_WEST2" ], "default": "AP_NORTHEAST_1", "x-displayname": "Location", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.Location", "x-f5xc-description-short": "Region location AP_NORTHEAST_1 AP_NORTHEAST_3 AP_SOUTH_1 AP_SOUTH_2 AP_SOUTHEAST_1 AP_SOUTHEAST_2 AP_SOUTHEAST_3 EU_CENTRAL_1 EU_NORTH_1 EU_WEST_1...", "x-f5xc-description-medium": "Region location AP_NORTHEAST_1 AP_NORTHEAST_3 AP_SOUTH_1 AP_SOUTH_2 AP_SOUTHEAST_1 AP_SOUTHEAST_2 AP_SOUTHEAST_3 EU_CENTRAL_1 EU_NORTH_1 EU_WEST_1 ME_SOUTH_1 ME_CENTRAL_1 SA_EAST_1 US_EAST_1 US_EAST_2 US_WEST_1 US_WEST_2 AF_SOUTH_1 ASIA_EAST1 ASIA_EAST2 ASIA_NORTHEAST1 ASIA_NORTHEAST2...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensebot_infrastructureLocation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"AP_NORTHEAST_1\"", "example_yaml": "AP_NORTHEAST_1\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defensebot_infrastructureReplaceSpecType": { "type": "object", "description": "Replace Bot Infrastructure.", "title": "Replace Bot Infrastructure", "x-displayname": "Replace Bot Infrastructure.", "x-ves-oneof-field-bot_infra_choice": "[\"cloud_hosted\",\"kubernetes\",\"on_prem\",\"physical_hosted\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ReplaceSpecType", "properties": { "cloud_hosted": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraCloudHosted" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "kubernetes", "on_prem", "physical_hosted" ] }, "environment_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureEnvironmentType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "on_prem": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraF5HostedOnPrem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_hosted", "kubernetes", "physical_hosted" ] }, "physical_hosted": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureInfraF5HostedOnPrem" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_hosted", "kubernetes", "on_prem" ] }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defensebot_infrastructureReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_infrastructureApplyCertificateRegion": { "type": "object", "description": "Request for applying certificate.", "title": "ApplyCertificateRequest", "x-displayname": "Apply Certificate Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ApplyCertificateRegion", "properties": { "cert_id": { "type": "string", "description": "Certificate ID.", "title": "Certificate ID", "minLength": 1, "x-displayname": "Certificate ID.", "x-ves-example": "6990a584f0526500012a1723.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "6990a584f0526500012a1723", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "region_name": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureLocation" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureApplyCertificateRegion", "required_fields": [ "cert_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert_id\": \"6990a584f0526500012a1723\"\n}", "example_yaml": "cert_id: 6990a584f0526500012a1723" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureApplyCertificateRequest": { "type": "object", "description": "Request for applying certificate.", "title": "ApplyCertificateRequest", "x-displayname": "Apply Certificate Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ApplyCertificateRequest", "properties": { "name": { "type": "string", "description": "Bot Infrastructure Name.", "title": "Bot Infrastructure Name", "x-displayname": "Bot Infrastructure Name.", "x-ves-example": "Cluster_1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "cluster_1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "region_list": { "type": "array", "description": "List of region and certificate pairs to rollback.", "title": "Region List", "minItems": 1, "items": { "$ref": "#/components/schemas/bot_infrastructureApplyCertificateRegion" }, "x-displayname": "Region List.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-description-short": "List of region and certificate pairs to rollback.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureApplyCertificateRequest", "required_fields": [ "name", "namespace", "region_list" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"cluster_1\",\n \"namespace\": \"default\",\n \"region_list\": [\n {\n \"cert_id\": \"6990a584f0526500012a1723\"\n }\n ]\n}", "example_yaml": "name: cluster_1\nnamespace: default\nregion_list:\n- cert_id: 6990a584f0526500012a1723" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCertificateOperationRegion": { "type": "object", "description": "Region status for certificate operation.", "title": "CertificateOperationRegion", "x-displayname": "Certificate Operation Region.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CertificateOperationRegion", "properties": { "cert_status": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureCertificateStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deploy_status": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureDepolyStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureLocation" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Region status for certificate operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCertificateOperationRegion", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCertificateOperationResponse": { "type": "object", "description": "Response for certificate operations.", "title": "CertificateOperationResponse", "x-displayname": "Certificate Operation Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CertificateOperationResponse", "properties": { "name": { "type": "string", "description": "Name of the cluster.", "title": "Cluster Name", "x-displayname": "Cluster Name.", "x-ves-example": "Your-bot-infra-name.", "x-f5xc-example": "your-bot-infra-name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "region_list": { "type": "array", "description": "List of region status for certificate operation.", "title": "Region List", "items": { "$ref": "#/components/schemas/bot_infrastructureCertificateOperationRegion" }, "x-displayname": "Region List.", "x-f5xc-description-short": "List of region status for certificate operation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCertificateOperationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCertificateStatus": { "type": "string", "description": "The status of certificate application to the ingress\n\nCertificate status is undefined (initial state, before first sync)\nCertificate has been successfully applied to the ingress\nCertificate is not applied.", "title": "CertificateStatus", "enum": [ "CERT_STATUS_UNDEFINED", "CERT_STATUS_APPLIED", "CERT_STATUS_NOT_APPLIED" ], "default": "CERT_STATUS_UNDEFINED", "x-displayname": "Certificate Status.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.CertificateStatus", "x-f5xc-description-short": "The status of certificate application to the ingress Certificate status is undefined (initial state, before first sync) Certificate has been...", "x-f5xc-description-medium": "The status of certificate application to the ingress Certificate status is undefined (initial state, before first sync) Certificate has been successfully applied to the ingress Certificate is not applied.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCertificateStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"CERT_STATUS_UNDEFINED\"", "example_yaml": "CERT_STATUS_UNDEFINED\n..." }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureClusterState": { "type": "string", "description": "The selection for cluster state\n\nState is Active\nState is Inactive\nState is Passive Proxy\nState is Emergency Stop\nState is unavailable\nState is reconcile\nState is starting active\nState is stopping active\nState is updating firmware\nState is updating policy\nState is waiting for all active\nState is waiting for start timeout.", "title": "Hosted/On Prem Cluster State", "enum": [ "ACTIVE", "INACTIVE", "PASSIVE_PROXY", "EMERGENCY_STOP", "UNAVAILABLE", "RECONCILE", "STARTING_ACTIVE", "STOPPING_ACTIVE", "UPDATING_FIRMWARE", "UPDATING_POLICY", "WAITING_ACTIVE", "WAITING_START_TIMEOUT" ], "default": "ACTIVE", "x-displayname": "F5 On Premises or F5 Hosted Cluster State.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.ClusterState", "x-f5xc-description-short": "The selection for cluster state State is Active State is Inactive State is Passive Proxy State is Emergency Stop State is unavailable State is...", "x-f5xc-description-medium": "The selection for cluster state State is Active State is Inactive State is Passive Proxy State is Emergency Stop State is unavailable State is reconcile State is starting active State is stopping active State is updating firmware State is updating policy State is waiting for all active State is...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureClusterState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ACTIVE\"", "example_yaml": "ACTIVE\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of bot_infrastructure", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCreateSpecInfraCloudHosted": { "type": "object", "title": "F5 Cloud Hosted - for creating a new object", "x-displayname": "F5 Cloud Hosted.", "x-ves-oneof-field-type_choice": "[\"production\",\"testing\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CreateSpecInfraCloudHosted", "properties": { "ip_addresses": { "type": "array", "description": "Only traffic from these IP addresses is allowed to access this Bot Defense infrastructure.", "title": "IP Allowlist", "items": { "type": "string" }, "x-displayname": "Ingress IP Access Control List.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Only traffic from these IP addresses is allowed to access this Bot Defense infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "production": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureProduction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "testing" ] }, "testing": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTesting" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "production" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCreateSpecInfraCloudHosted", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureCreateSpecType": { "type": "object", "description": "Create Bot Infrastructure.", "title": "Create Bot Infrastructure", "x-displayname": "Create Bot Infrastructure.", "x-ves-oneof-field-create_bot_infra_choice": "[\"create_cloud_hosted\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.CreateSpecType", "properties": { "create_cloud_hosted": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureCreateSpecInfraCloudHosted" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeployPoliciesRequest": { "type": "object", "description": "Request for deploy policies.", "title": "DeployPolicesRequest", "x-displayname": "Deploy Policies Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeployPoliciesRequest", "properties": { "comments": { "type": "string", "description": "The comments for this deployment.", "title": "Deployed Comments", "x-displayname": "Comments", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Bot Infra Name.", "title": "Bot Infra Name", "minLength": 1, "x-displayname": "Bot Infrastructure Name.", "x-ves-example": "Cluster_1", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "cluster_1", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "namespace", "minLength": 1, "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "policy_metadata": { "type": "array", "description": "Deployed Policy Metadata.", "title": "Deployed Policy Metadata", "items": { "$ref": "#/components/schemas/bot_infrastructureDeployPolicyMetadata" }, "x-displayname": "Deployed Policy.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ti_package_metadata": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureTIPackageMetadata" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeployPoliciesRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeployPoliciesResponse": { "type": "object", "description": "Response for deploy policies.", "title": "DeployPoliciesResponse", "x-displayname": "Deploy Policies Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeployPoliciesResponse", "properties": { "deploy_status": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureDepolyStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Bot Infra Name.", "title": "Bot Infra Name", "minLength": 1, "x-displayname": "Bot Infrastructure Name.", "x-ves-example": "Cluster_1", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "cluster_1", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeployPoliciesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeployPolicyMetadata": { "type": "object", "description": "The metadata for deployed policy config.", "title": "DeployPolicyMetadata", "x-displayname": "Policy Metadata.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeployPolicyMetadata", "properties": { "policy_name": { "type": "string", "description": "Policy Name.", "title": "Policy Name", "minLength": 1, "x-displayname": "Policy", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.ves_object_name": "true" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "format": "dns-label", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "policy_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructurePolicyType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Policy Version\nThe format should be X.0.", "title": "Policy Version", "x-displayname": "Version", "x-f5xc-example": "v1.2.3", "x-f5xc-description-short": "Policy Version The format should be X.0.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "The metadata for deployed policy config.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeployPolicyMetadata", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeploymentData": { "type": "object", "description": "Deployment status of cluster after policies deployment.", "title": "DeploymentData", "x-displayname": "DeploymentData.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeploymentData", "properties": { "deployment_status": { "type": "string", "description": "Deployment Status.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-ves-example": "Success", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Success", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "deployment_type": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureDeploymentType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "details": { "type": "string", "description": "Details", "title": "Details", "x-displayname": "Details", "x-ves-example": "Detail End User Message.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Detail End User Message.", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "last_deployed_by": { "type": "string", "description": "User who deployed the policy at last.", "title": "Last deployed by", "x-displayname": "Last Deployed By.", "x-ves-example": "Dana@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "last_deployed_on": { "type": "string", "description": "Last deployed on.", "title": "Last deployed on", "format": "date-time", "x-displayname": "Last Deployed On.", "x-ves-example": "Dec-01-2023.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Dec-01-2023", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "US", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "US", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "policies": { "type": "array", "description": "Policies", "title": "Policies", "items": { "type": "string" }, "x-displayname": "Policies", "x-ves-example": "Endpoint_Policy_Web_Test v1.0 to v2.0.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Endpoint_Policy_Web_Test v1.0 to v2.0", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "region": { "type": "string", "description": "Region", "title": "Region", "x-displayname": "Region", "x-ves-deprecated": "Replaced by 'name'", "x-ves-example": "US", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "US", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Deployment status of cluster after policies deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeploymentData", "required_fields": [ "deployment_status", "details", "last_deployed_by", "last_deployed_on", "name", "policies", "region" ], "mutually_exclusive_groups": [], "example_json": "{\n \"deployment_status\": \"Success\",\n \"details\": \"Detail End User Message.\",\n \"last_deployed_by\": \"dana@example.com\",\n \"last_deployed_on\": \"Dec-01-2023\",\n \"name\": \"US\",\n \"policies\": [\n \"value\"\n ],\n \"region\": \"US\"\n}", "example_yaml": "deployment_status: Success\ndetails: Detail End User Message.\nlast_deployed_by: dana@example.com\nlast_deployed_on: Dec-01-2023\nname: US\npolicies:\n- value\nregion: US" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeploymentHistoryData": { "type": "object", "description": "Deployment history of cluster after policies deployment.", "title": "DeploymentHistoryData", "x-displayname": "DeploymentHistoryData.", "x-ves-oneof-field-deployed_by_choice": "[\"organization\",\"user\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeploymentHistoryData", "properties": { "comments": { "type": "string", "description": "Policy Comments from user.", "title": "Comments", "maxLength": 2048, "x-displayname": "Comments", "x-ves-example": "This is comment.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "This is comment", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "generated_link": { "type": "string", "description": "Generated Link.", "title": "Generated Link", "x-displayname": "Generated Link.", "x-ves-example": "Generated Link.", "x-f5xc-example": "Generated Link", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "organization": { "type": "string", "description": "Exclusive with [user]\nOrganization name must be \"F5\"", "title": "Organization", "x-displayname": "Organization.", "x-f5xc-description-short": "Exclusive with [user] Organization name must be \"F5\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "user" ] }, "policy_id": { "type": "string", "description": "Policy ID", "title": "Policy ID", "minLength": 1, "x-displayname": "Policy ID", "x-ves-example": "Some_Policy-ID-1212.", "x-ves-validation-rules": { "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "Some_Policy-ID-1212", "x-validation-rules": { "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "policy_metadata": { "type": "array", "description": "Deployed Policy Metadata.", "title": "Deployed Policy Metadata", "items": { "$ref": "#/components/schemas/bot_infrastructureDeployPolicyMetadata" }, "x-displayname": "Deployed Policy.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Current status of the resource", "title": "Status", "x-displayname": "Status", "x-ves-example": "Success", "x-f5xc-example": "Success", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ti_package_name": { "type": "string", "description": "TI Package Name for this deployment(deliver), which will be only support for Kubernetes bot infrastructure.", "title": "TI Package Name", "x-displayname": "TI Package Name.", "x-ves-example": "TI_Package_1.", "x-f5xc-example": "TI_Package_1", "x-f5xc-description-short": "TI Package Name for this deployment(deliver), which will be only support for Kubernetes bot infrastructure.", "x-f5xc-description-medium": "TI Package Name for this deployment(deliver), which will be only support for Kubernetes bot infrastructure.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "string", "title": "Timestamp", "format": "date-time", "x-displayname": "Timestamp", "description": "Timestamp in ISO 8601 format with UTC timezone", "x-f5xc-example": "2025-01-15T10:30:00Z", "x-f5xc-description-short": "Timestamp in ISO 8601 format with UTC timezone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user": { "type": "string", "description": "Exclusive with [organization]", "title": "User", "x-displayname": "User", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identity", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "characterSet": { "allowed": "[a-zA-Z0-9_.-]", "description": "Alphanumeric with underscores, dots, hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "organization" ] } }, "x-f5xc-description-short": "Deployment history of cluster after policies deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeploymentHistoryData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeploymentHistoryResponse": { "type": "object", "description": "Response for history of cluster after policies deployment.", "title": "DeploymentHistoryResponse", "x-displayname": "Deployment History Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeploymentHistoryResponse", "properties": { "deployment_history_data": { "type": "array", "description": "Deployment History Data.", "title": "Deployment History Data", "items": { "$ref": "#/components/schemas/bot_infrastructureDeploymentHistoryData" }, "x-displayname": "Deployment History Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for history of cluster after policies deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeploymentHistoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeploymentStatusResponse": { "type": "object", "description": "Response for status of cluster after policies deployment.", "title": "DeploymentStatusResponse", "x-displayname": "Deployment Status Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeploymentStatusResponse", "properties": { "deployment_data": { "type": "array", "items": { "$ref": "#/components/schemas/bot_infrastructureDeploymentData" }, "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for status of cluster after policies deployment.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeploymentStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDeploymentType": { "type": "string", "description": "The type of bot infra\n\n- CLOUD_HOSTED: F5 Cloud Hosted\n\n- HOSTED: F5 Hosted\n\n- ON_PREM: F5 On Prem\n\n- Kubernetes: Kubernetes.", "title": "DeploymentResponseType", "enum": [ "CLOUD_HOSTED", "HOSTED", "ON_PREM", "KUBERNETES" ], "default": "CLOUD_HOSTED", "x-displayname": "Deployment Response Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.DeploymentType", "x-f5xc-description-short": "The type of bot infra - CLOUD_HOSTED: F5 Cloud Hosted - HOSTED: F5 Hosted - ON_PREM: F5 On Prem - Kubernetes: Kubernetes.", "x-f5xc-description-medium": "The type of bot infra - CLOUD_HOSTED: F5 Cloud Hosted - HOSTED: F5 Hosted - ON_PREM: F5 On Prem - Kubernetes: Kubernetes.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDeploymentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"CLOUD_HOSTED\"", "example_yaml": "CLOUD_HOSTED\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDepolyStatus": { "type": "string", "description": "Deploy Status\n\n- IN_PROGRESS: In Progress\n\n- FINISHED: Finished\n\n- FAILED: Failed.", "title": "DeployStatus", "enum": [ "IN_PROGRESS", "FINISHED", "FAILED" ], "default": "IN_PROGRESS", "x-displayname": "Deploy Status.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.DepolyStatus", "x-f5xc-description-short": "Deploy Status - IN_PROGRESS: In Progress - FINISHED: Finished - FAILED: Failed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDepolyStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IN_PROGRESS\"", "example_yaml": "IN_PROGRESS\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureDevice": { "type": "object", "description": "The device details.", "title": "Devices", "x-displayname": "Device", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.Device", "properties": { "certification_status": { "type": "string", "description": "The status of certification in device.", "title": "Certification status", "x-displayname": "Certification Status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device_firmware_version": { "type": "string", "description": "The firmware version in device.", "title": "Device Firmware version", "x-displayname": "Firmware Version.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device_name": { "type": "string", "description": "The name for the device.", "title": "Device name", "x-displayname": "Device Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_info": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureIPInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureDevice", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureEgress": { "type": "object", "description": "Egress", "title": "Egress", "x-displayname": "Egress", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.Egress", "properties": { "ip_address": { "type": "string", "description": "Egress IP address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.78.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.78", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ip", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "region": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureLocation" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureEgress", "required_fields": [ "ip_address" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_address\": \"192.0.2.78\"\n}", "example_yaml": "ip_address: 192.0.2.78" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureEndpointPolicyMetadata": { "type": "object", "description": "On associated endpoint policy object.", "title": "Bot Endpoint Policy Metadata", "x-displayname": "Bot Endpoint Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.EndpointPolicyMetadata", "properties": { "name": { "type": "string", "description": "Policy Name.", "title": "Policy Name", "x-displayname": "Policy", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "Policy Version.", "title": "Policy Version", "x-displayname": "Version", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureEndpointPolicyMetadata", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read bot_infrastructure", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_infrastructureStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureIPInfo": { "type": "object", "description": "The IP address information for the device.", "title": "IP information", "x-displayname": "IP Address.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.IPInfo", "properties": { "local": { "type": "string", "description": "Local IP address.", "title": "Local", "x-displayname": "Local", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic": { "type": "string", "description": "Traffic address.", "title": "Traffic", "x-displayname": "Traffic", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "wan": { "type": "string", "description": "WAN address.", "title": "WAN", "x-displayname": "WAN", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The IP address information for the device.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureIPInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureInfraCloudHosted": { "type": "object", "title": "F5 Cloud Hosted", "x-displayname": "F5 Cloud Hosted.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.InfraCloudHosted", "properties": { "egress": { "type": "array", "description": "Egress IP Addresses.", "title": "Egress", "items": { "$ref": "#/components/schemas/bot_infrastructureEgress" }, "x-displayname": "Egress", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firmware_version": { "type": "string", "description": "The version of firmware for the cluster.", "title": "Firmware Version", "x-displayname": "Firmware Version.", "x-f5xc-description-short": "The version of firmware for the cluster.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "host_names": { "type": "array", "description": "Only traffic from machines with these host names is allowed to access this Bot Defense infrastructure.", "title": "Allowed Host Names", "items": { "type": "string" }, "x-displayname": "Allowed Host Names.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Only traffic from machines with these host names is allowed to access this Bot Defense infrastructure.", "x-f5xc-description-medium": "Only traffic from machines with these host names is allowed to access this Bot Defense infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infra_host_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Infra host name", "x-displayname": "Infra Host Name.", "x-ves-example": "www.example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ingress": { "type": "array", "description": "Ingress Host Names or IP Addresses.", "title": "Ingress", "items": { "$ref": "#/components/schemas/bot_infrastructureIngress" }, "x-displayname": "Ingress", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_addresses": { "type": "array", "description": "Only traffic from these IP addresses is allowed to access this Bot Defense infrastructure.", "title": "IP Allowlist", "items": { "type": "string" }, "x-displayname": "Ingress IP Access Control List.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-description-short": "Only traffic from these IP addresses is allowed to access this Bot Defense infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureInfraCloudHosted", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureInfraF5HostedOnPrem": { "type": "object", "description": "Bot infra type is F5 Hosted/F5 On Premises.", "title": "F5 On Premises or F5 Physical Hosted", "x-displayname": "F5 On Premises or F5 Hosted.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.InfraF5HostedOnPrem", "properties": { "devices": { "type": "array", "description": "The devices assigned to the cluster.", "title": "Devices", "items": { "$ref": "#/components/schemas/bot_infrastructureDevice" }, "x-displayname": "Devices", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firmware_version": { "type": "string", "description": "The version of firmware for the cluster.", "title": "Firmware Version", "x-displayname": "Firmware Version.", "x-f5xc-description-short": "The version of firmware for the cluster.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infra_host_name": { "type": "string", "description": "Infra host name should be \"N/A\"", "title": "Infra host name", "x-displayname": "Infra Host Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot infra type is F5 Hosted/F5 On Premises.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureInfraF5HostedOnPrem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureIngress": { "type": "object", "description": "Ingress", "title": "Ingress", "x-displayname": "Ingress", "x-ves-oneof-field-type_choice": "[\"host_name\",\"ip_address\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.Ingress", "properties": { "cert_id": { "type": "string", "description": "The ID of the certificate to be applied to this ingress (desired state)", "title": "Certificate ID", "x-displayname": "Certificate ID.", "x-ves-example": "6990a584f0526500012a1723.", "x-f5xc-example": "6990a584f0526500012a1723", "x-f5xc-description-short": "The ID of the certificate to be applied to this ingress (desired state).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "cert_status": { "allOf": [ { "$ref": "#/components/schemas/bot_infrastructureCertificateStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "host_name": { "type": "string", "description": "Exclusive with [ip_address]", "title": "Host Name", "x-displayname": "Host Name", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_address" ] }, "ip_address": { "type": "string", "description": "Exclusive with [host_name]\nIngress IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "Exclusive with [host_name] Ingress IP Address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ip", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "host_name" ] }, "region": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureLocation" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureIngress", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of bot_infrastructure", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/bot_infrastructureListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureListResponseItem": { "type": "object", "description": "By default a summary of bot_infrastructure is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of bot_infrastructure", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this bot_infrastructure.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this bot_infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this bot_infrastructure.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this bot_infrastructure.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates bot_infrastructure is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates bot_infrastructure is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this bot_infrastructure.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this bot_infrastructure.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this bot_infrastructure.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_infrastructureStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this bot_infrastructure.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this bot_infrastructure.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of bot_infrastructure is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of bot_infrastructure is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructurePolicyMetadata": { "type": "object", "description": "On associated Policy object.", "title": "Policy Metadata", "x-displayname": "Policy", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.PolicyMetadata", "properties": { "name": { "type": "string", "description": "Policy Name.", "title": "Policy Name", "x-displayname": "Policy", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "Policy Version.", "title": "Policy Version", "x-displayname": "Version", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructurePolicyMetadata", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructurePolicyType": { "type": "string", "description": "The type of policy\n\n- ENDPOINT_POLICY: Endpoint Policy\n\n- NETWORK_POLICY: Network Policy\n\n- ALLOWLIST_POLICY: Allowlist Policy.", "title": "PolicyType", "enum": [ "ENDPOINT_POLICY", "NETWORK_POLICY", "ALLOWLIST_POLICY" ], "default": "ENDPOINT_POLICY", "x-displayname": "Policy Type.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.bot_infrastructure.PolicyType", "x-f5xc-description-short": "The type of policy - ENDPOINT_POLICY: Endpoint Policy - NETWORK_POLICY: Network Policy - ALLOWLIST_POLICY: Allowlist Policy.", "x-f5xc-description-medium": "The type of policy - ENDPOINT_POLICY: Endpoint Policy - NETWORK_POLICY: Network Policy - ALLOWLIST_POLICY: Allowlist Policy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructurePolicyType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ENDPOINT_POLICY\"", "example_yaml": "ENDPOINT_POLICY\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureProduction": { "type": "object", "title": "Production", "x-displayname": "Production.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.Production", "properties": { "region_1": { "type": "string", "description": "This is an Active-Active Infrastructure configuration where traffic is routed equally between the two regions.", "title": "Bot Infrastructure Regions", "x-displayname": "Ingress Region 1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Active-Active Infrastructure configuration where traffic is routed equally between the two regions.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "region_2": { "type": "string", "description": "This is an Active-Active Infrastructure configuration where traffic is routed equally between the two regions.", "title": "Bot Infrastructure Regions", "x-displayname": "Ingress Region 2.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Active-Active Infrastructure configuration where traffic is routed equally between the two regions.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureProduction", "required_fields": [ "region_1", "region_2" ], "mutually_exclusive_groups": [], "example_json": "{\n \"region_1\": \"value\",\n \"region_2\": \"value\"\n}", "example_yaml": "region_1: value\nregion_2: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a bot_infrastructure", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defensebot_infrastructureReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureRollbackCertificateToDefaultRequest": { "type": "object", "description": "Request for rollback certificate to default.", "title": "RollbackCertificateToDefaultRequest", "x-displayname": "Rollback Certificate To Default Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.RollbackCertificateToDefaultRequest", "properties": { "name": { "type": "string", "description": "Bot Infrastructure Name.", "title": "Bot Infrastructure Name", "x-displayname": "Bot Infrastructure Name.", "x-ves-example": "Cluster_1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "cluster_1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "region_list": { "type": "array", "description": "List of regions for rollback.", "title": "Region List", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/bot_defensebot_infrastructureLocation" }, "x-displayname": "Region List.", "x-ves-example": "[US_EAST_1, US_WEST_1]", "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.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[US_EAST_1, US_WEST_1]", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for rollback certificate to default.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureRollbackCertificateToDefaultRequest", "required_fields": [ "name", "namespace", "region_list" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"cluster_1\",\n \"namespace\": \"default\",\n \"region_list\": [\n \"AP_NORTHEAST_1\"\n ]\n}", "example_yaml": "name: cluster_1\nnamespace: default\nregion_list:\n- AP_NORTHEAST_1" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureTIPackageInformation": { "type": "object", "description": "The metadata of threat intelligence policy.", "title": "Threat Intelligence Package Metadata", "x-displayname": "Threat Intelligence Package.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.TIPackageInformation", "properties": { "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Threat Intelligence Package Name", "x-displayname": "TI Package Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "The metadata of threat intelligence policy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureTIPackageInformation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureTIPackageMetadata": { "type": "object", "description": "The metadata for TI package, which will be only support for Kubernetes bot infrastructure.", "title": "TI Package Metadata", "x-displayname": "TI Package Metadata.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.TIPackageMetadata", "properties": { "id": { "type": "string", "description": "TI Package ID.", "title": "TI Package ID", "minLength": 1, "x-displayname": "TI Package ID.", "x-ves-example": "1234567", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "1234567", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "TI Package Name.", "title": "TI Package Name", "minLength": 1, "x-displayname": "TI Package Name.", "x-ves-example": "TI_Package_1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "TI_Package_1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "TI Package Version.", "title": "TI Package Version", "x-displayname": "TI Package Version.", "x-ves-example": "1.0", "x-f5xc-example": "1.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "The metadata for TI package, which will be only support for Kubernetes bot infrastructure.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureTIPackageMetadata", "required_fields": [ "id", "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"id\": \"1234567\",\n \"name\": \"TI_Package_1\"\n}", "example_yaml": "id: '1234567'\nname: TI_Package_1" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_infrastructureTesting": { "type": "object", "title": "Testing", "x-displayname": "Testing", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_infrastructure.Testing", "properties": { "region_1": { "type": "string", "description": "This is an Active-Passive Infrastructure configuration where traffic is routed to a single region.", "title": "Bot Infrastructure Regions", "x-displayname": "Ingress Region 1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Active-Passive Infrastructure configuration where traffic is routed to a single region.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_infrastructureTesting", "required_fields": [ "region_1" ], "mutually_exclusive_groups": [], "example_json": "{\n \"region_1\": \"value\"\n}", "example_yaml": "region_1: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "ti_packageBotThreatIntelligencePackage": { "type": "object", "description": "Metadata of Bot Threat Intelligence Package.", "title": "BotThreatIntelligencePackage", "x-displayname": "Bot Threat Intelligence Package.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.ti_package.BotThreatIntelligencePackage", "properties": { "id": { "type": "string", "description": "ID of the bot threat intelligence package.", "title": "ID", "x-displayname": "TI Package ID.", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-description-short": "ID of the bot threat intelligence package.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "package_name": { "type": "string", "description": "Name of the bot threat intelligence package.", "title": "Name", "x-displayname": "TI Package Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the bot threat intelligence package.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of the bot threat intelligence package.", "title": "Version", "x-displayname": "TI Package Version.", "x-f5xc-example": "v1.2.3", "x-f5xc-description-short": "Version of the bot threat intelligence package.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metadata of Bot Threat Intelligence Package.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ti_packageBotThreatIntelligencePackage", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ti_packageListBotThreatIntelligencePackagesResponse": { "type": "object", "description": "Response for list bot threat intelligence packages metadata.", "title": "ListBotThreatIntelligencePackagesResponse", "x-displayname": "List bot threat intelligence packages metadata response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.threat_intelligence.ti_package.ListBotThreatIntelligencePackagesResponse", "properties": { "bot_threat_intelligence_packages": { "type": "array", "description": "Bot Threat Intelligence Package holds details of a threat intelligence package.", "title": "Bot Threat Intelligence Packages", "items": { "$ref": "#/components/schemas/ti_packageBotThreatIntelligencePackage" }, "x-displayname": "Bot Threat Intelligence Packages.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Bot Threat Intelligence Package holds details of a threat intelligence package.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for list bot threat intelligence packages metadata.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ti_packageListBotThreatIntelligencePackagesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_allowlist_policyCustomReplaceRequest": { "type": "object", "title": "CustomReplaceRequest is used to replace contents of a bot_allowlist_policy", "x-displayname": "Custom Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomReplaceRequest", "properties": { "name": { "type": "string", "description": "Name of the policy.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_allowlist_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyCustomReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyCustomReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.CustomReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyCustomReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyGetContentResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.GetContentResponse", "properties": { "allowlist_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseIPAllowlists" } ], "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyGetContentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyGetPoliciesAndVersionsListResponse": { "type": "object", "description": "List All Bot Policies And Versions Response.", "title": "GetPoliciesAndVersionsListResponse", "x-displayname": "List All Bot Policies And Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.GetPoliciesAndVersionsListResponse", "properties": { "policies": { "type": "array", "description": "Policy", "title": "Policy", "items": { "$ref": "#/components/schemas/bot_allowlist_policyPolicy" }, "x-displayname": "Policy", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List All Bot Policies And Versions Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyGetPoliciesAndVersionsListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read bot_allowlist_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/bot_allowlist_policyReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_allowlist_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_allowlist_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyGetSpecType": { "type": "object", "description": "GET Bot allowlist Policy.", "title": "Get Bot allowlist Policy", "x-displayname": "GET Bot allowlist Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.GetSpecType", "properties": { "allowlist_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseIPAllowlists" } ], "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "latest_version": { "type": "string", "x-displayname": "Version", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of bot_allowlist_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/bot_allowlist_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyListResponseItem": { "type": "object", "description": "By default a summary of bot_allowlist_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of bot_allowlist_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this bot_allowlist_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this bot_allowlist_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this bot_allowlist_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this bot_allowlist_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates bot_allowlist_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates bot_allowlist_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/bot_allowlist_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this bot_allowlist_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this bot_allowlist_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this bot_allowlist_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_allowlist_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this bot_allowlist_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this bot_allowlist_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of bot_allowlist_policy is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of bot_allowlist_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyPolicy": { "type": "object", "description": "Policy name and versions.", "title": "Policy", "x-displayname": "Policy", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.Policy", "properties": { "policy_name": { "type": "string", "title": "Policy name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyPolicy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyPolicyVersionsResponse": { "type": "object", "description": "Policy versions response.", "title": "PolicyVersionsResponse", "x-displayname": "Policy Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.PolicyVersionsResponse", "properties": { "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyPolicyVersionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a bot_allowlist_policy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_allowlist_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyReplaceSpecType": { "type": "object", "description": "Replace Bot allowlist Policy.", "title": "Replace Bot allowlist Policy", "x-displayname": "Replace Bot allowlist Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.ReplaceSpecType", "properties": { "allowlist_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseIPAllowlists" } ], "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_allowlist_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_allowlist_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_allowlist_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_defenseIPAllowlistDetail": { "type": "object", "description": "IP Allowlist value.", "title": "IP Allowlist Detail", "x-displayname": "IP & IP Prefix.", "x-ves-oneof-field-client_identifier_choice": "[\"ip_detail\",\"ip_prefix_detail\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.IPAllowlistDetail", "properties": { "ip_detail": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseIPDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_prefix_detail" ] }, "ip_prefix_detail": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseIPPrefixDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_detail" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseIPAllowlistDetail", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseIPAllowlists": { "type": "object", "description": "Allowlist Policy Content.", "title": "Allowlist Policy Content", "x-displayname": "IP Allowlist.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.IPAllowlists", "properties": { "ip_allowlist": { "type": "array", "description": "Allowlist or permitted items", "title": "IP & IP Prefix List", "items": { "$ref": "#/components/schemas/bot_defenseIPAllowlistDetail" }, "x-displayname": "IP & IP Prefix.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_range_allowlist": { "type": "array", "description": "Allowlist or permitted items", "title": "IP Range List", "items": { "$ref": "#/components/schemas/bot_defenseIPRangeAllowlistDetail" }, "x-displayname": "IP Range", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseIPAllowlists", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseIPDetail": { "type": "object", "description": "Support the single IP value.", "title": "IP Detail", "x-displayname": "IP Detail", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.IPDetail", "properties": { "ip_description": { "type": "string", "description": "The description for IP address.", "title": "ip description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_value": { "type": "string", "description": "A single IP address.", "title": "ip value", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseIPDetail", "required_fields": [ "ip_value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_value\": \"value\"\n}", "example_yaml": "ip_value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseIPPrefixDetail": { "type": "object", "description": "Support the IP prefix value.", "title": "IP Prefix Detail", "x-displayname": "IP Prefix Detail.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.IPPrefixDetail", "properties": { "ip_description": { "type": "string", "description": "The description for IP prefix.", "title": "ip description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_value": { "type": "string", "description": "IP prefix e.g. 192.0.2.0/24.", "title": "ip prefix value", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4_prefix": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseIPPrefixDetail", "required_fields": [ "ip_value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_value\": \"value\"\n}", "example_yaml": "ip_value: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseIPRangeAllowlistDetail": { "type": "object", "description": "IP Range Allowlist value.", "title": "IP Range Allowlist Detail", "x-displayname": "IP Range Allowlist.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.IPRangeAllowlistDetail", "properties": { "end_with": { "type": "string", "description": "IP range end with.", "title": "IP end with value", "x-displayname": "End With", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ip_description": { "type": "string", "description": "The description for IP range.", "title": "ip description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_with": { "type": "string", "description": "IP range start with.", "title": "IP start with value", "x-displayname": "Start With.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ipv4": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseIPRangeAllowlistDetail", "required_fields": [ "end_with", "start_with" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_with\": \"value\",\n \"start_with\": \"value\"\n}", "example_yaml": "end_with: value\nstart_with: value" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseManualRoutingDetail": { "type": "object", "description": "Manual Routing value.", "title": "Manual Routing Detail", "x-displayname": "Manual Routing.", "x-ves-oneof-field-domain_operator_choice": "[\"http\",\"https\"]", "x-ves-oneof-field-outbound_operator_choice": "[\"protocol_http\",\"protocol_https\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ManualRoutingDetail", "properties": { "domain_name": { "type": "string", "description": "Inbound FQDN value.", "title": "Fully qualified domain name", "maxLength": 256, "x-displayname": "Inbound FQDN.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9.-]", "description": "Dot-separated DNS labels" }, "format": "hostname", "formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "http": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "https" ] }, "https": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http" ] }, "outbound_domain_name": { "type": "string", "description": "Outbound FQDN or IP value.", "title": "FQDN / IP", "x-displayname": "Outbound FQDN / IP.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "port": { "type": "integer", "description": "Outbound Port value.", "title": "port", "format": "int64", "x-displayname": "Outbound Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol_http": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for protocol http.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "protocol_https" ] }, "protocol_https": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for protocol https.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "protocol_http" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseManualRoutingDetail", "required_fields": [ "domain_name", "outbound_domain_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain_name\": \"example-resource\",\n \"outbound_domain_name\": \"example-resource\"\n}", "example_yaml": "domain_name: example-resource\noutbound_domain_name: example-resource" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseManualRoutings": { "type": "object", "description": "The list of manual routing.", "title": "Manual Routings", "x-displayname": "Manual Routings.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.ManualRoutings", "properties": { "manual_routing": { "type": "array", "description": "Routing or forwarding configuration", "title": "Manual Routing List", "items": { "$ref": "#/components/schemas/bot_defenseManualRoutingDetail" }, "x-displayname": "Manual Routing.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseManualRoutings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseNetworkPolicyContent": { "type": "object", "description": "Network Policy Content.", "title": "Network policy content", "x-displayname": "Network Policy Content.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.NetworkPolicyContent", "properties": { "manual_routing_list": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseManualRoutings" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upstream_routing_list": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseUpstreamRoutings" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseNetworkPolicyContent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseUpstreamRoutingDetail": { "type": "object", "description": "Upstream Routing value.", "title": "Upstream Routing Detail", "x-displayname": "Upstream DNS Routing.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.UpstreamRoutingDetail", "properties": { "domain_name": { "type": "string", "description": "Domain Name.", "title": "Fully qualified domain name", "maxLength": 256, "x-displayname": "FQDN", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example-resource", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9.-]", "description": "Dot-separated DNS labels" }, "format": "hostname", "formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseUpstreamRoutingDetail", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseUpstreamRoutings": { "type": "object", "description": "Upstream DNS Routings.", "title": "Upstream DNS Routings", "x-displayname": "Upstream Routings.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.UpstreamRoutings", "properties": { "upstream_routing": { "type": "array", "description": "Routing or forwarding configuration", "title": "Upstream Routing List", "items": { "$ref": "#/components/schemas/bot_defenseUpstreamRoutingDetail" }, "x-displayname": "Upstream Routing.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseUpstreamRoutings", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_network_policyCustomReplaceRequest": { "type": "object", "title": "CustomReplaceRequest is used to replace contents of a bot_network_policy", "x-displayname": "Custom Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomReplaceRequest", "properties": { "name": { "type": "string", "description": "Name of the policy.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_network_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyCustomReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyCustomReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.CustomReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyCustomReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyGetContentResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.GetContentResponse", "properties": { "network_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseNetworkPolicyContent" } ], "x-f5xc-description-short": "Configuration parameter for network policy content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyGetContentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyGetPoliciesAndVersionsListResponse": { "type": "object", "description": "List All Bot Policies And Versions Response.", "title": "GetPoliciesAndVersionsListResponse", "x-displayname": "List All Bot Policies And Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.GetPoliciesAndVersionsListResponse", "properties": { "policies": { "type": "array", "description": "Policy", "title": "Policy", "items": { "$ref": "#/components/schemas/bot_network_policyPolicy" }, "x-displayname": "Policy", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List All Bot Policies And Versions Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyGetPoliciesAndVersionsListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read bot_network_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/bot_network_policyReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_network_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_network_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyGetSpecType": { "type": "object", "description": "GET Bot network Policy.", "title": "Get Bot network Policy", "x-displayname": "GET Bot network Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.GetSpecType", "properties": { "latest_version": { "type": "string", "x-displayname": "Version", "description": "Version number or identifier", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseNetworkPolicyContent" } ], "x-f5xc-description-short": "Configuration parameter for network policy content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-recommended-oneof-variant": { "endpoint_choice": "any" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of bot_network_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/bot_network_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyListResponseItem": { "type": "object", "description": "By default a summary of bot_network_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of bot_network_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this bot_network_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this bot_network_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this bot_network_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this bot_network_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates bot_network_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates bot_network_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/bot_network_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this bot_network_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this bot_network_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this bot_network_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/bot_network_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this bot_network_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this bot_network_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of bot_network_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of bot_network_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyPolicy": { "type": "object", "description": "Policy name and versions.", "title": "Policy", "x-displayname": "Policy", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.Policy", "properties": { "policy_name": { "type": "string", "title": "Policy name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyPolicy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyPolicyVersionsResponse": { "type": "object", "description": "Policy versions response.", "title": "PolicyVersionsResponse", "x-displayname": "Policy Versions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.PolicyVersionsResponse", "properties": { "policy_versions": { "type": "array", "description": "Policy Versions.", "title": "Policy Versions", "items": { "$ref": "#/components/schemas/bot_defensePolicyVersion" }, "x-displayname": "Policy Versions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyPolicyVersionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a bot_network_policy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_network_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyReplaceSpecType": { "type": "object", "description": "Replace Bot network Policy.", "title": "Replace Bot network Policy", "x-displayname": "Replace Bot network Policy.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.ReplaceSpecType", "properties": { "network_policy_content": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseNetworkPolicyContent" } ], "x-f5xc-description-short": "Configuration parameter for network policy content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-recommended-oneof-variant": { "endpoint_choice": "any" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "bot_network_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.bot_network_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_network_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "client_side_defenseACTION_TYPE": { "type": "string", "description": "Type of Action\n\n- BLOCK: BLOCK\nBlock Form Field Read\n- ALLOW: ALLOW\nAllow Form Field Read.", "title": "ACTION_TYPE", "enum": [ "BLOCK", "ALLOW" ], "default": "BLOCK", "x-displayname": "Action type.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ACTION_TYPE", "x-f5xc-example": "BLOCK", "x-f5xc-description-short": "Type of Action - BLOCK: BLOCK Block Form Field Read - ALLOW: ALLOW Allow Form Field Read.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseACTION_TYPE", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BLOCK\"", "example_yaml": "BLOCK\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseANALYSIS_TYPE": { "type": "string", "description": "Type of Analysis\n\n- SENSITIVE: SENSITIVE\nMark field as sensitive\n- NOT_SENSITIVE: NOT_SENSITIVE\nMark field as not sensitive.", "title": "ANALYSIS_TYPE", "enum": [ "SENSITIVE", "NOT_SENSITIVE" ], "default": "SENSITIVE", "x-displayname": "Analysis type.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ANALYSIS_TYPE", "x-f5xc-example": "SENSITIVE", "x-f5xc-description-short": "Type of Analysis - SENSITIVE: SENSITIVE Mark field as sensitive - NOT_SENSITIVE: NOT_SENSITIVE Mark field as not sensitive.", "x-f5xc-description-medium": "Type of Analysis - SENSITIVE: SENSITIVE Mark field as sensitive - NOT_SENSITIVE: NOT_SENSITIVE Mark field as not sensitive.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseANALYSIS_TYPE", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SENSITIVE\"", "example_yaml": "SENSITIVE\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAddToAllowedDomains": { "type": "object", "description": "Add To Allowed Domains.", "title": "AddToAllowedDomains", "x-displayname": "Add To Allowed Domains.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AddToAllowedDomains", "properties": { "domains": { "type": "array", "description": "Domains are added to allowed list.", "title": "Domains", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Domains", "x-ves-example": "['company1.com', 'company2.com']", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-example": "['company1.com', 'company2.com']", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAddToAllowedDomains", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAddToMitigatedDomains": { "type": "object", "description": "Add To Mitigated Domains.", "title": "AddToMitigatedDomains", "x-displayname": "Add To Mitigated Domains.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AddToMitigatedDomains", "properties": { "domains": { "type": "array", "description": "Domains are added to mitigated list.", "title": "Domains", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Domains", "x-ves-example": "['example1.com', 'example2.com']", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-example": "['example1.com', 'example2.com']", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAddToMitigatedDomains", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUser": { "type": "object", "description": "Information about the affected user.", "title": "AffectedUser", "x-displayname": "Affected User.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUser", "properties": { "channel": { "type": "string", "description": "Channel of access to script by affected user.", "title": "channel", "x-displayname": "Channel", "x-ves-example": "Web", "x-f5xc-example": "Web", "x-f5xc-description-short": "Channel of access to script by affected user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device_id": { "type": "string", "description": "Device ID of the affected user.", "title": "device_id", "x-displayname": "Device ID", "x-ves-example": "AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==.", "x-f5xc-example": "AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "geolocation": { "type": "string", "description": "Geolocation of the affected user.", "title": "Geolocation", "x-displayname": "Geolocation.", "x-ves-example": "Singapore", "x-f5xc-example": "Singapore", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_address": { "type": "string", "description": "IP address of the affected user.", "title": "ip_address", "x-displayname": "IP Address.", "x-ves-example": "236.171.56.51.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "236.171.56.51", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ip", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast seen time.", "title": "last_seen", "x-displayname": "Last Seen", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_agent": { "type": "string", "description": "User agent of affected user.", "title": "user_agent", "x-displayname": "User Agent.", "x-ves-example": "Mozilla/5.0 (Macintosh; Intel MAC OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/192.0.2.183 Safari/537.36.", "x-f5xc-example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/192.0.2.183 Safari/537.36", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUser", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUserDeviceIDFilter": { "type": "object", "description": "Filter by affected user device ID.", "title": "AffectedUserDeviceIDFilter", "x-displayname": "Affected User Device ID Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUserDeviceIDFilter", "properties": { "device_ids": { "type": "array", "description": "An unordered list of device IDs.", "title": "device_ids", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Device IDs.", "x-ves-example": "['AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['AX1WztsA3QWQZgDzZ+SAABrPL8U59+cMx4vwxQ==']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUserDeviceIDFilter", "required_fields": [ "device_ids" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device_ids\": [\n \"value\"\n ]\n}", "example_yaml": "device_ids:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUserFilters": { "type": "object", "description": "ListAffectedUsers API query filters.", "title": "AffectedUserFilters", "x-displayname": "Affected User Filters.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUserFilters", "properties": { "affected_user_device_id_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAffectedUserDeviceIDFilter" } ], "x-f5xc-description-short": "Configuration parameter for affected user device id filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "affected_user_geolocation_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAffectedUserGeolocationFilter" } ], "x-f5xc-description-short": "Configuration parameter for affected user geolocation filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "affected_user_ip_address_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAffectedUserIPAddressFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUserFilters", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUserGeolocationFilter": { "type": "object", "description": "Filter by affected user geolocation.", "title": "AffectedUserGeolocationFilter", "x-displayname": "Affected User Geolocation Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUserGeolocationFilter", "properties": { "geolocations": { "type": "array", "description": "An unordered list of geolocations.", "title": "geolocations", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Geolocations.", "x-ves-example": "['Singapore']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Singapore']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUserGeolocationFilter", "required_fields": [ "geolocations" ], "mutually_exclusive_groups": [], "example_json": "{\n \"geolocations\": [\n \"value\"\n ]\n}", "example_yaml": "geolocations:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUserIPAddressFilter": { "type": "object", "description": "Filter by affected user IP address.", "title": "AffectedUserIPAddressFilter", "x-displayname": "Affected User IP Address Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUserIPAddressFilter", "properties": { "ip_addresses": { "type": "array", "description": "An unordered list of IP addresses.", "title": "ip_addresses", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "IP Addresses.", "x-ves-example": "['236.171.56.51']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['236.171.56.51']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUserIPAddressFilter", "required_fields": [ "ip_addresses" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_addresses\": [\n \"value\"\n ]\n}", "example_yaml": "ip_addresses:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAffectedUsersReportCriteria": { "type": "object", "description": "Criteria to generate an affected users report.", "title": "AffectedUsersReportCriteria", "x-displayname": "Affected Users Report Criteria.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.AffectedUsersReportCriteria", "properties": { "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nFetch users whose timestamp <= end_time.", "title": "end_time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194300", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds Fetch users whose timestamp <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "type": "array", "description": "Additional filters for the query.", "title": "filters", "items": { "$ref": "#/components/schemas/client_side_defenseReportFilter" }, "x-displayname": "Filters", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_id": { "type": "string", "description": "Script ID to filter affected users by.", "title": "script_id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-f5xc-example": "s-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nFetch users whose timestamp >= start_time.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds Fetch users whose timestamp >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Criteria to generate an affected users report.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAffectedUsersReportCriteria", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseAnalysis": { "type": "object", "description": "Analysis of the form field by Client Side Defense.", "title": "Analysis", "x-displayname": "Analysis", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Analysis", "properties": { "updated_by": { "type": "string", "description": "Updated by.", "title": "updated_by", "x-displayname": "Updated By.", "x-ves-example": "System", "x-f5xc-example": "system", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Value of the form field analysed by Client side defense.", "title": "value", "x-displayname": "Value", "x-ves-example": "Sensitive", "x-f5xc-example": "Sensitive", "x-f5xc-description-short": "Value of the form field analysed by Client side defense.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Analysis of the form field by Client Side Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseAnalysis", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseApprovalStatusCounts": { "type": "object", "description": "Count of scripts by approval status.", "title": "ApprovalStatusCounts", "x-displayname": "Approval Status Counts.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ApprovalStatusCounts", "properties": { "approved": { "type": "integer", "description": "Number of approved scripts.", "title": "approved", "format": "int32", "x-displayname": "Approved", "x-ves-example": "50", "x-f5xc-example": "50", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rejected": { "type": "integer", "description": "Number of rejected scripts.", "title": "rejected", "format": "int32", "x-displayname": "Rejected", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unapproved": { "type": "integer", "description": "Number of unapproved scripts (null or not set)", "title": "unapproved", "format": "int32", "x-displayname": "Unapproved.", "x-ves-example": "40", "x-f5xc-example": "40", "x-f5xc-description-short": "Number of unapproved scripts (null or not set).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseApprovalStatusCounts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseApprovalStatusFilter": { "type": "object", "description": "Query Filter by approval status filter strings.", "title": "Approval Status Filter", "x-displayname": "Approval Status Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ApprovalStatusFilter", "properties": { "approval_status_strings": { "type": "array", "description": "An unordered list of approval status strings.", "title": "Approval Status Strings", "minItems": 1, "maxItems": 10, "items": { "type": "string", "maxLength": 32 }, "x-displayname": "Approval Status Strings.", "x-ves-example": "['APPROVED', 'REJECTED']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['APPROVED', 'REJECTED']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Unordered list of approval status strings.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 10, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by approval status filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseApprovalStatusFilter", "required_fields": [ "approval_status_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"approval_status_strings\": [\n \"value\"\n ]\n}", "example_yaml": "approval_status_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseBehaviorByScript": { "type": "object", "description": "Behavior info.", "title": "BehaviorByScript", "x-displayname": "Behavior", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.BehaviorByScript", "properties": { "category": { "type": "string", "description": "Category of the behavior.", "title": "category", "x-displayname": "Category", "x-ves-example": "Network", "x-f5xc-example": "Network", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst seen time.", "title": "first_seen", "x-displayname": "First Seen.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast seen time.", "title": "last_seen", "x-displayname": "Last Seen", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the behavior.", "title": "name", "x-displayname": "Name", "x-ves-example": "marvel.com.", "x-f5xc-example": "marvel.com", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "recommendation": { "type": "string", "description": "Recommendation of the behavior by Client Side Defense.", "title": "recommendation", "x-displayname": "Recommendation.", "x-ves-example": "We recommend checking the script's source/destination and consider immediate removal of the script.", "x-f5xc-example": "We recommend checking the script's source/destination and consider immediate removal of the script", "x-f5xc-description-short": "Recommendation of the behavior by Client Side Defense.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk_level": { "type": "string", "description": "Risk level of the element read by script.", "title": "risk_level", "x-displayname": "Risk Level.", "x-ves-example": "High Risk", "x-f5xc-example": "High Risk", "x-f5xc-description-short": "Risk level of the element read by script.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "users_affected": { "type": "integer", "description": "Users affected by the behavior of the script.", "title": "users_affected", "format": "int32", "x-displayname": "Users Affected.", "x-f5xc-example": "32", "x-f5xc-description-short": "Users affected by the behavior of the script.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseBehaviorByScript", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseBehaviorMetrics": { "type": "object", "description": "Script behavior metrics from summary tables.", "title": "BehaviorMetrics", "x-displayname": "Behavior Metrics.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.BehaviorMetrics", "properties": { "scripts_with_form_field_reads": { "type": "integer", "description": "Number of scripts that read form fields.", "title": "scripts_with_form_field_reads", "format": "int32", "x-displayname": "Scripts With Form Field Reads.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of scripts that read form fields.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scripts_with_network_interactions": { "type": "integer", "description": "Number of scripts with network interactions.", "title": "scripts_with_network_interactions", "format": "int32", "x-displayname": "Scripts With Network Interactions.", "x-ves-example": "45", "x-f5xc-example": "45", "x-f5xc-description-short": "Number of scripts with network interactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scripts_with_new_behaviors": { "type": "integer", "description": "Number of scripts with new behaviors detected.", "title": "scripts_with_new_behaviors", "format": "int32", "x-displayname": "Scripts With New Behaviors.", "x-ves-example": "15", "x-f5xc-example": "15", "x-f5xc-description-short": "Number of scripts with new behaviors detected.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Script behavior metrics from summary tables.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseBehaviorMetrics", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseBulkDeleteDomainsRequest": { "type": "object", "description": "Request to bulk DELETE domains from allow list or mitigated list.", "title": "BulkDeleteDomainsRequest", "x-displayname": "Bulk DELETE Domains Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.BulkDeleteDomainsRequest", "properties": { "allow_list": { "type": "array", "description": "List of domains to DELETE from allow list.", "title": "allow_list", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Allow List Domains.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-description-short": "List of domains to DELETE from allow list.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_list": { "type": "array", "description": "List of domains to DELETE from mitigated list.", "title": "mitigated_list", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Mitigated List Domains.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-description-short": "List of domains to DELETE from mitigated list.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to bulk DELETE domains from allow list or mitigated list.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseBulkDeleteDomainsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseBulkDeleteDomainsResponse": { "type": "object", "description": "Response after bulk deleting domains.", "title": "BulkDeleteDomainsResponse", "x-displayname": "Bulk DELETE Domains Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.BulkDeleteDomainsResponse", "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the domains were successfully deleted.", "title": "deleted", "format": "boolean", "x-displayname": "Deleted", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Indicates whether the domains were successfully deleted.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseBulkDeleteDomainsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseCreateReportRequest": { "type": "object", "description": "Request to create a report configuration.", "title": "CreateReportRequest", "x-displayname": "Create Report Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.CreateReportRequest", "properties": { "generate_on_create": { "type": "boolean", "description": "Automatically generate report upon creation.", "title": "generate_on_create", "format": "boolean", "x-displayname": "Generate On Create.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Automatically generate report upon creation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "report_criteria": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportCriteria" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_name": { "type": "string", "description": "Human-readable name for the report.", "title": "report_name", "minLength": 1, "maxLength": 255, "x-displayname": "Report Name.", "x-ves-example": "Monthly Script Analysis.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "Monthly Script Analysis", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 255, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "report_type": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to create a report configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseCreateReportRequest", "required_fields": [ "report_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"report_name\": \"Monthly Script Analysis\"\n}", "example_yaml": "report_name: Monthly Script Analysis" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseCreateReportResponse": { "type": "object", "description": "Response after creating a report.", "title": "CreateReportResponse", "x-displayname": "Create Report Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.CreateReportResponse", "properties": { "report": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReport" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseCreateReportResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseDeleteScriptJustificationResponse": { "type": "object", "description": "Response to DELETE script justification.", "title": "DeleteScriptJustificationResponse", "x-displayname": "DELETE script justification response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.DeleteScriptJustificationResponse", "x-f5xc-description-short": "Response to DELETE script justification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseDeleteScriptJustificationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseDeviceIDFilter": { "type": "object", "description": "Query Filter by device ID filter strings.", "title": "Device ID Filter", "x-displayname": "Device ID Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.DeviceIDFilter", "properties": { "device_id_strings": { "type": "array", "description": "An unordered list of Device ID strings.", "title": "Device ID Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Device ID Strings.", "x-ves-example": "['device123']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['device123']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by device ID filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseDeviceIDFilter", "required_fields": [ "device_id_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"device_id_strings\": [\n \"value\"\n ]\n}", "example_yaml": "device_id_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseDomainDetails": { "type": "object", "description": "Client-Side defense usage details per domain.", "title": "DomainDetails", "x-displayname": "Domain details.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.DomainDetails", "properties": { "actionDate": { "type": "string", "description": "Date when an action was required.", "title": "ActionDate", "format": "int64", "x-displayname": "Action Date.", "x-f5xc-example": "1629839825497", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category": { "type": "string", "description": "Human readable category description.", "title": "Category", "x-displayname": "Category", "x-ves-example": "Web hosting.", "x-f5xc-example": "Web hosting", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Name of the domain the details are for.", "title": "Domain", "x-displayname": "Domain", "x-ves-example": "www.some-domain.com.", "x-f5xc-example": "www.some-domain.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "firstSeenDate": { "type": "string", "description": "Date the domain was seen the first time (data was collected for the site)", "title": "FirstSeenDate", "format": "int64", "x-displayname": "First Seen Date.", "x-f5xc-example": "1629839825497", "x-f5xc-description-short": "Date the domain was seen the first time (data was collected for the site).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "latestSeenDate": { "type": "string", "description": "Date the domain was seen the latest time (last time data was collected for the site)", "title": "latestSeenDate", "format": "int64", "x-displayname": "Latest Seen Date.", "x-f5xc-example": "1629839825497", "x-f5xc-description-short": "Date the domain was seen the latest time (last time data was collected for the site).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locations": { "type": "array", "description": "List of location -> scripts data\nLocation will returned only when risk filter is applied.", "title": "Locations", "items": { "$ref": "#/components/schemas/shapeclient_side_defenseLocation" }, "x-displayname": "Locations", "x-f5xc-description-short": "List of location -> scripts data Location will returned only when risk filter is applied.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "riskReason": { "type": "array", "description": "List of risk reasons in a human readable form.", "title": "RiskReasons", "items": { "type": "string" }, "x-displayname": "Risk Reasons.", "x-ves-example": "['Unusual number of DNS record','Has less HTTPS certificate related info']", "x-f5xc-example": "['Unusual number of DNS record','Has less Https certificate related info']", "x-f5xc-description-short": "List of risk reasons in a human readable form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "riskScore": { "type": "integer", "description": "Domain reputation score - the bigger the better.", "title": "ReputationScore", "format": "int32", "x-displayname": "Reputation Score.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Domain reputation score - the bigger the better.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Human readable status description.", "title": "Status", "x-displayname": "Status", "x-ves-example": "Action Needed.", "x-f5xc-example": "Action Needed", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Client-Side defense usage details per domain.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseDomainDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseDomainSummary": { "type": "object", "description": "Collection of aggregated details.", "title": "DomainSummary", "x-displayname": "Domain Summary.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.DomainSummary", "properties": { "actionNeededCount": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseUpdatedCount" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "allowedDomains": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseUpdatedCount" } ], "x-f5xc-description-short": "Configuration parameter for allowedDomains.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigatedDomains": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseUpdatedCount" } ], "x-f5xc-description-short": "Configuration parameter for mitigatedDomains.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalDomains": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseUpdatedCount" } ], "x-f5xc-description-short": "Configuration parameter for totalDomains.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseDomainSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseEnterpriseInfo": { "type": "object", "description": "Additional Information about the Enterprise.", "title": "EnterpriseInfo", "x-displayname": "Enterprise Info.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.EnterpriseInfo", "properties": { "transactionCount": { "type": "integer", "description": "Usage transaction count.", "title": "transactionCount", "format": "int32", "x-displayname": "TransactionCount.", "x-f5xc-example": "100", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Additional Information about the Enterprise.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseEnterpriseInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseEvent": { "type": "object", "description": "Event Info.", "title": "Event", "x-displayname": "Event", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Event", "properties": { "date": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nDate of the event.", "title": "date", "x-displayname": "Date", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Date of the event.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 10, "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "format": "date", "formatDescription": "ISO 8601 date (e.g., 2026-01-19)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "existing_behavior": { "type": "integer", "description": "Number of existing behaviors.", "title": "existing_behavior", "format": "int32", "x-displayname": "Existing Behavior.", "x-f5xc-example": "15", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "new_behavior": { "type": "integer", "description": "Number of new behaviors.", "title": "new_behavior", "format": "int32", "x-displayname": "New Behavior.", "x-f5xc-example": "12", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseEvent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFilterOperator": { "type": "string", "description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values.", "title": "Filter Operator", "enum": [ "IN" ], "default": "IN", "x-displayname": "Filter Operator.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.FilterOperator", "x-f5xc-example": "IN or NOT_IN", "x-f5xc-description-short": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFilterOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IN or NOT_IN\"", "example_yaml": "IN or NOT_IN\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFilters": { "type": "object", "description": "ListScripts API query filters.", "title": "Filters", "x-displayname": "Filters", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Filters", "properties": { "approval_status_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseApprovalStatusFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device_id_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseDeviceIDFilter" } ], "x-f5xc-description-short": "Configuration parameter for device id filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "ip_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseIPFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk_level_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseRiskLevelFilter" } ], "x-f5xc-description-short": "Configuration parameter for risk level filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_name_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseScriptNameFilter" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_status_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseScriptStatusFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFilters", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFormField": { "type": "object", "description": "Form field info of all the scripts.", "title": "FormField", "x-displayname": "Form Field.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.FormField", "properties": { "analysis": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAnalysis" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "associated_scripts": { "type": "array", "description": "Associated script which read the form field first.", "title": "associated_scripts", "items": { "type": "string" }, "x-displayname": "Associated Scripts.", "x-ves-example": "['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']", "x-f5xc-example": "['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']", "x-f5xc-description-short": "Associated script which read the form field first.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_read": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst read time.", "title": "first_read", "x-displayname": "First Read.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First read time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the form field.", "title": "id", "x-displayname": "ID", "x-ves-example": "F-ssabcde", "x-f5xc-example": "f-ssabcde", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_read": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast read time.", "title": "last_read", "x-displayname": "Last Read", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last read time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locations": { "type": "array", "description": "Locations where the form field is present.", "title": "locations", "items": { "type": "string" }, "x-displayname": "Locations", "x-ves-example": "['marvel.com','jsp.com']", "x-f5xc-example": "['marvel.com','jsp.com']", "x-f5xc-description-short": "Locations where the form field is present.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the form field.", "title": "name", "x-displayname": "Name", "x-ves-example": "Username", "x-f5xc-example": "username", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFormField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFormFieldAnalysisFilter": { "type": "object", "description": "Query Filter by form field analysis filter strings.", "title": "Form Field Analysis Filter", "x-displayname": "Form Field Analysis Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.FormFieldAnalysisFilter", "properties": { "analysis_strings": { "type": "array", "description": "An unordered list of script status strings.", "title": "Script Status Strings", "minItems": 1, "maxItems": 10, "items": { "type": "string", "maxLength": 128 }, "x-displayname": "Form Field Analysis Strings.", "x-ves-example": "['Sensitive (by System)', 'Not Sensitive (by user)', 'Not Sensitive (by system)']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "128", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Sensitive (by System)', 'Not Sensitive (by user)', 'Not Sensitive (by system)']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "128", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Unordered list of script status strings.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 10, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by form field analysis filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFormFieldAnalysisFilter", "required_fields": [ "analysis_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"analysis_strings\": [\n \"value\"\n ]\n}", "example_yaml": "analysis_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFormFieldByScript": { "type": "object", "description": "Form field information filtered by script.", "title": "FormFieldByScript", "x-displayname": "Form field by script.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.FormFieldByScript", "properties": { "first_read": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst read time of the form field by the script.", "title": "first_read", "x-displayname": "First Read.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First read time of the form field by the script.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the form field.", "title": "id", "x-displayname": "ID", "x-ves-example": "F-ssabcde", "x-f5xc-example": "f-ssabcde", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_read": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast read time of the form field by the script.", "title": "last_read", "x-displayname": "Last Read", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last read time of the form field by the script.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the form field.", "title": "name", "x-displayname": "Name", "x-ves-example": "Password", "x-f5xc-example": "password", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "risk_level": { "type": "string", "description": "Risk level of the form field read by script.", "title": "risk_level", "x-displayname": "Risk Level.", "x-ves-example": "High Risk", "x-f5xc-example": "High Risk", "x-f5xc-description-short": "Risk level of the form field read by script.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Form field information filtered by script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFormFieldByScript", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFormFieldNameFilter": { "type": "object", "description": "Query Filter by form field name filter strings.", "title": "Form Field Name Filter", "x-displayname": "Form Field Name Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.FormFieldNameFilter", "properties": { "name_strings": { "type": "array", "description": "An unordered list of form field name strings.", "title": "Script Name Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Form Field Name Strings.", "x-ves-example": "['lname']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['lname']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Unordered list of form field name strings.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by form field name filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFormFieldNameFilter", "required_fields": [ "name_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name_strings\": [\n \"value\"\n ]\n}", "example_yaml": "name_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseFormFieldsFilters": { "type": "object", "description": "ListFormFields API query filters.", "title": "Filters", "x-displayname": "Filters", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.FormFieldsFilters", "properties": { "form_field_analysis_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFormFieldAnalysisFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "form_field_name_filter": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFormFieldNameFilter" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseFormFieldsFilters", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetDetectedDomainsResponse": { "type": "object", "description": "GET detected domains monitoring data.", "title": "GetDetectedDomainsResponse", "x-displayname": "GET Domains Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetDetectedDomainsResponse", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseEnterpriseInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_summary": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseDomainSummary" } ], "x-f5xc-description-short": "Configuration parameter for domain summary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domains_list": { "type": "array", "description": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated)", "title": "domains_list", "items": { "$ref": "#/components/schemas/client_side_defenseDomainDetails" }, "x-displayname": "Domains List.", "x-f5xc-description-short": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated).", "x-f5xc-description-medium": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location_list": { "type": "object", "description": "\"location URL -> protection flag\" map.", "title": "location_list", "x-displayname": "Location List.", "x-ves-example": "{'www.some-domain.com/reset-password': true,'www.some-domain.com/login': false}", "x-f5xc-example": "{'www.some-domain.com/reset-password'true,'www.some-domain.com/login': false}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of domains to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of domains to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of domains available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of domains available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetDetectedDomainsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetDomainDetailsResponse": { "type": "object", "description": "GET domain details for the domain.", "title": "GetDomainDetailsResponse", "x-displayname": "GET Domains Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetDomainDetailsResponse", "properties": { "actionDate": { "type": "string", "description": "Date when an action was required.", "title": "ActionDate", "format": "int64", "x-displayname": "Action Date.", "x-f5xc-example": "1629839825497", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category": { "type": "string", "description": "Human readable category description.", "title": "Category", "x-displayname": "Category", "x-ves-example": "Web hosting.", "x-f5xc-example": "Web hosting", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Name of the domain the details are for.", "title": "Domain", "x-displayname": "Domain", "x-ves-example": "www.some-domain.com.", "x-f5xc-example": "www.some-domain.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "firstSeenDate": { "type": "string", "description": "Date the domain was seen the first time (data was collected for the site)", "title": "FirstSeenDate", "format": "int64", "x-displayname": "First Seen Date.", "x-f5xc-example": "1629839825497", "x-f5xc-description-short": "Date the domain was seen the first time (data was collected for the site).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "latestSeenDate": { "type": "string", "description": "Date the domain was seen the latest time (last time data was collected for the site)", "title": "latestSeenDate", "format": "int64", "x-displayname": "Latest Seen Date.", "x-f5xc-example": "1629839825497", "x-f5xc-description-short": "Date the domain was seen the latest time (last time data was collected for the site).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locations": { "type": "array", "description": "List of location -> scripts data\nLocation will returned only when risk filter is applied.", "title": "Locations", "items": { "$ref": "#/components/schemas/shapeclient_side_defenseLocation" }, "x-displayname": "Locations", "x-f5xc-description-short": "List of location -> scripts data Location will returned only when risk filter is applied.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "riskReason": { "type": "array", "description": "List of risk reasons in a human readable form.", "title": "RiskReasons", "items": { "type": "string" }, "x-displayname": "Risk Reasons.", "x-ves-example": "['Unusual number of DNS record','Has less HTTPS certificate related info']", "x-f5xc-example": "['Unusual number of DNS record','Has less Https certificate related info']", "x-f5xc-description-short": "List of risk reasons in a human readable form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "riskScore": { "type": "integer", "description": "Domain reputation score - the bigger the better.", "title": "ReputationScore", "format": "int32", "x-displayname": "Reputation Score.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Domain reputation score - the bigger the better.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Human readable status description.", "title": "Status", "x-displayname": "Status", "x-ves-example": "Action Needed.", "x-f5xc-example": "Action Needed", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetDomainDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetDownloadReportPresignedUrlResponse": { "type": "object", "description": "Response with a presigned download URL.", "title": "GetDownloadReportPresignedUrlResponse", "x-displayname": "GET Report Download URL Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetDownloadReportPresignedUrlResponse", "properties": { "expires_in_seconds": { "type": "string", "description": "URL expiration in seconds.", "title": "expires_in_seconds", "format": "int64", "x-displayname": "Expires In Seconds.", "x-ves-example": "600", "x-f5xc-example": "600", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "presigned_url": { "type": "string", "description": "Presigned URL for report download.", "title": "presigned_url", "x-displayname": "Presigned URL.", "x-ves-example": "https://storage.googleapis.com/...", "x-f5xc-example": "https://storage.googleapis.com/...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetDownloadReportPresignedUrlResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetFormFieldResponse": { "type": "object", "description": "Response to GET form field.", "title": "GetFormFieldResponse", "x-displayname": "GET Form Field Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetFormFieldResponse", "properties": { "associated_scripts": { "type": "array", "description": "Associated scripts of the form field.", "title": "associated_scripts", "items": { "type": "string" }, "x-displayname": "Associated Scripts.", "x-ves-example": "['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']", "x-f5xc-example": "['https://www.googleanalytics.com/analytics.js','https://www.googletagmanager.com/gtm.js']", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the form field.", "title": "id", "x-displayname": "ID", "x-ves-example": "F-ssabcde", "x-f5xc-example": "f-ssabcde", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the form field.", "title": "name", "x-displayname": "Name", "x-ves-example": "Username", "x-f5xc-example": "username", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetFormFieldResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetJsInjectionConfigurationResponse": { "type": "object", "description": "Response to a GET injection script request.", "title": "GetJsInjectionConfigurationResponse", "x-displayname": "GET injection configuration response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetJsInjectionConfigurationResponse", "properties": { "scriptTag": { "type": "string", "description": "Javascript tag injected to URL paths that user configures.", "title": "Script Tag", "x-displayname": "Script Tag.", "x-ves-example": "<script type=”text/javascript” src=”https://dip.zeronaught.com/js/0987654.js”></script>", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "Javascript tag injected to URL paths that user configures.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to a GET injection script request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetJsInjectionConfigurationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetScriptOverviewResponse": { "type": "object", "description": "Response to GET script overview.", "title": "GetScriptOverviewResponse", "x-displayname": "GET script overview response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetScriptOverviewResponse", "properties": { "events": { "type": "array", "description": "Event info of the dashboard of the script.", "title": "events", "items": { "$ref": "#/components/schemas/client_side_defenseEvent" }, "x-displayname": "Events", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Event info of the dashboard of the script.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseSummary" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetScriptOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetScriptsOverviewResponse": { "type": "object", "description": "Response with aggregated script metrics and counts.", "title": "GetScriptsOverviewResponse", "x-displayname": "GET Scripts Overview Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetScriptsOverviewResponse", "properties": { "approval_status_counts": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseApprovalStatusCounts" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "behavior_metrics": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseBehaviorMetrics" } ], "x-f5xc-description-short": "Configuration parameter for behavior metrics.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigation_status_counts": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseMitigationStatusCounts" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_scripts": { "type": "integer", "description": "Total number of scripts in the time range.", "title": "total_scripts", "format": "int32", "x-displayname": "Total Scripts.", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Total number of scripts in the time range.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response with aggregated script metrics and counts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetScriptsOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetStatusResponse": { "type": "object", "description": "GET status of Client-Side Defense Configuration.", "title": "GetStatusResponse", "x-displayname": "GET Config Status Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetStatusResponse", "properties": { "isConfigured": { "type": "boolean", "description": "Client-Side defense service is configured or not.", "title": "isConfigured", "format": "boolean", "x-displayname": "IsConfigured.", "x-f5xc-example": "true", "x-f5xc-description-short": "Client-Side defense service is configured or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "isEnabled": { "type": "boolean", "description": "Client-Side defense service is enabled or not.", "title": "isEnabled", "format": "boolean", "x-displayname": "IsEnabled", "x-f5xc-example": "true", "x-f5xc-description-short": "Client-Side defense service is enabled or not.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET status of Client-Side Defense Configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseGetSummaryResponse": { "type": "object", "description": "Response to GET summary.", "title": "GetSummaryResponse", "x-displayname": "GET Summary Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.GetSummaryResponse", "properties": { "blocked_scripts": { "type": "integer", "description": "Number of blocked scripts.", "title": "blocked_scripts", "format": "int32", "x-displayname": "Blocked Scripts count.", "x-f5xc-example": "11", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_domains": { "type": "integer", "description": "Number of mitigated domains.", "title": "mitigated_domains", "format": "int32", "x-displayname": "Mitigated Domains count.", "x-f5xc-example": "5", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suspicious_scripts": { "type": "integer", "description": "Count of the suspicious scripts.", "title": "suspicious_scripts", "format": "int32", "x-displayname": "High Risk scripts.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseGetSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseIPFilter": { "type": "object", "description": "Query Filter by IP address filter strings.", "title": "IP Filter", "x-displayname": "IP Address Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.IPFilter", "properties": { "ip_strings": { "type": "array", "description": "An unordered list of IP address strings.", "title": "IP Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "IP Address Strings.", "x-ves-example": "['192.0.2.198']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['192.0.2.198']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ip": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by IP address filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseIPFilter", "required_fields": [ "ip_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_strings\": [\n \"value\"\n ]\n}", "example_yaml": "ip_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseInitRequest": { "type": "object", "description": "Any payload to be passed on the Provision API.", "title": "InitRequest", "x-displayname": "Enable Client-Side Defense Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.InitRequest", "properties": { "email": { "type": "string", "description": "Email Address for Notifications.", "title": "Email Address for Notifications", "x-displayname": "Email Address for Notifications.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.email": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.email": "true", "ves.io.schema.rules.string.not_empty": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "serviceType": { "type": "string", "description": "CSD service type.", "title": "Service Type", "x-displayname": "Service Type.", "x-ves-example": "Csd-service.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"csd-service\\\"]" }, "x-f5xc-example": "csd-service", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"csd-service\\\"]" }, "maxLength": 1024, "enum": [ "csd-service" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseInitRequest", "required_fields": [ "email" ], "mutually_exclusive_groups": [], "example_json": "{\n \"email\": \"value\"\n}", "example_yaml": "email: value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseInitResponse": { "type": "object", "description": "Any payload to be return by Provision API.", "title": "InitResponse", "x-displayname": "Enable Client-Side Defense Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.InitResponse", "properties": { "isConfigured": { "type": "boolean", "description": "Client-Side defense service is configured.", "title": "IsConfigured", "format": "boolean", "x-displayname": "Is Configured.", "x-f5xc-example": "true", "x-f5xc-description-short": "Client-Side defense service is configured.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseInitResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseInlineScript": { "type": "object", "description": "Inline script information with hash and selector.", "title": "InlineScript", "x-displayname": "Inline script.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.InlineScript", "properties": { "first_seen": { "type": "string", "description": "Unix epoch timestamp when inline script was first detected.", "title": "first_seen", "format": "int64", "x-displayname": "First Seen.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Unix epoch timestamp when inline script was first detected.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "handlers": { "type": "array", "description": "List of event handlers associated with the inline script.", "title": "handlers", "items": { "type": "string" }, "x-displayname": "Handlers", "x-f5xc-description-short": "List of event handlers associated with the inline script.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hash": { "type": "string", "description": "Hash value of the inline script.", "title": "hash", "x-displayname": "Hash", "x-ves-example": "Abc123hash.", "x-f5xc-example": "abc123hash", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "integrity": { "type": "string", "description": "Subresource integrity value.", "title": "integrity", "x-displayname": "Integrity", "x-ves-example": "Sha384-abc123.", "x-f5xc-example": "sha384-abc123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Unix epoch timestamp when inline script was last detected.", "title": "last_seen", "format": "int64", "x-displayname": "Last Seen", "x-ves-example": "1570194300.", "x-f5xc-example": "1570194300", "x-f5xc-description-short": "Unix epoch timestamp when inline script was last detected.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_id": { "type": "string", "description": "Unique identifier for the inline script.", "title": "script_id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-f5xc-example": "s-1234567", "x-f5xc-description-short": "Unique identifier for the inline script.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "script_name": { "type": "string", "description": "Name of the inline script (composite: baseScriptName::hash)", "title": "script_name", "x-displayname": "Script Name.", "x-ves-example": "analytics.js::abc123hash.", "x-f5xc-example": "analytics.js::abc123hash", "x-f5xc-description-short": "Name of the inline script (composite: baseScriptName::hash).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "selector": { "type": "string", "description": "CSS selector path where the inline script was found.", "title": "selector", "x-displayname": "Selector", "x-ves-example": "div.container > script[src]", "x-f5xc-example": "div.container > script[src]", "x-f5xc-description-short": "CSS selector path where the inline script was found.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Inline script information with hash and selector.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseInlineScript", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseJustification": { "type": "object", "description": "User-provided script justification.", "title": "Justification", "x-displayname": "Script Justification.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Justification", "properties": { "create_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nTime that the justification was entered.", "title": "create_time", "x-displayname": "Creation Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Format: unix epoch timestamp in seconds Time that the justification was entered.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "justification": { "type": "string", "description": "Script Justification.", "title": "justification", "x-displayname": "Script Justification.", "x-ves-example": "Blocking script due to network callout to malicious domain.", "x-f5xc-example": "Blocking script due to network callout to malicious domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "justification_id": { "type": "string", "description": "ID of the justification.", "title": "justification_id", "x-displayname": "Justification ID.", "x-ves-example": "J-1234567", "x-f5xc-example": "j-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "user_id": { "type": "string", "description": "ID of the justification creator.", "title": "user_id", "x-displayname": "User ID", "x-ves-example": "U-1234567", "x-f5xc-example": "u-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseJustification", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListAffectedUsersRequest": { "type": "object", "description": "Request to list affected users who have loaded this particular script.", "title": "ListAffectedUsersRequest", "x-displayname": "List Affected Users Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListAffectedUsersRequest", "properties": { "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time <= end_time.", "title": "end_time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194300", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch affected users whose last seen time <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAffectedUserFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of affected users to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "1000" }, "x-f5xc-example": "500", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "1000" }, "x-f5xc-description-short": "The maximum number of affected users to return per page.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 1000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "page_token": { "type": "string", "description": "Page_token is the value of listaffectedusersresponse.next_page_token from previous request.", "title": "page_token", "maxLength": 512, "x-displayname": "Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "example", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Page_token is the value of listaffectedusersresponse.next_page_token from previous request.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_id": { "type": "string", "description": "ID of the script.", "title": "script_id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "s-1234567", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "sorts": { "type": "array", "description": "Additional sort criteria.", "title": "sorts", "items": { "$ref": "#/components/schemas/client_side_defenseSort" }, "x-displayname": "Sorts", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch affected users whose last seen time >= start_time.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch affected users whose last seen time >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to list affected users who have loaded this particular script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListAffectedUsersRequest", "required_fields": [ "end_time", "page_number", "page_size", "script_id", "start_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_time\": \"1570194300\",\n \"page_number\": 1,\n \"page_size\": 1,\n \"script_id\": \"s-1234567\",\n \"start_time\": \"1570194000\"\n}", "example_yaml": "end_time: '1570194300'\npage_number: 1\npage_size: 1\nscript_id: s-1234567\nstart_time: '1570194000'" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListAffectedUsersResponse": { "type": "object", "description": "Response to list affected users who have loaded this particular script.", "title": "ListAffectedUsersResponse", "x-displayname": "List Affected Users Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListAffectedUsersResponse", "properties": { "affected_users": { "type": "array", "description": "List of affected users.", "title": "affected_users", "items": { "$ref": "#/components/schemas/client_side_defenseAffectedUser" }, "x-displayname": "Affected Users.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of affected users to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of affected users to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of affected users available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of affected users available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to list affected users who have loaded this particular script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListAffectedUsersResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListBehaviorsByScriptResponse": { "type": "object", "description": "Response to list behaviors by script.", "title": "ListBehaviorsByScriptResponse", "x-displayname": "List behaviors by script response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListBehaviorsByScriptResponse", "properties": { "behaviors": { "type": "array", "description": "List of behaviors depending upon filter.", "title": "behaviors", "items": { "$ref": "#/components/schemas/client_side_defenseBehaviorByScript" }, "x-displayname": "Behaviors", "x-f5xc-description-short": "List of behaviors depending upon filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_size": { "type": "integer", "description": "Total size of scripts.", "title": "total_size", "format": "int32", "x-displayname": "Total Size.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListBehaviorsByScriptResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListDetectedDomainsRequest": { "type": "object", "description": "Any payload to be passed on the GET Provision API.", "title": "GetDetectedDomainsRequest", "x-displayname": "GET Domains Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListDetectedDomainsRequest", "properties": { "duration": { "type": "string", "description": "Length in Days to fetch domain.", "title": "Duration Days", "x-displayname": "Duration days.", "x-ves-example": "15", "x-f5xc-example": "15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch domains with timestamp <= end_time.", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-f5xc-example": "1570194300", "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch domains with timestamp <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locations": { "type": "string", "description": "List of locations if backend needs to filter with locations passed.", "title": "Locations", "x-displayname": "Locations", "x-ves-example": "location1.com,location2.com.", "x-f5xc-example": "location1.com,location2.com", "x-f5xc-description-short": "List of locations if backend needs to filter with locations passed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), optional when page_token is specified.", "title": "Page number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-description-short": "One-indexed page number (starts from 1), optional when page_token is specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "Maximum number of domains per page.", "title": "Page size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_token": { "type": "string", "description": "Opaque token from previous response for pagination.", "title": "Page token", "x-displayname": "Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque token from previous response for pagination.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk": { "type": "string", "description": "GET the list of high risk domains, all domains is by default.", "title": "Risk", "x-displayname": "Risk", "x-ves-example": "High", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"high\\\", \\\"\\\"]" }, "x-f5xc-example": "high", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"high\\\", \\\"\\\"]" }, "x-f5xc-description-short": "GET the list of high risk domains, all domains is by default.", "maxLength": 1024, "enum": [ "high", "" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sorts": { "type": "array", "description": "Additional sort criteria. Supported fields: domain, last_seen, first_seen, category, risk_score.", "title": "sorts", "items": { "$ref": "#/components/schemas/client_side_defenseSort" }, "x-displayname": "Sorts", "x-ves-example": "[{field: 'domain', order: 'ASCENDING'}, {field: 'last_seen', order: 'DESCENDING'}]", "x-f5xc-example": "[{field'domain', order: 'ASCENDING'}, {field: 'last_seen', order: 'DESCENDING'}]", "x-f5xc-description-short": "Additional sort criteria. Supported fields: domain, last_seen, first_seen, category, risk_score.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch domains with timestamp >= start_time.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch domains with timestamp >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be passed on the GET Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListDetectedDomainsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListDetectedDomainsResponse": { "type": "object", "description": "GET detected domains monitoring data.", "title": "GetDetectedDomainsResponse", "x-displayname": "GET Domains Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListDetectedDomainsResponse", "properties": { "customer": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseEnterpriseInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_summary": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseDomainSummary" } ], "x-f5xc-description-short": "Configuration parameter for domain summary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domains_list": { "type": "array", "description": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated)", "title": "domains_list", "items": { "$ref": "#/components/schemas/client_side_defenseDomainDetails" }, "x-displayname": "Domains List.", "x-f5xc-description-short": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated).", "x-f5xc-description-medium": "Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location_list": { "type": "object", "description": "\"location URL -> protection flag\" map.", "title": "location_list", "x-displayname": "Location List.", "x-ves-example": "{'www.some-domain.com/reset-password': true,'www.some-domain.com/login': false}", "x-f5xc-example": "{'www.some-domain.com/reset-password'true,'www.some-domain.com/login': false}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of domains to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of domains to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of domains available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of domains available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListDetectedDomainsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListFormFieldsByScriptResponse": { "type": "object", "description": "Response to list form fields for input script.", "title": "ListFormFieldsByScriptResponse", "x-displayname": "List form fields by script response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListFormFieldsByScriptResponse", "properties": { "form_fields": { "type": "array", "description": "List of form fields for input script depending on start time and end time.", "title": "form_fields", "items": { "$ref": "#/components/schemas/client_side_defenseFormFieldByScript" }, "x-displayname": "Form Fields.", "x-f5xc-description-short": "List of form fields for input script depending on start time and end time.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the script.", "title": "status", "x-displayname": "Status", "x-ves-example": "Blocked Read.", "x-f5xc-example": "Blocked Read", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "total_size": { "type": "integer", "description": "Total size of scripts.", "title": "total_size", "format": "int32", "x-displayname": "Total Size.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to list form fields for input script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListFormFieldsByScriptResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListFormFieldsGetResponse": { "type": "object", "description": "Response to list form fields of all the scripts with GET method.", "title": "ListFormFieldsGetResponse", "x-displayname": "List form fields response with GET method.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListFormFieldsGetResponse", "properties": { "form_fields": { "type": "array", "description": "List of form fields for all the scripts.", "title": "form_fields", "items": { "$ref": "#/components/schemas/client_side_defenseFormField" }, "x-displayname": "Form Fields.", "x-f5xc-description-short": "List of form fields for all the scripts.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_size": { "type": "integer", "description": "Total size of scripts.", "title": "total_size", "format": "int32", "x-displayname": "Total Size.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to list form fields of all the scripts with GET method.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListFormFieldsGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListFormFieldsRequest": { "type": "object", "description": "Request to list form fields of all the scripts.", "title": "ListFormFieldsRequest", "x-displayname": "List form fields request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListFormFieldsRequest", "properties": { "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch form fields whose timestamp <= end_time.", "title": "end_time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1570194300", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch form fields whose timestamp <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFormFieldsFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of scripts to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of scripts to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_token": { "type": "string", "description": "Page_token is the value of listformfieldsresponse.next_page_token from previous request.", "title": "page_token", "x-displayname": "Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Page_token is the value of listformfieldsresponse.next_page_token from previous request.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sorts": { "type": "array", "description": "Additional sort criteria.", "title": "sorts", "items": { "$ref": "#/components/schemas/client_side_defenseSort" }, "x-displayname": "Sorts", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch form fields whose timestamp >= start_time.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch form fields whose timestamp >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to list form fields of all the scripts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListFormFieldsRequest", "required_fields": [ "end_time", "start_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_time\": \"1570194300\",\n \"start_time\": \"1570194000\"\n}", "example_yaml": "end_time: '1570194300'\nstart_time: '1570194000'" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListFormFieldsResponse": { "type": "object", "description": "Response to list form fields of all the scripts.", "title": "ListFormFieldsResponse", "x-displayname": "List form fields response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListFormFieldsResponse", "properties": { "form_fields": { "type": "array", "description": "List of form fields for all the scripts.", "title": "form_fields", "items": { "$ref": "#/components/schemas/client_side_defenseFormField" }, "x-displayname": "Form Fields.", "x-f5xc-description-short": "List of form fields for all the scripts.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of scripts to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of scripts to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of scripts available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of scripts available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_size": { "type": "integer", "description": "Total size of scripts.", "title": "total_size", "format": "int32", "x-displayname": "Total Size.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to list form fields of all the scripts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListFormFieldsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListInlineScriptsResponse": { "type": "object", "description": "Response to list inline scripts.", "title": "ListInlineScriptsResponse", "x-displayname": "List inline scripts response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListInlineScriptsResponse", "properties": { "scripts": { "type": "array", "description": "List of inline scripts with hash values.", "title": "scripts", "items": { "$ref": "#/components/schemas/client_side_defenseInlineScript" }, "x-displayname": "Inline Scripts.", "x-f5xc-description-short": "List of inline scripts with hash values.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListInlineScriptsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListNetworkInteractionsByScriptResponse": { "type": "object", "description": "Response to list network interactions by script.", "title": "ListNetworkInteractionsByScriptResponse", "x-displayname": "List network interactions by script response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListNetworkInteractionsByScriptResponse", "properties": { "network_interactions": { "type": "array", "description": "List of network interactions depending upon time filter.", "title": "network_interactions", "items": { "$ref": "#/components/schemas/client_side_defenseNetworkInteractionByScript" }, "x-displayname": "Network Interactions.", "x-f5xc-description-short": "List of network interactions depending upon time filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_size": { "type": "integer", "description": "Total size of scripts.", "title": "total_size", "format": "int32", "x-displayname": "Total Size.", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to list network interactions by script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListNetworkInteractionsByScriptResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListReportsWithHistoryResponse": { "type": "object", "description": "Response with report configurations and their generation job history.", "title": "ListReportsWithHistoryResponse", "x-displayname": "List Reports With History Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListReportsWithHistoryResponse", "properties": { "reports": { "type": "array", "description": "List of report configurations with history.", "title": "reports", "items": { "$ref": "#/components/schemas/client_side_defenseReportWithHistory" }, "x-displayname": "Reports", "x-f5xc-description-short": "List of report configurations with history.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response with report configurations and their generation job history.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListReportsWithHistoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListScriptsLegacyResponse": { "type": "object", "description": "Response to list scripts.", "title": "ListScriptsLegacyResponse", "x-displayname": "List scripts response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListScriptsLegacyResponse", "properties": { "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of scripts to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of scripts to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scripts": { "type": "array", "description": "List of scripts depending upon time filter.", "title": "scripts", "items": { "$ref": "#/components/schemas/client_side_defenseScriptInfo" }, "x-displayname": "Scripts", "x-f5xc-description-short": "List of scripts depending upon time filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of scripts available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of scripts available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListScriptsLegacyResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListScriptsRequest": { "type": "object", "description": "Request to list scripts.", "title": "ListScriptsRequest", "x-displayname": "List scripts request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListScriptsRequest", "properties": { "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch scripts whose timestamp <= end_time.", "title": "end_time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1570194300", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch scripts whose timestamp <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "page_number": { "type": "integer", "description": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-description-medium": "One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of scripts to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of scripts to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_token": { "type": "string", "description": "Page_token is the value of listscriptsresponse.next_page_token from previous request.", "title": "page_token", "x-displayname": "Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Page_token is the value of listscriptsresponse.next_page_token from previous request.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sorts": { "type": "array", "description": "Additional sort criteria.", "title": "sorts", "items": { "$ref": "#/components/schemas/client_side_defenseSort" }, "x-displayname": "Sorts", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nfetch scripts whose timestamp >= start_time.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds fetch scripts whose timestamp >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListScriptsRequest", "required_fields": [ "end_time", "start_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_time\": \"1570194300\",\n \"start_time\": \"1570194000\"\n}", "example_yaml": "end_time: '1570194300'\nstart_time: '1570194000'" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseListScriptsResponse": { "type": "object", "description": "Response to list scripts.", "title": "ListScriptsResponse", "x-displayname": "List scripts response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ListScriptsResponse", "properties": { "next_page_token": { "type": "string", "description": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "title": "next_page_token", "x-displayname": "Next Page Token.", "x-ves-example": "CGFnZV9zaXplPTUwMCZwYWdlX251bWJlcj0y.", "x-f5xc-example": "example", "x-f5xc-description-short": "Opaque value passed back alone with the additional calls. All filtering will stay the same.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_number": { "type": "integer", "description": "One-indexed page number.", "title": "page_number", "format": "int32", "x-displayname": "Page Number.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "The maximum number of scripts to return per page.", "title": "page_size", "format": "int32", "x-displayname": "Page Size", "x-ves-example": "500", "x-f5xc-example": "500", "x-f5xc-description-short": "The maximum number of scripts to return per page.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scripts": { "type": "array", "description": "List of scripts depending upon time filter.", "title": "scripts", "items": { "$ref": "#/components/schemas/client_side_defenseScriptInfo" }, "x-displayname": "Scripts", "x-f5xc-description-short": "List of scripts depending upon time filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "integer", "description": "Total count of scripts available at time of query, and subject to change across queries.", "title": "total_count", "format": "int32", "x-displayname": "Total Count.", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total count of scripts available at time of query, and subject to change across queries.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_pages": { "type": "integer", "description": "Total number of pages available depending upon requested page_size.", "title": "total_pages", "format": "int32", "x-displayname": "Total Pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Total number of pages available depending upon requested page_size.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseListScriptsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseMitigationStatusCounts": { "type": "object", "description": "Count of scripts by mitigation status.", "title": "MitigationStatusCounts", "x-displayname": "Mitigation Status Counts.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.MitigationStatusCounts", "properties": { "action_needed": { "type": "integer", "description": "Number of scripts with \"AN - Action Needed\" status.", "title": "action_needed", "format": "int32", "x-displayname": "Action Needed.", "x-ves-example": "30", "x-f5xc-example": "30", "x-f5xc-description-short": "Number of scripts with \"AN - Action Needed\" status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_action_needed": { "type": "integer", "description": "Number of scripts with \"NA - No Action Needed\" status.", "title": "no_action_needed", "format": "int32", "x-displayname": "No Action Needed.", "x-ves-example": "50", "x-f5xc-example": "50", "x-f5xc-description-short": "Number of scripts with \"NA - No Action Needed\" status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resolved": { "type": "integer", "description": "Number of scripts with \"Resolved - No Action Needed\" status.", "title": "resolved", "format": "int32", "x-displayname": "Resolved", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-description-short": "Number of scripts with \"Resolved - No Action Needed\" status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseMitigationStatusCounts", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseNetworkInteractionByScript": { "type": "object", "description": "Network interaction information by script.", "title": "NetworkInteractionByScript", "x-displayname": "Network interaction.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.NetworkInteractionByScript", "properties": { "first_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst seen time.", "title": "first_seen", "x-displayname": "First Seen.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast seen time.", "title": "last_seen", "x-displayname": "Last Seen", "x-ves-example": "1650609600000.", "x-f5xc-example": "1650609600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the domain.", "title": "name", "x-displayname": "Name", "x-ves-example": "marvel.com.", "x-f5xc-example": "marvel.com", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "risk_level": { "type": "string", "description": "Risk level of the script.", "title": "risk_level", "x-displayname": "Risk Level.", "x-ves-example": "High Risk", "x-f5xc-example": "High Risk", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the domain.", "title": "status", "x-displayname": "Status", "x-ves-example": "Added to Mitigated List.", "x-f5xc-example": "Added to Mitigated List", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Network interaction information by script.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseNetworkInteractionByScript", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReport": { "type": "object", "description": "Report configuration.", "title": "Report", "x-displayname": "Report", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Report", "properties": { "created_at": { "type": "string", "description": "Creation timestamp.", "title": "created_at", "format": "date-time", "x-displayname": "Created At.", "x-ves-example": "2024-01-01T00:00:00Z.", "x-f5xc-example": "2024-01-01T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "created_by": { "type": "string", "description": "User who created the report.", "title": "created_by", "x-displayname": "Created By.", "x-ves-example": "User@example.com.", "x-f5xc-example": "user@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "report_criteria": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportCriteria" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_id": { "type": "string", "description": "Unique report identifier.", "title": "report_id", "x-displayname": "Report ID", "x-ves-example": "R-1234567", "x-f5xc-example": "r-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "report_name": { "type": "string", "description": "Human-readable name for the report.", "title": "report_name", "minLength": 1, "maxLength": 255, "x-displayname": "Report Name.", "x-ves-example": "Monthly Script Analysis.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "Monthly Script Analysis", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 255, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "report_type": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "updated_at": { "type": "string", "description": "Update timestamp.", "title": "updated_at", "format": "date-time", "x-displayname": "Updated At.", "x-ves-example": "2024-01-02T00:00:00Z.", "x-f5xc-example": "2024-01-02T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "updated_by": { "type": "string", "description": "User who last updated the report.", "title": "updated_by", "x-displayname": "Updated By.", "x-ves-example": "User@example.com.", "x-f5xc-example": "user@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReport", "required_fields": [ "report_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"report_name\": \"Monthly Script Analysis\"\n}", "example_yaml": "report_name: Monthly Script Analysis" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportCriteria": { "type": "object", "description": "Criteria definition for a report.", "title": "ReportCriteria", "x-displayname": "Report Criteria.", "x-ves-oneof-field-criteria": "[\"affected_users\",\"scripts\"]", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ReportCriteria", "properties": { "affected_users": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAffectedUsersReportCriteria" } ], "x-f5xc-description-short": "Configuration parameter for affected users.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "scripts" ] }, "scripts": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseScriptsReportCriteria" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "affected_users" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportCriteria", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportFilter": { "type": "object", "description": "Filter definition for report criteria.", "title": "ReportFilter", "x-displayname": "Report Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ReportFilter", "properties": { "column_name": { "type": "string", "description": "Column name to filter.", "title": "column_name", "x-displayname": "Column Name.", "x-ves-example": "Script_name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "script_name", "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "operator": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "Filter values.", "title": "values", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Values", "x-ves-example": "['analytics.js']", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-example": "['analytics.js']", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.max_len": "256" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportFilter", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportFilterOperator": { "type": "string", "description": "Filter operator for report criteria\n\n- REPORT_FILTER_OPERATOR_UNSPECIFIED: REPORT_FILTER_OPERATOR_UNSPECIFIED\n- REPORT_FILTER_OPERATOR_IN: REPORT_FILTER_OPERATOR_IN\n- REPORT_FILTER_OPERATOR_NOT_IN: REPORT_FILTER_OPERATOR_NOT_IN.", "title": "ReportFilterOperator", "enum": [ "REPORT_FILTER_OPERATOR_UNSPECIFIED", "REPORT_FILTER_OPERATOR_IN", "REPORT_FILTER_OPERATOR_NOT_IN" ], "default": "REPORT_FILTER_OPERATOR_UNSPECIFIED", "x-displayname": "Report Filter Operator.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ReportFilterOperator", "x-f5xc-example": "REPORT_FILTER_OPERATOR_IN", "x-f5xc-description-short": "Filter operator for report criteria - REPORT_FILTER_OPERATOR_UNSPECIFIED: REPORT_FILTER_OPERATOR_UNSPECIFIED - REPORT_FILTER_OPERATOR_IN...", "x-f5xc-description-medium": "Filter operator for report criteria - REPORT_FILTER_OPERATOR_UNSPECIFIED: REPORT_FILTER_OPERATOR_UNSPECIFIED - REPORT_FILTER_OPERATOR_IN: REPORT_FILTER_OPERATOR_IN - REPORT_FILTER_OPERATOR_NOT_IN: REPORT_FILTER_OPERATOR_NOT_IN.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportFilterOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"REPORT_FILTER_OPERATOR_IN\"", "example_yaml": "REPORT_FILTER_OPERATOR_IN\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportStatus": { "type": "string", "description": "Status of a report generation job\n\n- REPORT_STATUS_UNSPECIFIED: REPORT_STATUS_UNSPECIFIED\n- REPORT_STATUS_QUEUED: REPORT_STATUS_QUEUED\n- REPORT_STATUS_IN_PROGRESS: REPORT_STATUS_IN_PROGRESS\n- REPORT_STATUS_COMPLETED: REPORT_STATUS_COMPLETED\n- REPORT_STATUS_ERRORED: REPORT_STATUS_ERRORED\n- REPORT_STATUS_TIMED_OUT: REPORT_STATUS_TIMED_OUT.", "title": "ReportStatus", "enum": [ "REPORT_STATUS_UNSPECIFIED", "REPORT_STATUS_QUEUED", "REPORT_STATUS_IN_PROGRESS", "REPORT_STATUS_COMPLETED", "REPORT_STATUS_ERRORED", "REPORT_STATUS_TIMED_OUT" ], "default": "REPORT_STATUS_UNSPECIFIED", "x-displayname": "Report Status.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ReportStatus", "x-f5xc-example": "REPORT_STATUS_COMPLETED", "x-f5xc-description-short": "Status of a report generation job - REPORT_STATUS_UNSPECIFIED: REPORT_STATUS_UNSPECIFIED - REPORT_STATUS_QUEUED: REPORT_STATUS_QUEUED ...", "x-f5xc-description-medium": "Status of a report generation job - REPORT_STATUS_UNSPECIFIED: REPORT_STATUS_UNSPECIFIED - REPORT_STATUS_QUEUED: REPORT_STATUS_QUEUED - REPORT_STATUS_IN_PROGRESS: REPORT_STATUS_IN_PROGRESS - REPORT_STATUS_COMPLETED: REPORT_STATUS_COMPLETED - REPORT_STATUS_ERRORED: REPORT_STATUS_ERRORED ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"REPORT_STATUS_COMPLETED\"", "example_yaml": "REPORT_STATUS_COMPLETED\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportType": { "type": "string", "description": "Type of report to generate\n\n- REPORT_TYPE_UNSPECIFIED: REPORT_TYPE_UNSPECIFIED\n- REPORT_TYPE_SCRIPTS: REPORT_TYPE_SCRIPTS\n- REPORT_TYPE_AFFECTED_USERS: REPORT_TYPE_AFFECTED_USERS.", "title": "ReportType", "enum": [ "REPORT_TYPE_UNSPECIFIED", "REPORT_TYPE_SCRIPTS", "REPORT_TYPE_AFFECTED_USERS" ], "default": "REPORT_TYPE_UNSPECIFIED", "x-displayname": "Report Type.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ReportType", "x-f5xc-example": "REPORT_TYPE_SCRIPTS", "x-f5xc-description-short": "Type of report to generate - REPORT_TYPE_UNSPECIFIED: REPORT_TYPE_UNSPECIFIED - REPORT_TYPE_SCRIPTS: REPORT_TYPE_SCRIPTS ...", "x-f5xc-description-medium": "Type of report to generate - REPORT_TYPE_UNSPECIFIED: REPORT_TYPE_UNSPECIFIED - REPORT_TYPE_SCRIPTS: REPORT_TYPE_SCRIPTS - REPORT_TYPE_AFFECTED_USERS: REPORT_TYPE_AFFECTED_USERS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"REPORT_TYPE_SCRIPTS\"", "example_yaml": "REPORT_TYPE_SCRIPTS\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseReportWithHistory": { "type": "object", "description": "Report configuration with its generation job history.", "title": "ReportWithHistory", "x-displayname": "Report With History.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ReportWithHistory", "properties": { "completed_at": { "type": "string", "description": "Report completion timestamp.", "title": "completed_at", "format": "date-time", "x-displayname": "Completed At.", "x-ves-example": "2024-01-01T01:00:00Z.", "x-f5xc-example": "2024-01-01T01:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "created_at": { "type": "string", "description": "Creation timestamp.", "title": "created_at", "format": "date-time", "x-displayname": "Created At.", "x-ves-example": "2024-01-01T00:00:00Z.", "x-f5xc-example": "2024-01-01T00:00:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "created_by": { "type": "string", "description": "User who created the report.", "title": "created_by", "x-displayname": "Created By.", "x-ves-example": "User@example.com.", "x-f5xc-example": "user@example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "job_id": { "type": "string", "description": "Report generation job identifier.", "title": "job_id", "x-displayname": "Job ID", "x-ves-example": "J-1234567", "x-f5xc-example": "j-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "report_criteria": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportCriteria" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_id": { "type": "string", "description": "Report identifier.", "title": "report_id", "x-displayname": "Report ID", "x-ves-example": "R-1234567", "x-f5xc-example": "r-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "report_name": { "type": "string", "description": "Human-readable name for the report.", "title": "report_name", "x-displayname": "Report Name.", "x-ves-example": "Monthly Script Analysis.", "x-f5xc-example": "Monthly Script Analysis", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_type": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseReportStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Report configuration with its generation job history.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseReportWithHistory", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseRiskLevelFilter": { "type": "object", "description": "Query Filter by risk level filter strings.", "title": "Risk Level Filter", "x-displayname": "Risk Level Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.RiskLevelFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk_level_strings": { "type": "array", "description": "An unordered list of risk level strings.", "title": "Risk Level Strings", "maxItems": 10, "items": { "type": "string", "maxLength": 32 }, "x-displayname": "Risk Level Strings.", "x-ves-example": "['High']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['High']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 10, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by risk level filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseRiskLevelFilter", "required_fields": [ "risk_level_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"risk_level_strings\": [\n \"value\"\n ]\n}", "example_yaml": "risk_level_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseScriptApprovalStatus": { "type": "string", "description": "Type of Script Approval Status\n\n- UNKNOWN: UNKNOWN\nUnknown approval status - default value\n- APPROVED: APPROVED\nScript is approved\n- REJECTED: REJECTED\nScript is rejected.", "title": "ScriptApprovalStatus", "enum": [ "UNKNOWN", "APPROVED", "REJECTED" ], "default": "UNKNOWN", "x-displayname": "Script Approval Status.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.ScriptApprovalStatus", "x-f5xc-example": "APPROVED", "x-f5xc-description-short": "Type of Script Approval Status - UNKNOWN: UNKNOWN Unknown approval status - default value - APPROVED: APPROVED Script is approved - REJECTED...", "x-f5xc-description-medium": "Type of Script Approval Status - UNKNOWN: UNKNOWN Unknown approval status - default value - APPROVED: APPROVED Script is approved - REJECTED: REJECTED Script is rejected.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseScriptApprovalStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"APPROVED\"", "example_yaml": "APPROVED\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseScriptInfo": { "type": "object", "description": "Script information.", "title": "ScriptInfo", "x-displayname": "Script information.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ScriptInfo", "properties": { "affected_users_count": { "type": "integer", "description": "Number of affected users that loaded this script.", "title": "affected_users_count", "format": "int32", "x-displayname": "Affected Users Count.", "x-f5xc-description-short": "Number of affected users that loaded this script.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "approval_status": { "type": "string", "description": "Status of script.", "title": "approval_status", "x-displayname": "Approval Status.", "x-ves-example": "Approved", "x-f5xc-example": "Approved", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "first_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst seen time.", "title": "first_seen", "x-displayname": "First Seen.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "form_fields_read": { "type": "integer", "description": "Number of form fields read by script.", "title": "form_fields_read", "format": "int32", "x-displayname": "Form Fields Read.", "x-f5xc-example": "9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the script.", "title": "id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-f5xc-example": "s-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inline_scripts_count": { "type": "integer", "description": "Number of inline scripts tagged to the script having different hash.", "title": "scripts_count", "format": "int32", "x-displayname": "Scripts Count.", "x-f5xc-example": "10", "x-f5xc-description-short": "Number of inline scripts tagged to the script having different hash.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "justifications": { "type": "array", "description": "List of user-provided script justifications.", "title": "justifications", "items": { "$ref": "#/components/schemas/client_side_defenseJustification" }, "x-displayname": "Justifications.", "x-f5xc-description-short": "List of user-provided script justifications.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast seen time.", "title": "last_seen", "x-displayname": "Last Seen", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locations": { "type": "array", "description": "Locations where the script was found.", "title": "locations", "items": { "type": "string" }, "x-displayname": "Locations", "x-ves-example": "['marvel.com','jsp.com']", "x-f5xc-example": "['marvel.com','jsp.com']", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_interactions": { "type": "integer", "description": "Number of network interactions.", "title": "network_interactions", "format": "int32", "x-displayname": "Network Interactions.", "x-f5xc-example": "7", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "new_behaviors": { "type": "integer", "description": "Number of new behaviors of the script.", "title": "new_behaviors", "format": "int32", "x-displayname": "New Behaviors.", "x-f5xc-example": "15", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk_level": { "type": "string", "description": "Risk level of the script.", "title": "risk_level", "x-displayname": "Risk Level.", "x-ves-example": "High Risk", "x-f5xc-example": "High Risk", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_name": { "type": "string", "description": "Script detected in the webpage.", "title": "script_name", "x-displayname": "Script Name.", "x-ves-example": "https://www.google-analytics.com/analytics.js.", "x-f5xc-example": "https://www.google-analytics.com/analytics.js", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Script Status.", "title": "status", "x-displayname": "Script Status.", "x-ves-example": "Action Needed.", "x-f5xc-example": "Action Needed", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseScriptInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseScriptNameFilter": { "type": "object", "description": "Query Filter by script name filter strings.", "title": "Script Name Filter", "x-displayname": "Script Name Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ScriptNameFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_name_strings": { "type": "array", "description": "An unordered list of script name strings.", "title": "Script Name Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Script Name Strings.", "x-ves-example": "['analytics.js']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['analytics.js']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "256", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by script name filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseScriptNameFilter", "required_fields": [ "script_name_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"script_name_strings\": [\n \"value\"\n ]\n}", "example_yaml": "script_name_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseScriptStatusFilter": { "type": "object", "description": "Query Filter by script status filter strings.", "title": "Script Status Filter", "x-displayname": "Script Status Filter.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ScriptStatusFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_status_strings": { "type": "array", "description": "An unordered list of script status strings.", "title": "Script Status Strings", "minItems": 1, "maxItems": 10, "items": { "type": "string", "maxLength": 128 }, "x-displayname": "Script Status Strings.", "x-ves-example": "['Action Needed', 'No Action Needed', 'No Action Needed - Resolved']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "128", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Action Needed', 'No Action Needed', 'No Action Needed - Resolved']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "128", "ves.io.schema.rules.repeated.max_items": "10", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Unordered list of script status strings.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 10, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by script status filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseScriptStatusFilter", "required_fields": [ "script_status_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"script_status_strings\": [\n \"value\"\n ]\n}", "example_yaml": "script_status_strings:\n- value" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseScriptsReportCriteria": { "type": "object", "description": "Criteria to generate a scripts report.", "title": "ScriptsReportCriteria", "x-displayname": "Scripts Report Criteria.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.ScriptsReportCriteria", "properties": { "end_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nFetch scripts whose timestamp <= end_time.", "title": "end_time", "x-displayname": "End Time", "x-ves-example": "1570194300.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194300", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds Fetch scripts whose timestamp <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "type": "array", "description": "Additional filters for the query.", "title": "filters", "items": { "$ref": "#/components/schemas/client_side_defenseReportFilter" }, "x-displayname": "Filters", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Format: unix epoch timestamp in seconds\nFetch scripts whose timestamp >= start_time.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Format: unix epoch timestamp in seconds Fetch scripts whose timestamp >= start_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseScriptsReportCriteria", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseSort": { "type": "object", "description": "API query sort criteria.", "title": "Sort", "x-displayname": "Sort", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Sort", "properties": { "field": { "type": "string", "description": "Field specification or configuration", "title": "Sort field", "x-displayname": "Field", "x-ves-example": "Field-key", "x-f5xc-example": "field-key", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "order": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseSort", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseSummary": { "type": "object", "description": "Summary of the dashboard.", "title": "Summary", "x-displayname": "Summary", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Summary", "properties": { "domain": { "type": "string", "description": "Name of the domain.", "title": "domain", "x-displayname": "Domain", "x-ves-example": "marvel.com.", "x-f5xc-example": "marvel.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "first_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nFirst seen time.", "title": "first_seen", "x-displayname": "First Seen.", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds First seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_seen": { "type": "string", "description": "Format: unix epoch timestamp in milliseconds\nLast seen time.", "title": "last_seen", "x-displayname": "Last Seen", "x-ves-example": "1650603600000.", "x-f5xc-example": "1650603600000", "x-f5xc-description-short": "Format: unix epoch timestamp in milliseconds Last seen time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "risk_level": { "type": "string", "description": "Risk level of the script.", "title": "risk_level", "x-displayname": "Risk Level.", "x-ves-example": "High Risk", "x-f5xc-example": "High Risk", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Type of the script.", "title": "type", "x-displayname": "Type", "x-ves-example": "First Party.", "x-f5xc-example": "First Party", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseTestJSRequest": { "type": "object", "description": "Request to GET injected JS tag status.", "title": "TestJSRequest", "x-displayname": "TestJS Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.TestJSRequest", "properties": { "domain": { "type": "string", "description": "Root domain that page URL belongs to\nExample: if you are adding Client-Side Defense JS on checkout.example.com,\nyou should enter example.com here.", "title": "Domain", "maxLength": 256, "x-displayname": "Domain", "x-ves-example": "company.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "company.com", "x-validation-rules": { "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "pageURL": { "type": "string", "description": "Page URL that user injects JS tag to.", "title": "Page URL", "x-displayname": "Page URL", "x-ves-example": "https://www.company.com/login.html.", "x-ves-validation-rules": { "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "https://www.company.com/login.html", "x-validation-rules": { "ves.io.schema.rules.string.uri_ref": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseTestJSRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseTestJSResponse": { "type": "object", "description": "GET the page URL JS status.", "title": "TestJSResponse", "x-displayname": "Test JS Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.TestJSResponse", "properties": { "message": { "type": "string", "description": "The error string if the status is failed.", "title": "message", "x-displayname": "Message", "x-ves-example": "Root domain mistached.", "x-f5xc-example": "Root domain mistached", "x-f5xc-description-short": "The error string if the status is failed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseTestJSStatusType" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseTestJSResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseTestJSStatusType": { "type": "string", "description": "Test JS status\n\nThe page URL has been tested and the script tag has been injected\nThe page URL has been tested and the script tag is not found in the page HEAD section\nThere is error when trying to GET the page via the given URL.", "title": "TestJSStatusType", "enum": [ "DETECTED", "NOT_DETECTED", "FAILED" ], "default": "DETECTED", "x-displayname": "Test JS Status Type.", "x-ves-proto-enum": "ves.io.schema.shape.client_side_defense.TestJSStatusType", "x-f5xc-description-short": "Test JS status The page URL has been tested and the script tag has been injected The page URL has been tested and the script tag is not found in...", "x-f5xc-description-medium": "Test JS status The page URL has been tested and the script tag has been injected The page URL has been tested and the script tag is not found in the page HEAD section There is error when trying to GET the page via the given URL.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseTestJSStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DETECTED\"", "example_yaml": "DETECTED\n..." }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateDomainsRequest": { "type": "object", "description": "Request to update domain.", "title": "UpdateDomainsRequest", "x-displayname": "Update domain request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateDomainsRequest", "properties": { "add_to_allowed_domains": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAddToAllowedDomains" } ], "x-f5xc-description-short": "Configuration parameter for add to allowed domains.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "add_to_mitigated_domains": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseAddToMitigatedDomains" } ], "x-f5xc-description-short": "Configuration parameter for add to mitigated domains.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateDomainsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateDomainsResponse": { "type": "object", "description": "Response to update domain.", "title": "UpdateDomainsResponse", "x-displayname": "Update domain response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateDomainsResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateDomainsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateFieldAnalysisRequest": { "type": "object", "description": "Request to PATCH analysis of fields across scripts.", "title": "UpdateFieldAnalysisRequest", "x-displayname": "Update Field Analysis request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateFieldAnalysisRequest", "properties": { "name": { "type": "string", "description": "Human-readable name for the resource", "title": "name", "x-displayname": "Form Field Name.", "x-ves-example": "Username", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "Username", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "type": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseANALYSIS_TYPE" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to PATCH analysis of fields across scripts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateFieldAnalysisRequest", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"Username\"\n}", "example_yaml": "name: Username" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateFieldAnalysisResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateFieldAnalysisResponse", "properties": { "status": { "type": "string", "description": "Values: not_modified , success\nStatus about field analysis status modification.", "title": "status", "x-displayname": "Status", "x-ves-example": "Not_modified.", "x-f5xc-example": "not_modified", "x-f5xc-description-short": "Values: not_modified , success Status about field analysis status modification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateFieldAnalysisResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptApprovalStatusRequest": { "type": "object", "description": "Request to update script approval status.", "title": "UpdateScriptApprovalStatusRequest", "x-displayname": "Update Script Approval Status Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptApprovalStatusRequest", "properties": { "id": { "type": "string", "description": "Script ID", "title": "id", "x-displayname": "Script ID", "x-ves-example": "S-ssAH-Ji-oC.", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "s-ssAH-Ji-oC", "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseScriptApprovalStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Request to update script approval status.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptApprovalStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptApprovalStatusResponse": { "type": "object", "description": "Response after updating script approval status.", "title": "UpdateScriptApprovalStatusResponse", "x-displayname": "Update Script Approval Status Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptApprovalStatusResponse", "properties": { "script_id": { "type": "string", "description": "ID of the script that was updated.", "title": "script_id", "x-displayname": "Script ID", "x-ves-example": "S-ssAH-Ji-oC.", "x-f5xc-example": "s-ssAH-Ji-oC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Response after updating script approval status.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptApprovalStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptJustificationRequest": { "type": "object", "description": "Request to update script justification.", "title": "UpdateScriptJustificationRequest", "x-displayname": "Update script justification request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptJustificationRequest", "properties": { "justification": { "type": "string", "description": "Script Justification.", "title": "justification", "x-displayname": "Script Justification.", "x-ves-example": "Blocking script due to network callout to malicious domain.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "Blocking script due to network callout to malicious domain.", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "script_id": { "type": "string", "description": "ID of the script.", "title": "script_id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "s-1234567", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "user_id": { "type": "string", "description": "ID of the justification creator.", "title": "user_id", "x-displayname": "User ID", "x-ves-example": "U-1234567", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "u-1234567", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptJustificationRequest", "required_fields": [ "justification", "script_id", "user_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"justification\": \"Blocking script due to network callout to malicious domain.\",\n \"script_id\": \"s-1234567\",\n \"user_id\": \"u-1234567\"\n}", "example_yaml": "justification: Blocking script due to network callout to malicious domain.\nscript_id: s-1234567\nuser_id: u-1234567" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptJustificationResponse": { "type": "object", "description": "Response to update script justification.", "title": "UpdateScriptJustificationResponse", "x-displayname": "Update script justification response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptJustificationResponse", "properties": { "justification_id": { "type": "string", "description": "ID of the justification.", "title": "justification_id", "x-displayname": "Justification ID.", "x-ves-example": "J-1234567", "x-f5xc-example": "j-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Response to update script justification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptJustificationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptReadStatusRequest": { "type": "object", "description": "Request to update.", "title": "UpdateScriptReadStatusRequest", "x-displayname": "Update Script FormFields ReadStatus request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptReadStatusRequest", "properties": { "id": { "type": "string", "description": "Script ID", "title": "id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "s-1234567", "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-f5xc-example": "default", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "type": { "allOf": [ { "$ref": "#/components/schemas/client_side_defenseACTION_TYPE" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptReadStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdateScriptReadStatusResponse": { "type": "object", "description": "Payload about status of script read status result.", "title": "UpdateScriptReadStatusResponse", "x-displayname": "Update script read status response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdateScriptReadStatusResponse", "properties": { "id": { "type": "string", "description": "ID of the script.", "title": "id", "x-displayname": "Script ID", "x-ves-example": "S-1234567", "x-f5xc-example": "s-1234567", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "script_name": { "type": "string", "description": "Script detected in the webpage.", "title": "script_name", "x-displayname": "Script Name.", "x-ves-example": "https://www.google-analytics.com/analytics.js.", "x-f5xc-example": "https://www.google-analytics.com/analytics.js", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Values: not_modified , success\nStatus about script read status modification.", "title": "status", "x-displayname": "Status", "x-ves-example": "Not_modified.", "x-f5xc-example": "not_modified", "x-f5xc-description-short": "Values: not_modified , success Status about script read status modification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Payload about status of script read status result.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdateScriptReadStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "client_side_defenseUpdatedCount": { "type": "object", "description": "Pair of count and last updated timestamp, used to provided aggregated domain details.", "title": "UpdatedCount", "x-displayname": "Updated Count.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.UpdatedCount", "properties": { "count": { "type": "integer", "description": "Aggregated count.", "title": "Count", "format": "int32", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-constraints": { "constraintType": "number", "category": "general", "minimum": 0, "maximum": 10000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lastUpdated": { "type": "string", "description": "Timestamp showing when the count was last update.", "title": "LastUpdated", "format": "int64", "x-displayname": "Last Updated.", "x-f5xc-example": "1629839825497", "x-f5xc-description-short": "Timestamp showing when the count was last update.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Pair of count and last updated timestamp, used to provided aggregated domain details.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for client_side_defenseUpdatedCount", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaSortOrder": { "type": "string", "description": "Sort algorithm\n\nSort in descending order\nSort in ascending order.", "title": "SortOrder", "enum": [ "DESCENDING", "ASCENDING" ], "default": "DESCENDING", "x-displayname": "Sort Order.", "x-ves-proto-enum": "ves.io.schema.SortOrder", "x-f5xc-description-short": "Sort algorithm Sort in descending order Sort in ascending order.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSortOrder", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DESCENDING\"", "example_yaml": "DESCENDING\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "shapeclient_side_defenseLocation": { "type": "object", "description": "Location scripts pair.", "title": "Location", "x-displayname": "Location", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.Location", "properties": { "associatedScripts": { "type": "array", "description": "Scripts found at the location.", "title": "AssociatedScripts", "items": { "type": "string" }, "x-displayname": "Associated scripts.", "x-ves-example": "['www.some-path.com/example/some-js.js','www.some-other-path.com/example/some-other-js.js']", "x-f5xc-example": "['www.some-path.com/example/some-js.js','www.some-other-path.com/example/some-other-js.js']", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location of the scripts.", "title": "Location", "x-displayname": "Location", "x-ves-example": "www.some.domain.com/resetPassword.", "x-f5xc-example": "www.some.domain.com/resetPassword", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for shapeclient_side_defenseLocation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "data_and_privacy_security", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "allowed_domainCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of allowed_domain", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/allowed_domainCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/allowed_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainCreateSpecType": { "type": "object", "description": "Create allowed domain.", "title": "Create Allowed Domain", "x-displayname": "Create Allowed Domain.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.CreateSpecType", "properties": { "allowed_domain": { "type": "string", "description": "Enter root domain or domain to be entered to allow list below.\nDomains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.\nExample: if you are adding Client-Side Defense JS on checkout.example.com, you should enter example.com here.", "maxLength": 256, "x-displayname": "Domain", "x-ves-example": "news.abc.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "news.abc.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Enter root domain or domain to be entered to allow list below. Domains can be entered only one at a time.", "x-f5xc-description-medium": "Enter root domain or domain to be entered to allow list below. Domains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainCreateSpecType", "required_fields": [ "allowed_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"allowed_domain\": \"news.abc.com\"\n}", "example_yaml": "allowed_domain: news.abc.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a allowed_domain", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read allowed_domain", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/allowed_domainCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/allowed_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/allowed_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainGetSpecType": { "type": "object", "description": "GET allowed domain.", "title": "Get Allowed Domain", "x-displayname": "GET Allowed Domain.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.GetSpecType", "properties": { "allowed_domain": { "type": "string", "description": "Enter root domain or domain to be entered to allow list below.\nDomains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.\nExample: if you are adding Client-Side Defense JS on checkout.example.com, you should enter example.com here.", "maxLength": 256, "x-displayname": "Domain", "x-ves-example": "news.abc.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "news.abc.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Enter root domain or domain to be entered to allow list below. Domains can be entered only one at a time.", "x-f5xc-description-medium": "Enter root domain or domain to be entered to allow list below. Domains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "date_added": { "type": "string", "description": "The date when user adds allowed domain.", "format": "date-time", "x-displayname": "Date Added.", "x-ves-example": "2021-09-21:44:34.171543432Z.", "x-f5xc-example": "2021-09-21:44:34.171543432Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainGetSpecType", "required_fields": [ "allowed_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"allowed_domain\": \"news.abc.com\"\n}", "example_yaml": "allowed_domain: news.abc.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of allowed_domain", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/allowed_domainListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainListResponseItem": { "type": "object", "description": "By default a summary of allowed_domain is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of allowed_domain", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this allowed_domain.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this allowed_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this allowed_domain.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this allowed_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates allowed_domain is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates allowed_domain is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/allowed_domainGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this allowed_domain.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this allowed_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this allowed_domain.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/allowed_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this allowed_domain.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of allowed_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of allowed_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "allowed_domainStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.allowed_domain.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for allowed_domainStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of protected_domain", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/protected_domainCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/protected_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainCreateSpecType": { "type": "object", "description": "Create Domain to protect.", "title": "Create Domain to protect", "x-displayname": "Create Domain to protect.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.CreateSpecType", "properties": { "protected_domain": { "type": "string", "description": "For Client-Side Defense to work on the web pages where you injected the JS,\nyou need to enter the root domain below.\nExample: if you are adding Client-Side Defense JS on checkout.example.com,\nyou should enter example.com here.", "maxLength": 256, "x-displayname": "Root Domain.", "x-ves-example": "example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "For Client-Side Defense to work on the web pages where you injected the JS, you need to enter the root domain below.", "x-f5xc-description-medium": "For Client-Side Defense to work on the web pages where you injected the JS, you need to enter the root domain below.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainCreateSpecType", "required_fields": [ "protected_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"protected_domain\": \"example.com\"\n}", "example_yaml": "protected_domain: example.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a protected_domain", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read protected_domain", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/protected_domainCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/protected_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/protected_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainGetSpecType": { "type": "object", "description": "GET Domain to protect.", "title": "Get Domain to protect", "x-displayname": "GET Protected Domain.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.GetSpecType", "properties": { "date_added": { "type": "string", "description": "The date when user adds the setting.", "format": "date-time", "x-displayname": "Date Added.", "x-ves-example": "2021-09-21:44:34.171543432Z.", "x-f5xc-example": "2021-09-21:44:34.171543432Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protected_domain": { "type": "string", "description": "For Client-Side Defense to work on the web pages where you injected the JS,\nyou need to enter the root domain below.\nExample: if you are adding Client-Side Defense JS on checkout.example.com,\nyou should enter example.com here.", "maxLength": 256, "x-displayname": "Root Domain.", "x-ves-example": "example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.etld_plus_one": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "For Client-Side Defense to work on the web pages where you injected the JS, you need to enter the root domain below.", "x-f5xc-description-medium": "For Client-Side Defense to work on the web pages where you injected the JS, you need to enter the root domain below.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainGetSpecType", "required_fields": [ "protected_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"protected_domain\": \"example.com\"\n}", "example_yaml": "protected_domain: example.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of protected_domain", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/protected_domainListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainListResponseItem": { "type": "object", "description": "By default a summary of protected_domain is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of protected_domain", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this protected_domain.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this protected_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this protected_domain.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this protected_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates protected_domain is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates protected_domain is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/protected_domainGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this protected_domain.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this protected_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this protected_domain.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/protected_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this protected_domain.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this protected_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of protected_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of protected_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_domainStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.protected_domain.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_domainStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of mitigated_domain", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mitigated_domainCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mitigated_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainCreateSpecType": { "type": "object", "description": "Create Mitigated Domain.", "title": "Create Mitigated Domain", "x-displayname": "Create Mitigated Domain.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.CreateSpecType", "properties": { "mitigated_domain": { "type": "string", "description": "Enter root domain or domain to be entered to mitigated list below.\nDomains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.\nExample: if you are adding Client-Side Defense JS on checkout.example.com, you should enter example.com here.", "maxLength": 256, "x-displayname": "Domain", "x-ves-example": "news.abc.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "news.abc.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Enter root domain or domain to be entered to mitigated list below. Domains can be entered only one at a time.", "x-f5xc-description-medium": "Enter root domain or domain to be entered to mitigated list below. Domains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainCreateSpecType", "required_fields": [ "mitigated_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"mitigated_domain\": \"news.abc.com\"\n}", "example_yaml": "mitigated_domain: news.abc.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a mitigated_domain", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read mitigated_domain", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/mitigated_domainCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mitigated_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/mitigated_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainGetSpecType": { "type": "object", "description": "GET Mitigated Domain.", "title": "Get Mitigated Domain", "x-displayname": "GET Mitigated Domain.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.GetSpecType", "properties": { "date_added": { "type": "string", "description": "The date when user adds mitigated domain.", "format": "date-time", "x-displayname": "Date Added.", "x-ves-example": "2021-09-21:44:34.171543432Z.", "x-f5xc-example": "2021-09-21:44:34.171543432Z", "x-f5xc-description-short": "The date when user adds mitigated domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_domain": { "type": "string", "description": "Enter root domain or domain to be entered to mitigated list below.\nDomains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.\nExample: if you are adding Client-Side Defense JS on checkout.example.com, you should enter example.com here.", "maxLength": 256, "x-displayname": "Domain", "x-ves-example": "news.abc.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "news.abc.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Enter root domain or domain to be entered to mitigated list below. Domains can be entered only one at a time.", "x-f5xc-description-medium": "Enter root domain or domain to be entered to mitigated list below. Domains can be entered only one at a time. In case of conflicting entries, the domain entry takes precedence over the root domain entry.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainGetSpecType", "required_fields": [ "mitigated_domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"mitigated_domain\": \"news.abc.com\"\n}", "example_yaml": "mitigated_domain: news.abc.com" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of mitigated_domain", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/mitigated_domainListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainListResponseItem": { "type": "object", "description": "By default a summary of mitigated_domain is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of mitigated_domain", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this mitigated_domain.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this mitigated_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this mitigated_domain.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this mitigated_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates mitigated_domain is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates mitigated_domain is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/mitigated_domainGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this mitigated_domain.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this mitigated_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this mitigated_domain.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/mitigated_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this mitigated_domain.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this mitigated_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of mitigated_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of mitigated_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "mitigated_domainStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.mitigated_domain.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mitigated_domainStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeRequest__ves_io_schema_shape_client_side_defense_subscription": { "type": "object", "description": "Request of subscribe to Client-Side Defense.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.SubscribeRequest", "x-f5xc-description-short": "Request of subscribe to Client-Side Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_shape_client_side_defense_subscription": { "type": "object", "description": "Response of subscribe to Client-Side Defense.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Client-Side Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_shape_client_side_defense_subscription": { "type": "object", "description": "Request of unsubscribe to Client-Side Defense.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.UnsubscribeRequest", "x-f5xc-description-short": "Request of unsubscribe to Client-Side Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_shape_client_side_defense_subscription": { "type": "object", "description": "Response of unsubscribe to Client-Side Defense.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.client_side_defense.subscription.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Client-Side Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "custom_certificateAddCertificateToCsrRequest": { "type": "object", "description": "Request to add a certificate to an existing CSR.", "title": "AddCertificateToCsrRequest", "x-displayname": "Add Certificate to CSR Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateToCsrRequest", "properties": { "certificate_content": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateContentForCsr" } ], "x-f5xc-description-short": "Configuration parameter for certificate content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Certificate Name", "minLength": 1, "x-displayname": "Certificate Name.", "x-ves-example": "Test-certificate.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "test-certificate", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to add a certificate to an existing CSR.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateAddCertificateToCsrRequest", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"test-certificate\",\n \"namespace\": \"default\"\n}", "example_yaml": "name: test-certificate\nnamespace: default" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateAddCertificateToCsrResponse": { "type": "object", "description": "Detailed certificate response after adding to CSR.", "title": "AddCertificateToCsrResponse", "x-displayname": "Add Certificate to CSR Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateToCsrResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate response after adding to CSR.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateAddCertificateToCsrResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateAddCertificateWithPrivateKeyRequest": { "type": "object", "description": "Request to add a certificate with private key.", "title": "AddCertificateWithPrivateKeyRequest", "x-displayname": "Add Certificate with Private Key Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateWithPrivateKeyRequest", "properties": { "certificate_content": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateContentWithPrivateKey" } ], "x-f5xc-description-short": "Configuration parameter for certificate content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Certificate Name", "minLength": 1, "x-displayname": "Certificate Name.", "x-ves-example": "Test-certificate.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "test-certificate", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to add a certificate with private key.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateAddCertificateWithPrivateKeyRequest", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"test-certificate\",\n \"namespace\": \"default\"\n}", "example_yaml": "name: test-certificate\nnamespace: default" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateAddCertificateWithPrivateKeyResponse": { "type": "object", "description": "Detailed certificate response after adding with private key.", "title": "AddCertificateWithPrivateKeyResponse", "x-displayname": "Add Certificate with Private Key Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.AddCertificateWithPrivateKeyResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate response after adding with private key.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateAddCertificateWithPrivateKeyResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateArchiveCertificateByIDRequest": { "type": "object", "description": "Request to archive certificate by ID.", "title": "ArchiveCertificateByIDRequest", "x-displayname": "Archive Certificate By ID Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.ArchiveCertificateByIDRequest", "properties": { "cert_id": { "type": "string", "description": "Unique identifier for this resource", "title": "Certificate ID", "x-displayname": "Certificate ID.", "x-ves-example": "65b73012a44742000137f379.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "65b73012a44742000137f379", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateArchiveCertificateByIDRequest", "required_fields": [ "cert_id", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert_id\": \"65b73012a44742000137f379\",\n \"namespace\": \"system\"\n}", "example_yaml": "cert_id: 65b73012a44742000137f379\nnamespace: system" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateArchiveCertificateByIDResponse": { "type": "object", "description": "Detailed certificate response after archive.", "title": "ArchiveCertificateByIDResponse", "x-displayname": "Archive Certificate By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.ArchiveCertificateByIDResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate response after archive.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateArchiveCertificateByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateCertificateContent": { "type": "object", "description": "Certificate and CSR content payload.", "title": "CertificateContent", "x-displayname": "Certificate Content.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.CertificateContent", "properties": { "cert": { "type": "string", "title": "Certificate", "x-displayname": "Certificate.", "description": "Configuration parameter for cert", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csr": { "type": "string", "title": "CSR", "x-displayname": "CSR", "description": "Configuration parameter for csr", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "title": "ID", "x-displayname": "ID", "description": "Unique identifier for the resource", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pkey": { "type": "string", "title": "Private Key", "x-displayname": "Private Key.", "description": "Configuration parameter for pkey", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateCertificateContent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateCertificateContentForCsr": { "type": "object", "description": "Certificate content to add to an existing CSR.", "title": "CertificateContentForCsr", "x-displayname": "Certificate Content for CSR.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.CertificateContentForCsr", "properties": { "cert": { "type": "string", "description": "Certificate in PEM format.", "title": "Certificate", "minLength": 1, "x-displayname": "Certificate.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "csr_id": { "type": "string", "description": "Unique identifier for this resource", "title": "CSR ID", "minLength": 1, "x-displayname": "CSR ID", "x-ves-example": "65b72ff6a44742000137f378.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "65b72ff6a44742000137f378", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Certificate content to add to an existing CSR.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateCertificateContentForCsr", "required_fields": [ "cert", "csr_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert\": \"value\",\n \"csr_id\": \"65b72ff6a44742000137f378\"\n}", "example_yaml": "cert: value\ncsr_id: 65b72ff6a44742000137f378" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateCertificateContentWithPrivateKey": { "type": "object", "description": "Certificate content with private key.", "title": "CertificateContentWithPrivateKey", "x-displayname": "Certificate Content with Private Key.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.CertificateContentWithPrivateKey", "properties": { "cert": { "type": "string", "description": "Certificate in PEM format.", "title": "Certificate", "minLength": 1, "x-displayname": "Certificate.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "pkey": { "type": "string", "description": "Private key in PEM format.", "title": "Private Key", "minLength": 1, "x-displayname": "Private Key.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateCertificateContentWithPrivateKey", "required_fields": [ "cert", "pkey" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert\": \"value\",\n \"pkey\": \"value\"\n}", "example_yaml": "cert: value\npkey: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateCertificateDetailResponse": { "type": "object", "description": "Detailed certificate or CSR response including content.", "title": "CertificateDetailResponse", "x-displayname": "Certificate Detail Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.CertificateDetailResponse", "properties": { "certificate_added": { "type": "boolean", "title": "Certificate Added", "format": "boolean", "x-displayname": "Certificate Added.", "description": "Configuration parameter for certificate added", "x-f5xc-description-short": "Configuration parameter for certificate added.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "certificate_added_date": { "type": "string", "title": "Certificate Added Date", "format": "date-time", "x-displayname": "Certificate Added Date.", "description": "Configuration parameter for certificate added date", "x-f5xc-description-short": "Configuration parameter for certificate added date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "certificate_content": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateContent" } ], "x-f5xc-description-short": "Configuration parameter for certificate content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "common_name": { "type": "string", "title": "Common Name", "x-displayname": "Common Name.", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country_name": { "type": "string", "title": "Country Name", "x-displayname": "Country Name.", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "created_by_user": { "type": "string", "title": "Created By User", "x-displayname": "Created By User.", "description": "Configuration parameter for created by user", "x-f5xc-description-short": "Configuration parameter for created by user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creation_time": { "type": "string", "title": "Creation Time", "format": "date-time", "x-displayname": "Creation Time.", "description": "Configuration parameter for creation time", "x-f5xc-description-short": "Configuration parameter for creation time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "csr_name": { "type": "string", "title": "CSR Name", "x-displayname": "CSR Name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "email": { "type": "string", "description": "Email address in RFC 5322 format", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-f5xc-example": "dana@example.com", "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "communication", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enterprise_id": { "type": "string", "title": "Enterprise ID", "x-displayname": "Enterprise ID.", "description": "Unique identifier for this resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "expiration_date": { "type": "string", "title": "Expiration Date", "format": "date-time", "x-displayname": "Expiration Date.", "description": "Configuration parameter for expiration date", "x-f5xc-description-short": "Configuration parameter for expiration date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "title": "ID", "x-displayname": "ID", "description": "Unique identifier for the resource", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "issuer": { "type": "string", "title": "Issuer", "x-displayname": "Issuer", "description": "Configuration parameter for issuer", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_update_time": { "type": "string", "title": "Last Update Time", "format": "date-time", "x-displayname": "Last Update Time.", "description": "Configuration parameter for last update time", "x-f5xc-description-short": "Configuration parameter for last update time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_updated_by_user": { "type": "string", "title": "Last Updated By User", "x-displayname": "Last Updated By User.", "description": "Configuration parameter for last updated by user", "x-f5xc-description-short": "Configuration parameter for last updated by user.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "locality": { "type": "string", "title": "Locality", "x-displayname": "Locality", "description": "Configuration parameter for locality", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "title": "Name", "x-displayname": "Name", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "organization_name": { "type": "string", "title": "Organization Name", "x-displayname": "Organization Name.", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "organization_unit_name": { "type": "string", "title": "Organization Unit Name", "x-displayname": "Organization Unit Name.", "description": "Human-readable name for the resource", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "retired": { "type": "boolean", "title": "Retired", "format": "boolean", "x-displayname": "Retired", "description": "Configuration parameter for retired", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "san": { "type": "array", "title": "SAN", "items": { "type": "string" }, "x-displayname": "SAN", "description": "Configuration parameter for san", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "title": "State", "x-displayname": "State", "description": "Current state of the resource", "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "used_by": { "type": "object", "title": "Used By", "x-displayname": "Used By", "description": "Configuration parameter for used by", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate or CSR response including content.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateCertificateDetailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateDeleteCSRByIDResponse": { "type": "object", "description": "Detailed CSR response after DELETE.", "title": "DeleteCSRByIDResponse", "x-displayname": "DELETE CSR By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.DeleteCSRByIDResponse", "properties": { "csr_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateDeleteCSRByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateDeleteCertificateByIDResponse": { "type": "object", "description": "Detailed certificate response after DELETE.", "title": "DeleteCertificateByIDResponse", "x-displayname": "DELETE Certificate By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.DeleteCertificateByIDResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate response after DELETE.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateDeleteCertificateByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateGenerateCSRRequest": { "type": "object", "description": "Request to generate CSR.", "title": "GenerateCSRRequest", "x-displayname": "Generate CSR Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.GenerateCSRRequest", "properties": { "common_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Common Name", "minLength": 1, "x-displayname": "Common Name.", "x-ves-example": "example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "country_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Country Name", "minLength": 1, "x-displayname": "Country Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "csr_name": { "type": "string", "description": "Human-readable name for the resource", "title": "CSR Name", "minLength": 1, "x-displayname": "CSR Name", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "email": { "type": "string", "description": "Email address in RFC 5322 format", "title": "Email", "minLength": 1, "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.email": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.email": "true", "ves.io.schema.rules.string.min_len": "1" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "locality": { "type": "string", "description": "Configuration parameter for locality", "title": "Locality", "minLength": 1, "x-displayname": "Locality", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "organization_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Organization Name", "minLength": 1, "x-displayname": "Organization Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "organization_unit_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Organization Unit Name", "minLength": 1, "x-displayname": "Organization Unit Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "san_main": { "type": "string", "description": "Configuration parameter for san main", "title": "SAN Main", "minLength": 1, "x-displayname": "SAN Main", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "san_sub": { "type": "array", "title": "SAN Sub", "items": { "type": "string" }, "x-displayname": "SAN Sub", "description": "Configuration parameter for san sub", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "Current state of the resource", "title": "State", "minLength": 1, "x-displayname": "State", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateGenerateCSRRequest", "required_fields": [ "common_name", "country_name", "csr_name", "email", "locality", "namespace", "organization_name", "organization_unit_name", "san_main", "state" ], "mutually_exclusive_groups": [], "example_json": "{\n \"common_name\": \"example.com\",\n \"country_name\": \"example-resource\",\n \"csr_name\": \"example-resource\",\n \"email\": \"dana@example.com\",\n \"locality\": \"value\",\n \"namespace\": \"default\",\n \"organization_name\": \"example-resource\",\n \"organization_unit_name\": \"example-resource\",\n \"san_main\": \"value\",\n \"state\": \"running\"\n}", "example_yaml": "common_name: example.com\ncountry_name: example-resource\ncsr_name: example-resource\nemail: dana@example.com\nlocality: value\nnamespace: default\norganization_name: example-resource\norganization_unit_name: example-resource\nsan_main: value\nstate: running" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateGenerateCSRResponse": { "type": "object", "description": "Generated CSR content.", "title": "GenerateCSRResponse", "x-displayname": "Generate CSR Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.GenerateCSRResponse", "properties": { "certificate_content": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateContent" } ], "x-f5xc-description-short": "Configuration parameter for certificate content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateGenerateCSRResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateGetCSRByIDResponse": { "type": "object", "description": "Detailed CSR response.", "title": "GetCSRByIDResponse", "x-displayname": "GET CSR By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.GetCSRByIDResponse", "properties": { "csr_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateGetCSRByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateGetCertificateByIDResponse": { "type": "object", "description": "Detailed certificate response.", "title": "GetCertificateByIDResponse", "x-displayname": "GET Certificate By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.GetCertificateByIDResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateGetCertificateByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateListCSRResponse": { "type": "object", "description": "Response containing CSRs for enterprise.", "title": "ListCSRResponse", "x-displayname": "List CSR Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.ListCSRResponse", "properties": { "csr": { "type": "array", "title": "CSRs", "items": { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" }, "x-displayname": "List of CSRs.", "description": "Configuration parameter for csr", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response containing CSRs for enterprise.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateListCSRResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateListCertificatesResponse": { "type": "object", "description": "Response containing certificates for enterprise.", "title": "ListCertificatesResponse", "x-displayname": "List Certificates Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.ListCertificatesResponse", "properties": { "certificate": { "type": "array", "title": "Certificates", "items": { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" }, "x-displayname": "List of Certificates.", "description": "X.509 certificate for TLS", "x-f5xc-example": "[REDACTED_CERTIFICATE]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response containing certificates for enterprise.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateListCertificatesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateUnarchiveCertificateByIDRequest": { "type": "object", "description": "Request to unarchive certificate by ID.", "title": "UnarchiveCertificateByIDRequest", "x-displayname": "Unarchive Certificate By ID Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.UnarchiveCertificateByIDRequest", "properties": { "cert_id": { "type": "string", "description": "Unique identifier for this resource", "title": "Certificate ID", "x-displayname": "Certificate ID.", "x-ves-example": "65b73012a44742000137f379.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "65b73012a44742000137f379", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateUnarchiveCertificateByIDRequest", "required_fields": [ "cert_id", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert_id\": \"65b73012a44742000137f379\",\n \"namespace\": \"system\"\n}", "example_yaml": "cert_id: 65b73012a44742000137f379\nnamespace: system" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "custom_certificateUnarchiveCertificateByIDResponse": { "type": "object", "description": "Detailed certificate response after unarchive.", "title": "UnarchiveCertificateByIDResponse", "x-displayname": "Unarchive Certificate By ID Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.custom_certificate.UnarchiveCertificateByIDResponse", "properties": { "certificate_detail": { "allOf": [ { "$ref": "#/components/schemas/custom_certificateCertificateDetailResponse" } ], "x-f5xc-description-short": "Configuration parameter for certificate detail.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Detailed certificate response after unarchive.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for custom_certificateUnarchiveCertificateByIDResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "receiverAuthToken": { "type": "object", "description": "Authentication Token for access.", "title": "Token Authentication", "x-displayname": "Access Token.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.AuthToken", "properties": { "token": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverAuthToken", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverAzureBlobConfig": { "type": "object", "description": "Azure Blob Configuration for Data Delivery.", "title": "Azur Blob Configuration", "x-displayname": "Azure Blob Configuration.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.AzureBlobConfig", "properties": { "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connection_string": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for connection string.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "container_name": { "type": "string", "description": "Container Name is the name of the container into which logs should be stored.", "title": "Container Name", "minLength": 3, "maxLength": 63, "x-displayname": "Container Name.", "x-ves-example": "Logs", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "63", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, "x-f5xc-example": "logs", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "63", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$" }, "x-f5xc-description-short": "Container Name is the name of the container into which logs should be stored.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Azure Blob Configuration for Data Delivery.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverAzureBlobConfig", "required_fields": [ "container_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"container_name\": \"logs\"\n}", "example_yaml": "container_name: logs" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverBatchOptionType": { "type": "object", "description": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.", "title": "Batch Options", "x-displayname": "Batch OPTIONS.", "x-ves-oneof-field-batch_bytes": "[\"max_bytes\",\"max_bytes_disabled\"]", "x-ves-oneof-field-batch_events": "[\"max_events\",\"max_events_disabled\"]", "x-ves-oneof-field-batch_timeout": "[\"default_timeout_seconds\",\"timeout_seconds\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.BatchOptionType", "properties": { "default_timeout_seconds": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "timeout_seconds" ] }, "max_bytes": { "type": "integer", "description": "Exclusive with [max_bytes_disabled]\nSend batch to endpoint after the batch is equal to or larger than this many bytes.", "title": "Max Bytes", "format": "int64", "x-displayname": "Max Bytes", "x-ves-example": "16384", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "4096", "ves.io.schema.rules.uint32.lte": "104857600" }, "x-f5xc-example": "16384", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "4096", "ves.io.schema.rules.uint32.lte": "104857600" }, "x-f5xc-description-short": "Exclusive with [max_bytes_disabled] Send batch to endpoint after the batch is equal to or larger than this many bytes.", "x-f5xc-description-medium": "Exclusive with [max_bytes_disabled] Send batch to endpoint after the batch is equal to or larger than this many bytes.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 4096, "maximum": 104857600, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "max_bytes_disabled" ] }, "max_bytes_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "max_bytes" ] }, "max_events": { "type": "integer", "description": "Exclusive with [max_events_disabled]\nSend batch to endpoint after this many log messages are in the batch.", "title": "Max Events", "format": "int64", "x-displayname": "Max Events.", "x-ves-example": "200", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "32", "ves.io.schema.rules.uint32.lte": "100000" }, "x-f5xc-example": "200", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "32", "ves.io.schema.rules.uint32.lte": "100000" }, "x-f5xc-description-short": "Exclusive with [max_events_disabled] Send batch to endpoint after this many log messages are in the batch.", "x-f5xc-description-medium": "Exclusive with [max_events_disabled] Send batch to endpoint after this many log messages are in the batch.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 32, "maximum": 100000, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "max_events_disabled" ] }, "max_events_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "max_events" ] }, "timeout_seconds": { "type": "string", "description": "Exclusive with [default_timeout_seconds]\nSend batch to the endpoint after this many seconds.", "title": "Timeout Seconds", "format": "uint64", "x-displayname": "Timeout Seconds.", "x-ves-example": "600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "300-3600" }, "x-f5xc-example": "600", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "300-3600" }, "x-f5xc-description-short": "Exclusive with [default_timeout_seconds] Send batch to the endpoint after this many seconds.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_timeout_seconds" ] } }, "x-f5xc-description-short": "Batch OPTIONS allow tuning for how batches of logs are sent to an endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverBatchOptionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverCompressionType": { "type": "object", "description": "Compression Type.", "title": "CompressionType", "x-displayname": "Compression Type.", "x-ves-oneof-field-compression_choice": "[\"gzip_compression\",\"no_compression\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.CompressionType", "properties": { "gzip_compression": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_compression" ] }, "no_compression": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gzip_compression" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverCompressionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of receiver", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/receiverCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/receiverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverCreateSpecType": { "type": "object", "description": "Creates a new Data Delivery object.", "title": "Create Data Delivery", "x-displayname": "Create Data Delivery.", "x-ves-oneof-field-receiver": "[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.CreateSpecType", "properties": { "azure_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverAzureBlobConfig" } ], "x-f5xc-description-short": "Configuration parameter for azure receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "datadog_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverDatadogConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "dataset_type": { "type": "string", "description": "Select the Data Set.", "maxLength": 128, "x-displayname": "Data Set", "x-ves-example": "DI Advanced.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "DI Advanced", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "gcp_bucket_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverGCPBucketConfig" } ], "x-f5xc-description-short": "Configuration parameter for gcp bucket receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "http_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverHTTPConfig" } ], "x-f5xc-description-short": "Configuration parameter for http receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "s3_receiver", "splunk_receiver" ] }, "s3_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverS3Config" } ], "x-f5xc-description-short": "Configuration parameter for s3 receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "splunk_receiver" ] }, "splunk_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverSplunkConfig" } ], "x-f5xc-description-short": "Configuration parameter for splunk receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverCreateSpecType", "required_fields": [ "dataset_type" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dataset_type\": \"DI Advanced\"\n}", "example_yaml": "dataset_type: DI Advanced" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverDatadogConfig": { "type": "object", "description": "Configuration for Datadog endpoint.", "title": "Datadog Configuration", "x-displayname": "Datadog Configuration.", "x-ves-oneof-field-endpoint_choice": "[\"endpoint\",\"site\"]", "x-ves-oneof-field-tls_choice": "[\"no_tls\",\"use_tls\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.DatadogConfig", "properties": { "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "datadog_api_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint": { "type": "string", "description": "Exclusive with [site]\nDatadog Endpoint,.", "title": "Datadog Endpoint", "x-displayname": "Datadog Endpoint.", "x-ves-example": "example.com:9000.", "x-f5xc-example": "example.com:9000", "x-f5xc-description-short": "Exclusive with [site] Datadog Endpoint,.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^https?://[^\\s/$.?#].[^\\s]*$", "format": "uri", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site" ] }, "no_tls": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_tls" ] }, "site": { "type": "string", "description": "Exclusive with [endpoint]\nDatadog Site,.", "title": "Datadog Site", "x-displayname": "Datadog Site.", "x-ves-example": "datadoghq.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname_or_ip": "true" }, "x-f5xc-example": "datadoghq.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname_or_ip": "true" }, "x-f5xc-description-short": "Exclusive with [endpoint] Datadog Site,.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "endpoint" ] }, "use_tls": { "allOf": [ { "$ref": "#/components/schemas/receiverTLSConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_tls" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverDatadogConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a receiver", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverGCPBucketConfig": { "type": "object", "description": "GCP Bucket Configuration for Global Log Receiver.", "title": "GCP Bucket Configuration", "x-displayname": "GCP BucketConfiguration.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.GCPBucketConfig", "properties": { "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bucket": { "type": "string", "description": "GCP Bucket Name.", "title": "GCP Bucket Name", "minLength": 3, "maxLength": 128, "x-displayname": "GCP Bucket Name.", "x-ves-example": "Example-log-bucket.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$" }, "x-f5xc-example": "example-log-bucket", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 3, "maxLength": 128, "pattern": "^[a-z0-9]+[a-z0-9_\\\\.-]+[a-z0-9]$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "gcp_cred", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "GCP Bucket Configuration for Global Log Receiver.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverGCPBucketConfig", "required_fields": [ "bucket" ], "mutually_exclusive_groups": [], "example_json": "{\n \"bucket\": \"example-log-bucket\"\n}", "example_yaml": "bucket: example-log-bucket" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read receiver", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/receiverCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/receiverReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/receiverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/receiverStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverGetSpecType": { "type": "object", "description": "GET the Data Delivery object.", "title": "Get Data Delivery", "x-displayname": "GET Data Delivery.", "x-ves-oneof-field-receiver": "[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.GetSpecType", "properties": { "azure_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverAzureBlobConfig" } ], "x-f5xc-description-short": "Configuration parameter for azure receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "datadog_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverDatadogConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "dataset_type": { "type": "string", "description": "Select the Data Set.", "maxLength": 128, "x-displayname": "Data Set", "x-ves-example": "DI Advanced.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "DI Advanced", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "delivery_status": { "type": "string", "description": "Delivery Status i.e Success/ Failed/ Pending.", "x-displayname": "Delivery Status.", "x-ves-example": "Pending", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]" }, "x-f5xc-example": "Pending", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Pending\\\"]" }, "x-f5xc-description-short": "Delivery Status i.e Success/ Failed/ Pending.", "maxLength": 1024, "enum": [ "Success", "Failed", "Pending" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "frequency_seconds": { "type": "string", "description": "Deliver logs at this frequency. Default is 5 min (300 seconds)", "format": "uint64", "x-displayname": "Frequency", "x-ves-example": "300", "x-f5xc-example": "300", "x-f5xc-description-short": "Deliver logs at this frequency. Default is 5 min (300 seconds)", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gcp_bucket_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverGCPBucketConfig" } ], "x-f5xc-description-short": "Configuration parameter for gcp bucket receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "http_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverHTTPConfig" } ], "x-f5xc-description-short": "Configuration parameter for http receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "s3_receiver", "splunk_receiver" ] }, "last_sent": { "type": "string", "description": "The date when logs were last delivered to the customer.", "format": "date-time", "x-displayname": "Last Sent", "x-ves-example": "2021-09-21:44:34.171543432Z.", "x-f5xc-example": "2021-09-21:44:34.171543432Z", "x-f5xc-description-short": "The date when logs were last delivered to the customer.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receiver_state": { "type": "string", "description": "State of the Receiver i.e Enabled/ Disabled.", "x-displayname": "Receiver State.", "x-ves-example": "Enabled", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"Enabled\\\",\\\"Disabled\\\"]" }, "x-f5xc-example": "Enabled", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"Enabled\\\",\\\"Disabled\\\"]" }, "x-f5xc-description-short": "State of the Receiver i.e Enabled/ Disabled.", "maxLength": 1024, "enum": [ "Enabled", "Disabled" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "s3_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverS3Config" } ], "x-f5xc-description-short": "Configuration parameter for s3 receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "splunk_receiver" ] }, "splunk_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverSplunkConfig" } ], "x-f5xc-description-short": "Configuration parameter for splunk receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverGetSpecType", "required_fields": [ "dataset_type", "delivery_status", "receiver_state" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dataset_type\": \"DI Advanced\",\n \"delivery_status\": \"Pending\",\n \"receiver_state\": \"Enabled\"\n}", "example_yaml": "dataset_type: DI Advanced\ndelivery_status: Pending\nreceiver_state: Enabled" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverHTTPConfig": { "type": "object", "description": "Configuration for HTTP endpoint.", "title": "HTTP Configuration", "x-displayname": "HTTP Configuration.", "x-ves-oneof-field-auth_choice": "[\"auth_basic\",\"auth_none\",\"auth_token\"]", "x-ves-oneof-field-tls_choice": "[\"no_tls\",\"use_tls\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.HTTPConfig", "properties": { "auth_basic": { "allOf": [ { "$ref": "#/components/schemas/receiverHttpAuthBasic" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_none", "auth_token" ] }, "auth_none": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_basic", "auth_token" ] }, "auth_token": { "allOf": [ { "$ref": "#/components/schemas/receiverAuthToken" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_basic", "auth_none" ] }, "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_tls": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_tls" ] }, "uri": { "type": "string", "description": "HTTP URI is the URI of the HTTP endpoint to send logs to,.", "title": "HTTP Uri", "x-displayname": "HTTP URI", "x-ves-example": "http://example.com:9000/logs.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "http://example.com:9000/logs", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "HTTP URI is the URI of the HTTP endpoint to send logs to,.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "use_tls": { "allOf": [ { "$ref": "#/components/schemas/receiverTLSConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_tls" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverHTTPConfig", "required_fields": [ "uri" ], "mutually_exclusive_groups": [], "example_json": "{\n \"uri\": \"http://example.com:9000/logs\"\n}", "example_yaml": "uri: http://example.com:9000/logs" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverHttpAuthBasic": { "type": "object", "description": "Authentication parameters to access HTTP Log Receiver Endpoint.", "title": "HTTP Basic Authentication", "x-displayname": "Basic Authentication Credentials.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.HttpAuthBasic", "properties": { "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_name": { "type": "string", "description": "HTTP Basic Auth User Name.", "title": "username", "maxLength": 64, "x-displayname": "User Name", "x-ves-example": "Joe", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "Joe", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Authentication parameters to access HTTP Log Receiver Endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverHttpAuthBasic", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of receiver", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/receiverListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverListResponseItem": { "type": "object", "description": "By default a summary of receiver is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of receiver", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this receiver.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this receiver.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates receiver is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates receiver is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/receiverGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this receiver.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this receiver.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/receiverStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this receiver.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a receiver", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/receiverReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverReplaceSpecType": { "type": "object", "description": "Replaces the content of an Data Delivery object.", "title": "Replace Log Receiver", "x-displayname": "Replace Data Delivery.", "x-ves-oneof-field-receiver": "[\"azure_receiver\",\"datadog_receiver\",\"gcp_bucket_receiver\",\"http_receiver\",\"s3_receiver\",\"splunk_receiver\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.ReplaceSpecType", "properties": { "azure_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverAzureBlobConfig" } ], "x-f5xc-description-short": "Configuration parameter for azure receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "datadog_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverDatadogConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "dataset_type": { "type": "string", "description": "Select the Data Set.", "maxLength": 128, "x-displayname": "Data Set", "x-ves-example": "DI Advanced.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "DI Advanced", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "gcp_bucket_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverGCPBucketConfig" } ], "x-f5xc-description-short": "Configuration parameter for gcp bucket receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "http_receiver", "s3_receiver", "splunk_receiver" ] }, "http_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverHTTPConfig" } ], "x-f5xc-description-short": "Configuration parameter for http receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "s3_receiver", "splunk_receiver" ] }, "s3_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverS3Config" } ], "x-f5xc-description-short": "Configuration parameter for s3 receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "splunk_receiver" ] }, "splunk_receiver": { "allOf": [ { "$ref": "#/components/schemas/receiverSplunkConfig" } ], "x-f5xc-description-short": "Configuration parameter for splunk receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure_receiver", "datadog_receiver", "gcp_bucket_receiver", "http_receiver", "s3_receiver" ] } }, "x-f5xc-description-short": "Replaces the content of an Data Delivery object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverReplaceSpecType", "required_fields": [ "dataset_type" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dataset_type\": \"DI Advanced\"\n}", "example_yaml": "dataset_type: DI Advanced" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverS3Config": { "type": "object", "description": "S3 Configuration for Data Delivery.", "title": "S3 Configuration", "x-displayname": "S3 Configuration.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.S3Config", "properties": { "aws_cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "aws_cred", "gated_by": null, "required": false, "cardinality": "single" } ] }, "aws_region": { "type": "string", "description": "AWS Region Name.", "title": "AWS Region", "x-displayname": "AWS Region.", "x-ves-example": "Us-east-1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]" }, "x-f5xc-example": "us-east-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"ap-northeast-1\\\",\\\"ap-southeast-1\\\",\\\"eu-central-1\\\",\\\"eu-west-1\\\",\\\"eu-west-3\\\",\\\"sa-east-1\\\",\\\"us-east-1\\\",\\\"us-east-2\\\",\\\"us-west-2\\\",\\\"ca-central-1\\\",\\\"af-south-1\\\",\\\"ap-east-1\\\",\\\"ap-south-1\\\",\\\"ap-northeast-2\\\",\\\"ap-southeast-2\\\",\\\"eu-south-1\\\",\\\"eu-north-1\\\",\\\"eu-west-2\\\",\\\"me-south-1\\\",\\\"us-west-1\\\",\\\"ap-southeast-3\\\"]" }, "maxLength": 1024, "enum": [ "ap-northeast-1", "ap-southeast-1", "eu-central-1", "eu-west-1", "eu-west-3", "sa-east-1", "us-east-1", "us-east-2", "us-west-2", "ca-central-1", "af-south-1", "ap-east-1", "ap-south-1", "ap-northeast-2", "ap-southeast-2", "eu-south-1", "eu-north-1", "eu-west-2", "me-south-1", "us-west-1", "ap-southeast-3" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bucket": { "type": "string", "description": "S3 Bucket Name.", "title": "S3 Bucket Name", "minLength": 3, "maxLength": 128, "x-displayname": "S3 Bucket Name.", "x-ves-example": "Example-bucket.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$" }, "x-f5xc-example": "example-bucket", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "128", "ves.io.schema.rules.string.min_len": "3", "ves.io.schema.rules.string.pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 3, "maxLength": 128, "pattern": "^[a-z0-9]+[a-z0-9\\\\.-]+[a-z0-9]$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverS3Config", "required_fields": [ "aws_region", "bucket" ], "mutually_exclusive_groups": [], "example_json": "{\n \"aws_region\": \"us-east-1\",\n \"bucket\": \"example-bucket\"\n}", "example_yaml": "aws_region: us-east-1\nbucket: example-bucket" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverSplunkConfig": { "type": "object", "description": "Configuration for Splunk HEC Logs endpoint.", "title": "Splunk HEC Logs Configuration", "x-displayname": "Splunk HEC Logs Configuration.", "x-ves-oneof-field-tls_choice": "[\"no_tls\",\"use_tls\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.SplunkConfig", "properties": { "batch": { "allOf": [ { "$ref": "#/components/schemas/receiverBatchOptionType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "compression": { "allOf": [ { "$ref": "#/components/schemas/receiverCompressionType" } ], "x-f5xc-description-short": "Configuration parameter for compression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint": { "type": "string", "description": "Splunk HEC Logs Endpoint,.", "title": "Splunk HEC Logs Endpoint", "x-displayname": "Splunk HEC Logs Endpoint.", "x-ves-example": "https://http-inputs-hec.splunkcloud.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "https://http-inputs-hec.splunkcloud.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^https?://[^\\s/$.?#].[^\\s]*$", "format": "uri", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "no_tls": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_tls" ] }, "splunk_hec_token": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-description-short": "Configuration parameter for splunk hec token.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_tls": { "allOf": [ { "$ref": "#/components/schemas/receiverTLSConfigType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_tls" ] } }, "x-f5xc-description-short": "Configuration for Splunk HEC Logs endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverSplunkConfig", "required_fields": [ "endpoint" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endpoint\": \"https://http-inputs-hec.splunkcloud.com\"\n}", "example_yaml": "endpoint: https://http-inputs-hec.splunkcloud.com" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Data Delivery Status", "x-displayname": "Status Object.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverTLSClientConfigType": { "type": "object", "description": "MTLS Client config allows configuration of mTLS client OPTIONS.", "title": "mTLS Client config", "x-displayname": "MTLS Client Config.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.TLSClientConfigType", "properties": { "certificate": { "type": "string", "description": "Client certificate is PEM-encoded certificate or certificate-chain.", "maxLength": 131072, "x-displayname": "Client Certificate.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Client certificate is PEM-encoded certificate or certificate-chain.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "minLength": 100, "pattern": "^-----BEGIN CERTIFICATE-----\\n.*\\n-----END CERTIFICATE-----$", "format": "uri", "formatDescription": "PEM-encoded X.509 certificate, max 5MB", "byteLength": { "max": 131072 }, "validation": { "standard": "PEM" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key_url": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "MTLS Client config allows configuration of mTLS client OPTIONS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverTLSClientConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "receiverTLSConfigType": { "type": "object", "description": "TLS Parameters for client connection to the endpoint.", "title": "Endpoint TLS Parameters", "x-displayname": "TLS Parameters Endpoint.", "x-ves-oneof-field-ca_choice": "[\"no_ca\",\"trusted_ca_url\"]", "x-ves-oneof-field-mtls_choice": "[\"mtls_disabled\",\"mtls_enable\"]", "x-ves-oneof-field-verify_certificate": "[\"disable_verify_certificate\",\"enable_verify_certificate\"]", "x-ves-oneof-field-verify_hostname": "[\"disable_verify_hostname\",\"enable_verify_hostname\"]", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.receiver.TLSConfigType", "properties": { "disable_verify_certificate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable verify certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_verify_certificate" ] }, "disable_verify_hostname": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable_verify_hostname" ] }, "enable_verify_certificate": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for enable verify certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_verify_certificate" ] }, "enable_verify_hostname": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_verify_hostname" ] }, "mtls_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mtls_enable" ] }, "mtls_enable": { "allOf": [ { "$ref": "#/components/schemas/receiverTLSClientConfigType" } ], "x-f5xc-description-short": "Configuration parameter for mtls enable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mtls_disabled" ] }, "no_ca": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "trusted_ca_url" ] }, "trusted_ca_url": { "type": "string", "description": "Exclusive with [no_ca]\nThe URL or value for trusted Server CA certificate or certificate chain\nCertificates in PEM format including the PEM headers.", "title": "Server CA certificates", "maxLength": 131072, "x-displayname": "Server CA Certificates.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Exclusive with [no_ca] The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers.", "x-f5xc-description-medium": "Exclusive with [no_ca] The URL or value for trusted Server CA certificate or certificate chain Certificates in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "byteLength": { "max": 131072 }, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_ca" ] } }, "x-f5xc-description-short": "TLS Parameters for client connection to the endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for receiverTLSConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "schemaBlindfoldSecretInfoType": { "type": "object", "description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "title": "BlindfoldSecretInfoType", "x-displayname": "Blindfold Secret.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BlindfoldSecretInfoType", "properties": { "decryption_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "title": "Decryption Provider", "x-displayname": "Decryption Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location is the uri_ref. It could be in URL format for string:///\nOr it could be a path if the store provider is an HTTP/HTTPS location.", "title": "Location", "x-displayname": "Location", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "minLength": 4, "maxLength": 131072, "format": "uri", "deterministic": true, "metadata": { "source": "manual-override", "confidence": 1.0, "category": "content", "note": "Blindfold envelope encryption (AES-256-GCM + RSA-OAEP) of an RSA-2048 TLS private key produces ~3700 char string:/// URL. 128KB max secret size = ~175KB base64. Discovery reported 1024 which is incorrect.", "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "store_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Store Provider", "x-displayname": "Store Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBlindfoldSecretInfoType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "location: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "per-tenant" } } }, "schemaClearSecretInfoType": { "type": "object", "description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "title": "ClearSecretInfoType", "x-displayname": "In-Clear Secret.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.ClearSecretInfoType", "properties": { "provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "Box-provider.", "x-f5xc-example": "box-provider", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "URL of the secret. Currently supported URL schemes is string:///.\nFor string:/// scheme, Secret needs to be encoded Base64 format.\nWhen asked for this secret, caller will GET Secret bytes after Base64 decoding.", "title": "URL", "maxLength": 131072, "x-displayname": "URL", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.", "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding.", "format": "uri", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 131072 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaClearSecretInfoType", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "url: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaSecretType": { "type": "object", "description": "SecretType is used in an object to indicate a sensitive/confidential field.", "title": "SecretType", "x-displayname": "Secret", "x-ves-oneof-field-secret_info_oneof": "[\"blindfold_secret_info\",\"clear_secret_info\"]", "x-ves-proto-message": "ves.io.schema.SecretType", "properties": { "blindfold_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaBlindfoldSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "clear_secret_info" ] }, "clear_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaClearSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blindfold_secret_info" ] } }, "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSecretType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Secret management is platform-level" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "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)\nthen name will hold the referred object's(e.g. Route's) name.", "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" }, "x-f5xc-example": "contacts-route", "x-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" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryDataPoint": { "type": "object", "description": "Message object representing data point.", "title": "DataPoint", "x-displayname": "Data Point.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.DataPoint", "properties": { "timestamp": { "type": "string", "description": "Unix timestamp (seconds since epoch)", "title": "Timestamp", "format": "int64", "x-displayname": "Timestamp", "x-f5xc-example": "2025-01-15T10:30:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "int64", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "number", "description": "Value at the given timestamp.", "title": "Value", "format": "double", "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryDataPoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryDataSet": { "type": "object", "description": "Represents the dataset details.", "title": "DataSet", "x-displayname": "DataSet", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.DataSet", "properties": { "description": { "type": "string", "description": "Detailed description of the dataset.", "title": "Description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "id": { "type": "string", "description": "Unique string ID for the dataset.", "title": "DataSet ID", "x-displayname": "DataSet ID.", "x-ves-example": "Di-advanced-bot.", "x-f5xc-example": "di-advanced-bot", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the dataset.", "title": "Name", "x-displayname": "Name", "x-ves-example": "String", "x-f5xc-example": "string", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "type": "string", "description": "Information to suggest if the dataset is currently subscribed by the tenant.", "title": "Status", "x-displayname": "Status", "x-ves-example": "Subscribed.", "x-f5xc-example": "subscribed", "x-f5xc-description-short": "Information to suggest if the dataset is currently subscribed by the tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryDataSet", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryEventsReason": { "type": "object", "description": "Message object representing events reason.", "title": "EventsReason", "x-displayname": "Events Reason.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.EventsReason", "properties": { "category": { "type": "string", "description": "String representing event category.", "title": "Category", "x-displayname": "Category", "x-ves-example": "DeviceID", "x-f5xc-example": "DeviceID", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "eventsCount": { "type": "integer", "description": "Number of such events.", "title": "EventsCount", "format": "int64", "x-displayname": "Events Count.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "eventsPercentage": { "type": "number", "description": "Number of such events percentage.", "title": "EventsPercentage", "format": "double", "x-displayname": "Events Percentage.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "String representing event reason.", "title": "Reason", "x-displayname": "Reason", "x-ves-example": "High Distinct Local Cache ID Volume.", "x-f5xc-example": "High Distinct Local Cache ID Volume", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Message object representing events reason.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryEventsReason", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryFeature": { "type": "object", "description": "Definition of feature which is unit of dataset.", "title": "Feature", "x-displayname": "Feature", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.Feature", "properties": { "data_format": { "type": "string", "description": "Data or content configuration", "title": "Data format", "x-displayname": "Data format.", "x-ves-example": "String", "x-f5xc-example": "string", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Detailed description of the feature.", "title": "Description\nx-displayName: \"Description\"\nDetailed description of the feature", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "feature_name": { "type": "string", "description": "Name of the feature.", "title": "feature name", "x-displayname": "Feature Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "is_new_field": { "type": "boolean", "description": "Information to suggest if this is existing or new feature in dataset.", "title": "IsNewField", "format": "boolean", "x-displayname": "IsNewField.", "x-f5xc-description-short": "Information to suggest if this is existing or new feature in dataset.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "notes": { "type": "string", "description": "Additional notes about the dataset feature.", "title": "Notes", "x-displayname": "Notes", "x-f5xc-description-short": "Additional notes about the dataset feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "required": { "type": "boolean", "description": "Is the feature mandatory or optional.", "title": "Required", "format": "boolean", "x-displayname": "Required", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Definition of feature which is unit of dataset.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryFeature", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryFlowLabel": { "type": "object", "description": "Message representing flow label information.", "title": "FlowLabel", "x-displayname": "Flow Label.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.FlowLabel", "properties": { "flowLabel": { "type": "string", "description": "FlowLabel for filtering the data.", "title": "FlowLabel", "x-displayname": "Flow Label.", "x-ves-example": "Login", "x-f5xc-example": "Login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "platform": { "type": "string", "description": "Platform for filtering the data.", "title": "Platform", "x-displayname": "Platform", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message representing flow label information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryFlowLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryGetDataDictionaryResponse": { "type": "object", "description": "Dataset feature fetched by data dictionary API.", "title": "GetDataDictionaryResponse", "x-displayname": "Dataset feature.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.GetDataDictionaryResponse", "properties": { "feature_list": { "type": "array", "description": "List of features for requested dataset.", "title": "Feature list", "items": { "$ref": "#/components/schemas/data_deliveryFeature" }, "x-displayname": "Feature List.", "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Dataset feature fetched by data dictionary API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryGetDataDictionaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryGetDataSetsResponse": { "type": "object", "description": "List of Data Sets eligible for the tenant.", "title": "GetDataSetsResponse", "x-displayname": "Data Set", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.GetDataSetsResponse", "properties": { "dataSets": { "type": "array", "items": { "type": "string" }, "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-example": "DI Advanced", "x-f5xc-description-short": "List of Data Sets eligible for the tenant.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryGetDataSetsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryLineChartData": { "type": "object", "description": "Message object representing line chart data.", "title": "LineChartData", "x-displayname": "Line Chart Data.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.LineChartData", "properties": { "granularity": { "type": "string", "description": "Granularity of the data points (\"1m\", \"5m\", etc.)", "title": "Granularity", "x-displayname": "Granularity.", "x-ves-example": "5m", "x-f5xc-example": "5m", "x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "series": { "type": "array", "description": "Array of data series.", "title": "Series", "items": { "$ref": "#/components/schemas/data_deliverySeries" }, "x-displayname": "Series", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message object representing line chart data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryLineChartData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryListDataSetsResponse": { "type": "object", "description": "Response of list datasets by tenant.", "title": "ListDataSetsResponse", "x-displayname": "List DataSets Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.ListDataSetsResponse", "properties": { "dataset_list": { "type": "array", "description": "List of datasets for tenant.", "title": "DataSet list", "items": { "$ref": "#/components/schemas/data_deliveryDataSet" }, "x-displayname": "DataSet List.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryListDataSetsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryListFlowLabelsResponse": { "type": "object", "description": "Response object to list flow labels.", "title": "ListFlowLabelsResponse", "x-displayname": "List FlowLabels Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.ListFlowLabelsResponse", "properties": { "flowLabels": { "type": "array", "description": "Flow labels.", "title": "FlowLabels", "items": { "$ref": "#/components/schemas/data_deliveryFlowLabel" }, "x-displayname": "FlowLabels.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryListFlowLabelsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryLoadExecutiveSummaryRequest": { "type": "object", "description": "Request object to GET executive summary of DI premium customer.", "title": "LoadExecutiveSummaryRequest", "x-displayname": "Load Executive Summary Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.LoadExecutiveSummaryRequest", "properties": { "anomalousScorePercentile": { "type": "number", "description": "Percentile of anomalous score.", "title": "AnomalousScorePercentile", "format": "double", "x-displayname": "AnomalousScorePercentile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flowLabels": { "type": "array", "description": "FlowLabel for filtering the data.", "title": "FlowLabels", "items": { "$ref": "#/components/schemas/data_deliveryFlowLabel" }, "x-displayname": "Flow Labels.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "granularity": { "type": "string", "description": "Granularity of the data points (\"1m\", \"5m\", etc.)", "title": "Granularity", "x-displayname": "Granularity.", "x-ves-example": "5m", "x-f5xc-example": "5m", "x-f5xc-description-short": "Granularity of the data points (\"1m\", \"5m\", etc.).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the suggestions are scoped.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Foobar", "x-f5xc-example": "foobar", "x-f5xc-description-short": "Namespace in which the suggestions are scoped.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "platform": { "type": "string", "description": "Platform criteria for filtering the data.", "title": "Platform", "x-displayname": "Platform", "x-ves-example": "Linux", "x-f5xc-example": "linux", "x-f5xc-description-short": "Platform criteria for filtering the data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timeRange": { "type": "string", "description": "Time range (\"1h\", \"7d\", etc.)", "title": "TimeRange", "x-displayname": "Time Range.", "x-ves-example": "1h", "x-f5xc-example": "1h", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "string", "description": "Unix timestamp (seconds since epoch)", "title": "Timestamp", "format": "int64", "x-displayname": "Timestamp", "x-f5xc-example": "2025-01-15T10:30:00Z", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "int64", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request object to GET executive summary of DI premium customer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryLoadExecutiveSummaryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryLoadExecutiveSummaryResponse": { "type": "object", "description": "Response object to GET executive summary of DI premium customer.", "title": "LoadExecutiveSummaryResponse", "x-displayname": "Load Executive Summary Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.LoadExecutiveSummaryResponse", "properties": { "eventsReasons": { "type": "array", "description": "Message representing the transaction data.", "title": "EventsReason", "items": { "$ref": "#/components/schemas/data_deliveryEventsReason" }, "x-displayname": "Events Reason.", "x-ves-example": "High attempt value , high success volume.", "x-f5xc-example": "high attempt value , high success volume", "x-f5xc-description-short": "Message representing the transaction data.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lineChartData": { "allOf": [ { "$ref": "#/components/schemas/data_deliveryLineChartData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "allOf": [ { "$ref": "#/components/schemas/data_deliverySummaryPanel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response object to GET executive summary of DI premium customer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryLoadExecutiveSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliverySeries": { "type": "object", "description": "Message object representing series.", "title": "Series", "x-displayname": "Series", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.Series", "properties": { "data": { "type": "array", "description": "Array of data points.", "title": "DataPoint", "items": { "$ref": "#/components/schemas/data_deliveryDataPoint" }, "x-displayname": "Data Point.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the series (\"typical\", \"bot\", \"anomalous\")", "title": "Name", "x-displayname": "Name", "x-ves-example": "Bot", "x-f5xc-example": "bot", "x-f5xc-description-short": "Name of the series (\"typical\", \"bot\", \"anomalous\").", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliverySeries", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliverySummaryPanel": { "type": "object", "description": "Message object representing summary panel.", "title": "SummaryPanel", "x-displayname": "Summary Panel.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.SummaryPanel", "properties": { "anomalousDevices": { "type": "integer", "description": "Number of devices identified as anomalous.", "title": "AnomalousDevices", "format": "int64", "x-displayname": "Anomalous Devices.", "x-f5xc-description-short": "Number of devices identified as anomalous.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomalousDevicesPercentage": { "type": "number", "description": "Percentage of anomalous devices over total evaluated devices.", "title": "AnomalousDevicesPercentage", "format": "double", "x-displayname": "Anomalous Devices Percentage.", "x-f5xc-description-short": "Percentage of anomalous devices over total evaluated devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomalousMaxScore": { "type": "number", "description": "Max anomalous score.", "title": "AnomalousMaxScore", "format": "double", "x-displayname": "Anomalous Max Score.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomalousMinScore": { "type": "number", "description": "Min anomalous score.", "title": "AnomalousMinScore", "format": "double", "x-displayname": "Anomalous Min Score.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomalousPercentage": { "type": "number", "description": "Percentage of anomalous transactions over total evaluated transactions.", "title": "AnomalousPercentage", "format": "double", "x-displayname": "Anomalous Percentage.", "x-f5xc-description-short": "Percentage of anomalous transactions over total evaluated transactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomalousTransactions": { "type": "integer", "description": "Number of transactions identified as anomalous.", "title": "anomalousTransactions", "format": "int64", "x-displayname": "Anomalous Transactions.", "x-f5xc-description-short": "Number of transactions identified as anomalous.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "botPercentage": { "type": "number", "description": "Percentage of bot transactions over total evaluated transactions.", "title": "BotPercentage", "format": "double", "x-displayname": "Bot Percentage.", "x-f5xc-description-short": "Percentage of bot transactions over total evaluated transactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "botTransactions": { "type": "integer", "description": "Number of transactions identified as bots.", "title": "BotTransactions", "format": "int64", "x-displayname": "Bot Transactions.", "x-f5xc-description-short": "Number of transactions identified as bots.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalEvaluatedDevices": { "type": "integer", "description": "Total number of evaluated devices.", "title": "TotalEvaluatedDevices", "format": "int64", "x-displayname": "Total Evaluated Devices.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalEvaluatedTransactions": { "type": "integer", "description": "Total number of evaluated transactions.", "title": "TotalEvaluatedTransactions", "format": "int64", "x-displayname": "Total Evaluated Transactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Message object representing summary panel.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliverySummaryPanel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryTestReceiverRequest": { "type": "object", "description": "Request to test receiver & destination sink.", "title": "Test Receiver Request", "x-displayname": "Test Receiver Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.TestReceiverRequest", "properties": { "id": { "type": "string", "description": "Receiver Name.", "title": "id", "x-displayname": "Receiver ID.", "x-ves-example": "Splunk-cloud-receiver.", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "splunk-cloud-receiver", "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the receiver is configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "system", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace in which the receiver is configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request to test receiver & destination sink.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryTestReceiverRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"system\"\n}", "example_yaml": "namespace: system" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryTestReceiverResponse": { "type": "object", "description": "Response for the Receiver test request; empty because the only returned\ninformation is error message.", "title": "Test Receiver Response", "x-displayname": "Test Receiver Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.TestReceiverResponse", "properties": { "message": { "type": "string", "description": "The error string if the status is failed.", "title": "message", "x-displayname": "Message", "x-ves-example": "Credentials invalid.", "x-f5xc-example": "Credentials invalid", "x-f5xc-description-short": "The error string if the status is failed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/data_deliveryTestReceiverStatusType" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Response for the Receiver test request; empty because the only returned information is error message.", "x-f5xc-description-medium": "Response for the Receiver test request; empty because the only returned information is error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryTestReceiverResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryTestReceiverStatusType": { "type": "string", "description": "Test Receiver connection status\n\nThe receiver credentials & settings has been tested and the connection has been validated\nThere is error when trying to test the connection for destination sink with given credentials.", "title": "TestReceiverStatusType", "enum": [ "SUCCESS", "FAILED" ], "default": "SUCCESS", "x-displayname": "Test Receiver Status Type.", "x-ves-proto-enum": "ves.io.schema.shape.data_delivery.TestReceiverStatusType", "x-f5xc-description-short": "Test Receiver connection status The receiver credentials & settings has been tested and the connection has been validated There is error when...", "x-f5xc-description-medium": "Test Receiver connection status The receiver credentials & settings has been tested and the connection has been validated There is error when trying to test the connection for destination sink with given credentials.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryTestReceiverStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SUCCESS\"", "example_yaml": "SUCCESS\n..." }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryUpdateReceiverStatusRequest": { "type": "object", "description": "Request to update.", "title": "UpdateReceiverStatusRequest", "x-displayname": "Update Receiver status request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.UpdateReceiverStatusRequest", "properties": { "id": { "type": "string", "description": "Receiver Name.", "title": "id", "x-displayname": "Receiver ID.", "x-ves-example": "Splunk-cloud-receiver.", "x-ves-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "splunk-cloud-receiver", "x-validation-rules": { "ves.io.schema.rules.string.not_empty": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the suggestions are scoped.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Foobar", "x-f5xc-example": "foobar", "x-f5xc-description-short": "Namespace in which the suggestions are scoped.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "type": { "allOf": [ { "$ref": "#/components/schemas/shapedata_deliveryStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryUpdateReceiverStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "data_deliveryUpdateReceiverStatusResponse": { "type": "object", "description": "Payload about status of receiver status result.", "title": "UpdateReceiverStatusResponse", "x-displayname": "Update Receiver status response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.UpdateReceiverStatusResponse", "properties": { "id": { "type": "string", "description": "ID of the receiver.", "title": "id", "x-displayname": "Receiver ID.", "x-ves-example": "Splunk-cloud-receiver.", "x-f5xc-example": "splunk-cloud-receiver", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receiver_name": { "type": "string", "description": "Name of the receiver configured by the customer.", "title": "receiver_name", "x-displayname": "Receiver Name.", "x-ves-example": "Splunk-cloud-receiver.", "x-f5xc-example": "splunk-cloud-receiver", "x-f5xc-description-short": "Name of the receiver configured by the customer.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Values: not_modified , success\nStatus about receiver status modification.", "title": "status", "x-displayname": "Status", "x-ves-example": "Not_modified.", "x-f5xc-example": "not_modified", "x-f5xc-description-short": "Values: not_modified , success Status about receiver status modification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Payload about status of receiver status result.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for data_deliveryUpdateReceiverStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "namespaceSuggestValuesReq": { "type": "object", "description": "Request body of SuggestValues request.", "title": "SuggestValuesReq", "x-displayname": "Request for SuggestValues.", "x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesReq", "properties": { "field_path": { "type": "string", "description": "JSON path of the field for which the suggested values are being requested.", "title": "field_path", "maxLength": 1024, "x-displayname": "Field Path.", "x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "match_value": { "type": "string", "description": "A substring that must be present in either the value or description of each SuggestedItem in the response.", "title": "match_value", "maxLength": 256, "x-displayname": "Match Value.", "x-ves-example": "Some-substring.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "some-substring", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the suggestions are scoped.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Foobar", "x-f5xc-example": "foobar", "x-f5xc-description-short": "Namespace in which the suggestions are scoped.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSuggestValuesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSuggestValuesResp": { "type": "object", "description": "Response body of SuggestValues request.", "title": "SuggestValuesResp", "x-displayname": "Response for SuggestValues.", "x-ves-proto-message": "ves.io.schema.namespace.SuggestValuesResp", "properties": { "items": { "type": "array", "description": "List of suggested items.", "title": "item_lists", "items": { "$ref": "#/components/schemas/namespaceSuggestedItem" }, "x-displayname": "Suggested Items.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSuggestValuesResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "namespaceSuggestedItem": { "type": "object", "description": "A tuple with a suggested value and it's description.", "title": "SuggestedItem", "x-displayname": "Suggested Item.", "x-ves-oneof-field-value_choice": "[\"ref_value\",\"str_value\"]", "x-ves-proto-message": "ves.io.schema.namespace.SuggestedItem", "properties": { "description": { "type": "string", "description": "Optional description for the suggested value.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "Optional description for the suggested value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref_value": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "str_value" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "ref_value", "gated_by": { "choice": "value_choice" }, "required": false, "cardinality": "single" } ] }, "str_value": { "type": "string", "description": "Exclusive with [ref_value]", "title": "str_value", "x-displayname": "String", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ref_value" ] }, "title": { "type": "string", "description": "Optional title to be displayed instead of the actual value.\nUsed when pure value doesn't contain all the needed information to be displayed,\nor when display titles should be customized.", "title": "title", "x-displayname": "Title", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Optional title to be displayed instead of the actual value.", "x-f5xc-description-medium": "Optional title to be displayed instead of the actual value. Used when pure value doesn't contain all the needed information to be displayed, or when display titles should be customized.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "value": { "type": "string", "description": "Suggested value for the field.\nShould use value_choice.str_value instead.", "title": "value", "x-displayname": "Value", "x-f5xc-description-short": "Suggested value for the field. Should use value_choice.str_value instead.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Tuple with a suggested value and it's description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for namespaceSuggestedItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "tenant_and_identity", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Namespace management is platform-level administration" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "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", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "shapedata_deliveryStatusType": { "type": "string", "description": "Type of Status\n\n- DISABLE: DISABLE\n\nDisable Receiver\n- ENABLE: ENABLE\n\nEnable Receiver.", "title": "StatusType", "enum": [ "DISABLE", "ENABLE" ], "default": "DISABLE", "x-displayname": "Status type.", "x-ves-proto-enum": "ves.io.schema.shape.data_delivery.StatusType", "x-f5xc-description-short": "Type of Status - DISABLE: DISABLE Disable Receiver - ENABLE: ENABLE Enable Receiver.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for shapedata_deliveryStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DISABLE\"", "example_yaml": "DISABLE\n..." }, "x-f5xc-cli-domain": "cdn", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "subscriptionSubscribeRequest__ves_io_schema_shape_data_delivery_subscription": { "type": "object", "description": "Request of subscribe to Data-Intelligence.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeRequest", "x-f5xc-description-short": "Request of subscribe to Data-Intelligence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_shape_data_delivery_subscription": { "type": "object", "description": "Response of subscribe to Data-Intelligence.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Data-Intelligence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_shape_data_delivery_subscription": { "type": "object", "description": "Request of unsubscribe to Data-Intelligence.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeRequest", "x-f5xc-description-short": "Request of unsubscribe to Data-Intelligence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_shape_data_delivery_subscription": { "type": "object", "description": "Response of unsubscribe to Data-Intelligence.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.data_delivery.subscription.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Data-Intelligence.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeRequest__ves_io_schema_shape_mobile_app_shield_subscription": { "type": "object", "description": "Request to subscribe to Mobile App Shield.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.SubscribeRequest", "x-f5xc-description-short": "Request to subscribe to Mobile App Shield.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_shape_mobile_app_shield_subscription": { "type": "object", "description": "Response of subscribe to Mobile App Shield.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Mobile App Shield.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_shape_mobile_app_shield_subscription": { "type": "object", "description": "Request to unsubscribe to Mobile App Shield.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.UnsubscribeRequest", "x-f5xc-description-short": "Request to unsubscribe to Mobile App Shield.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_shape_mobile_app_shield_subscription": { "type": "object", "description": "Response of unsubscribe to Mobile App Shield.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.mobile_app_shield.subscription.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Mobile App Shield.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeRequest__ves_io_schema_shape_mobile_integrator_subscription": { "type": "object", "description": "Request to subscribe to Mobile Integrator.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.SubscribeRequest", "x-f5xc-description-short": "Request to subscribe to Mobile Integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_shape_mobile_integrator_subscription": { "type": "object", "description": "Response of subscribe to Mobile Integrator.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Mobile Integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_shape_mobile_integrator_subscription": { "type": "object", "description": "Request to unsubscribe to Mobile Integrator.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.UnsubscribeRequest", "x-f5xc-description-short": "Request to unsubscribe to Mobile Integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_shape_mobile_integrator_subscription": { "type": "object", "description": "Response of unsubscribe to Mobile Integrator.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.mobile_integrator.subscription.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Mobile Integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "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", "x-f5xc-description-short": "Specifies the HTTP method used to access a resource. Any HTTP Method.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaHttpMethod", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ANY\"", "example_yaml": "ANY\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectGetObjectResponse": { "type": "object", "description": "Response message for GetObject API.", "title": "GetObjectResponse", "x-displayname": "GET Object Response.", "x-ves-oneof-field-contents": "[\"bytes_value\",\"presigned_url\",\"string_value\"]", "x-ves-proto-message": "ves.io.schema.stored_object.GetObjectResponse", "properties": { "bytes_value": { "type": "string", "description": "Exclusive with [presigned_url string_value]\nBinary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object.", "title": "bytes_value", "format": "byte", "maximum": 5242880, "x-displayname": "Byte Value.", "x-ves-validation-rules": { "ves.io.schema.rules.bytes.max_len": "5242880" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.bytes.max_len": "5242880" }, "x-f5xc-description-short": "Exclusive with [presigned_url string_value] Binary object contents. This will be a base64 encoded string.", "x-f5xc-description-medium": "Exclusive with [presigned_url string_value] Binary object contents. This will be a base64 encoded string. The client should decode it to see the actual contents of the object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "presigned_url", "string_value" ] }, "content_format": { "type": "string", "description": "The optional content format associated with object.", "title": "content_format", "x-displayname": "Content Format.", "x-ves-example": "JSON, YAML.", "x-f5xc-example": "json, yaml", "x-f5xc-description-short": "The optional content format associated with object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/stored_objectStoredObjectDescriptor" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "presigned_url": { "allOf": [ { "$ref": "#/components/schemas/stored_objectPreSignedUrl" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bytes_value", "string_value" ] }, "string_value": { "type": "string", "description": "Exclusive with [bytes_value presigned_url]\nString formatted contents.", "title": "contents", "maxLength": 5242880, "x-displayname": "Contents", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "5242880" }, "x-f5xc-description-short": "Exclusive with [bytes_value presigned_url] String formatted contents.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 5242880, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bytes_value", "presigned_url" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectGetObjectResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectListItemDescriptor": { "type": "object", "description": "A descriptor for list response item.", "title": "ListItemDescriptor", "x-displayname": "List Item Descriptor.", "x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]", "x-ves-proto-message": "ves.io.schema.stored_object.ListItemDescriptor", "properties": { "mobile_app_shield": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_integrator": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk_self_serve": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "no_attributes" ] }, "name": { "type": "string", "description": "Name of the stored object.", "title": "name", "x-displayname": "Object Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_attributes": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no attributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve" ] }, "tenant": { "type": "string", "description": "Tenant to which this object belongs.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "versions": { "type": "array", "description": "Available versions for the stored object.", "title": "versions", "items": { "$ref": "#/components/schemas/stored_objectVersionDescriptor" }, "x-displayname": "Versions", "x-f5xc-description-short": "Available versions for the stored object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectListItemDescriptor", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectListObjectsResponse": { "type": "object", "description": "Response for GetListOfObjects API.", "title": "ListObjectsResponse", "x-displayname": "List Objects Response.", "x-ves-proto-message": "ves.io.schema.stored_object.ListObjectsResponse", "properties": { "items": { "type": "array", "description": "Stored object names and available versions for each object.", "title": "list of store object descriptors", "items": { "$ref": "#/components/schemas/stored_objectListItemDescriptor" }, "x-displayname": "Stored Object Descriptors.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Stored object names and available versions for each object.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectListObjectsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileAppShieldAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-app-shield.", "title": "MobileAppShieldAttributes", "x-displayname": "Mobile-app-shield attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileAppShieldAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile app shield release.", "title": "release_version", "maxLength": 32, "x-displayname": "Mobile app shield release version.", "x-ves-example": "V.4.2.1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v.4.2.1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Describes attributes specific to object type - mobile-app-shield.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectMobileAppShieldAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileIntegratorAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-integrator.", "title": "MobileIntegratorAttributes", "x-displayname": "Mobile-integrator attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileIntegratorAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile integrator release.", "title": "release_version", "maxLength": 32, "x-displayname": "Mobile integrator release version.", "x-ves-example": "V.4.2.1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "v.4.2.1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "32", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 32, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Describes attributes specific to object type - mobile-integrator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectMobileIntegratorAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectMobileSDKAttributes": { "type": "object", "description": "Describes attributes specific to object type - mobile-SDK.", "title": "MobileSDKAttributes", "x-displayname": "Mobile-SDK attributes.", "x-ves-proto-message": "ves.io.schema.stored_object.MobileSDKAttributes", "properties": { "os_type": { "allOf": [ { "$ref": "#/components/schemas/stored_objectOSType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "release_version": { "type": "string", "description": "Version of mobile SDK release.", "title": "release_version", "x-displayname": "Mobile SDK release version.", "x-ves-example": "V.4.2.1", "x-f5xc-example": "v.4.2.1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Describes attributes specific to object type - mobile-SDK.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectMobileSDKAttributes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectOSType": { "type": "string", "description": "Defines a selection for operating system type. Its either ANDROID or IOS\n\n- ANDROID: ANDROID\n\n- IOS: IOS.", "title": "OSType", "enum": [ "ANDROID", "IOS" ], "default": "ANDROID", "x-displayname": "Operating System type.", "x-ves-proto-enum": "ves.io.schema.stored_object.OSType", "x-f5xc-description-short": "Defines a selection for operating system type. Its either ANDROID or IOS - ANDROID: ANDROID - IOS: IOS.", "x-f5xc-description-medium": "Defines a selection for operating system type. Its either ANDROID or IOS - ANDROID: ANDROID - IOS: IOS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectOSType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ANDROID\"", "example_yaml": "ANDROID\n..." }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectPreSignedUrl": { "type": "object", "description": "Pre signed URL.", "title": "PreSignedUrl", "x-displayname": "Pre Signed URL.", "x-ves-oneof-field-storage_provider_choice": "[\"aws\"]", "x-ves-proto-message": "ves.io.schema.stored_object.PreSignedUrl", "properties": { "aws": { "allOf": [ { "$ref": "#/components/schemas/stored_objectPresignedUrlData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectPreSignedUrl", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectPresignedUrlData": { "type": "object", "description": "Pre signed URL data.", "title": "PresignedUrlData", "x-displayname": "Pre Signed URL Data.", "x-ves-proto-message": "ves.io.schema.stored_object.PresignedUrlData", "properties": { "method": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpMethod" } ], "x-f5xc-example": "GET", "x-f5xc-description-short": "HTTP method (GET, POST, PUT, DELETE, etc.).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "The URL to upload or download the resource.", "title": "url", "x-displayname": "URL", "x-f5xc-description-short": "The URL to upload or download the resource.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectPresignedUrlData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectStoredObjectDescriptor": { "type": "object", "description": "Response for GET, Create APIs.", "title": "StoredObjectDescriptor", "x-displayname": "Object Metadata Response.", "x-ves-oneof-field-object_attributes": "[\"mobile_app_shield\",\"mobile_integrator\",\"mobile_sdk\",\"mobile_sdk_self_serve\",\"no_attributes\"]", "x-ves-proto-message": "ves.io.schema.stored_object.StoredObjectDescriptor", "properties": { "creation_timestamp": { "type": "string", "description": "Creation date & time for the object.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Optional field, the Description for the object.", "title": "description", "maxLength": 512, "x-displayname": "Description.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Optional field, the Description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "mobile_app_shield": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileAppShieldAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_integrator": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileIntegratorAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_sdk", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk_self_serve", "no_attributes" ] }, "mobile_sdk_self_serve": { "allOf": [ { "$ref": "#/components/schemas/stored_objectMobileSDKAttributes" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "no_attributes" ] }, "name": { "type": "string", "description": "Name of the stored object.", "title": "name", "x-displayname": "Name", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the stored object.", "title": "namespace", "x-displayname": "Namespace", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_attributes": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no attributes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_app_shield", "mobile_integrator", "mobile_sdk", "mobile_sdk_self_serve" ] }, "url": { "type": "string", "description": "URL of the stored object.", "title": "url", "x-displayname": "URL", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of the stored object.", "title": "version", "x-displayname": "Version", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectStoredObjectDescriptor", "required_fields": [ "creation_timestamp", "name", "namespace", "url", "version" ], "mutually_exclusive_groups": [], "example_json": "{\n \"creation_timestamp\": \"value\",\n \"name\": \"example-resource\",\n \"namespace\": \"example-resource\",\n \"url\": \"value\",\n \"version\": \"v1.2.3\"\n}", "example_yaml": "creation_timestamp: value\nname: example-resource\nnamespace: example-resource\nurl: value\nversion: v1.2.3" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "stored_objectVersionDescriptor": { "type": "object", "description": "Descriptor for store object version.", "title": "VersionDescriptor", "x-displayname": "Version Descriptor.", "x-ves-proto-message": "ves.io.schema.stored_object.VersionDescriptor", "properties": { "creation_timestamp": { "type": "string", "description": "Creation date & time for the object.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "description": { "type": "string", "description": "Optional field, the Description for the object.", "title": "description", "maxLength": 512, "x-displayname": "Description.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Optional field, the Description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "latest_version": { "type": "boolean", "description": "A tag representing if this is the latest version for the object.", "title": "latest_version", "format": "boolean", "x-displayname": "Latest Version.", "x-f5xc-description-short": "Tag representing if this is the latest version for the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "URL of the stored object.", "title": "url", "x-displayname": "URL", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "version": { "type": "string", "description": "Version of the stored object.", "title": "version", "x-displayname": "Version", "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for stored_objectVersionDescriptor", "required_fields": [ "creation_timestamp", "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"creation_timestamp\": \"value\",\n \"url\": \"value\"\n}", "example_yaml": "creation_timestamp: value\nurl: value" }, "x-f5xc-cli-domain": "object_storage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "mobile_base_configCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of mobile_base_config", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configCreateSpecType": { "type": "object", "description": "Create Mobile SDK Base Configuration.", "title": "Create Mobile SDK Base Configuration", "x-displayname": "Create Mobile SDK Base Configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.CreateSpecType", "properties": { "fqdn": { "type": "string", "description": "Fully qualified domain name (FQDN)", "x-displayname": "Fully Qualified Domain Name of Mobile Application.", "x-ves-example": "mobile.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "mobile.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "hostname", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "os": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configMobileOS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configCreateSpecType", "required_fields": [ "fqdn" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fqdn\": \"mobile.example.com\"\n}", "example_yaml": "fqdn: mobile.example.com" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a mobile_base_config", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read mobile_base_config", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configGetSpecType": { "type": "object", "description": "GET Mobile SDK Base Configuration.", "title": "Get Mobile SDK Base Configuration", "x-displayname": "GET Mobile SDK Base Configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.GetSpecType", "properties": { "fqdn": { "type": "string", "description": "Fully qualified domain name (FQDN)", "x-displayname": "Fully Qualified Domain Name of Mobile Application.", "x-ves-example": "mobile.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "mobile.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "hostname", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "os": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configMobileOS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reload_header_name": { "type": "string", "description": "Header that is used for SDK configuration sync.", "x-displayname": "Reload Header Name.", "x-ves-example": "A9ea7eedfb8.", "x-f5xc-example": "a9ea7eedfb8", "x-f5xc-description-short": "Header that is used for SDK configuration sync.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configGetSpecType", "required_fields": [ "fqdn" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fqdn\": \"mobile.example.com\"\n}", "example_yaml": "fqdn: mobile.example.com" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of mobile_base_config", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/mobile_base_configListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configListResponseItem": { "type": "object", "description": "By default a summary of mobile_base_config is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of mobile_base_config", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this mobile_base_config.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this mobile_base_config.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this mobile_base_config.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this mobile_base_config.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates mobile_base_config is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates mobile_base_config is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this mobile_base_config.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this mobile_base_config.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this mobile_base_config.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this mobile_base_config.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this mobile_base_config.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of mobile_base_config is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of mobile_base_config is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configMobileBaseConfigurationFileResponse": { "type": "object", "description": "Mobile base configuration file response.", "title": "MobileBaseConfigurationFileResponse", "x-displayname": "Mobile base configuration file response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.MobileBaseConfigurationFileResponse", "properties": { "content": { "type": "string", "description": "Mobile SDK Base Configuration content.", "title": "Mobile SDK Base Configuration content", "x-displayname": "Mobile SDK Base Configuration.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Mobile SDK Base Configuration file name.", "title": "Mobile SDK Base Configuration file name", "x-displayname": "Mobile SDK Base Configuration file name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Mobile SDK Base Configuration file name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Mobile base configuration file response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configMobileBaseConfigurationFileResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configMobileOS": { "type": "string", "description": "Defines an operation system for Mobile SDK\n\n- MOBILE_OS_UNDEFINED: MOBILE_OS_UNDEFINED\n\nUndefined Operating System\n- ANDROID: ANDROID\n\nAndroid\n- IOS: IOS\n\niOS.", "title": "MobileOS", "enum": [ "MOBILE_OS_UNDEFINED", "ANDROID", "IOS" ], "default": "MOBILE_OS_UNDEFINED", "x-displayname": "Mobile SDK Operating System.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.mobile_base_config.MobileOS", "x-f5xc-description-short": "Defines an operation system for Mobile SDK - MOBILE_OS_UNDEFINED: MOBILE_OS_UNDEFINED Undefined Operating System - ANDROID: ANDROID Android - IOS...", "x-f5xc-description-medium": "Defines an operation system for Mobile SDK - MOBILE_OS_UNDEFINED: MOBILE_OS_UNDEFINED Undefined Operating System - ANDROID: ANDROID Android - IOS: IOS iOS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configMobileOS", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"MOBILE_OS_UNDEFINED\"", "example_yaml": "MOBILE_OS_UNDEFINED\n..." }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a mobile_base_config", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "mobile_base_configReplaceSpecType": { "type": "object", "description": "Replace Mobile SDK Base Configuration.", "title": "Replace Mobile SDK Base Configuration", "x-displayname": "Replace Mobile SDK Base Configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.mobile_base_config.ReplaceSpecType", "properties": { "fqdn": { "type": "string", "description": "Fully qualified domain name (FQDN)", "x-displayname": "Fully Qualified Domain Name of Mobile Application.", "x-ves-example": "mobile.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "mobile.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "hostname", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "os": { "allOf": [ { "$ref": "#/components/schemas/mobile_base_configMobileOS" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for mobile_base_configReplaceSpecType", "required_fields": [ "fqdn" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fqdn\": \"mobile.example.com\"\n}", "example_yaml": "fqdn: mobile.example.com" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Canonical create identity pending namespace CRUD verification" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "bot_defenseprotected_applicationCreateSpecType": { "type": "object", "description": "Create applications protected by Bot Defense.", "title": "Create protected application", "x-displayname": "Create Protected Application.", "x-ves-oneof-field-connector_type_choice": "[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"salesforce_commerce_connector\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.CreateSpecType", "properties": { "adobe_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for adobe commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "salesforce_commerce_connector" ] }, "big_ip_iapp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "salesforce_commerce_connector" ] }, "cloudflare": { "allOf": [ { "$ref": "#/components/schemas/cloudflareCloudflareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudfront", "custom_connector", "f5_big_ip", "salesforce_commerce_connector" ] }, "cloudfront": { "allOf": [ { "$ref": "#/components/schemas/cloudfrontCloudfrontType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "custom_connector", "f5_big_ip", "salesforce_commerce_connector" ] }, "custom_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for custom connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "f5_big_ip", "salesforce_commerce_connector" ] }, "f5_big_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "salesforce_commerce_connector" ] }, "region": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationBotDefenseRegion" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "salesforce_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for salesforce commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip" ] } }, "x-f5xc-description-short": "Create applications protected by Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseprotected_applicationCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseprotected_applicationGetSpecType": { "type": "object", "description": "GET applications protected by Bot Defense.", "title": "Get Protected Application", "x-displayname": "GET Protected Application.", "x-ves-oneof-field-connector_type_choice": "[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"not_applicable_connector\",\"salesforce_commerce_connector\",\"xc_mesh\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.GetSpecType", "properties": { "adobe_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for adobe commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "app_id": { "type": "string", "description": "Protected application ID.", "x-displayname": "Application ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "big_ip_iapp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "cloudflare": { "allOf": [ { "$ref": "#/components/schemas/cloudflareCloudflareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "cloudfront": { "allOf": [ { "$ref": "#/components/schemas/cloudfrontCloudfrontType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "custom_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for custom connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "f5_big_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "not_applicable_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for not applicable connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "salesforce_commerce_connector", "xc_mesh" ] }, "region": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationBotDefenseRegion" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reload_header_name": { "type": "string", "description": "Protected application Reload Header Name\nHeader that is used for SDK configuration sync.", "x-displayname": "Reload Header Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Protected application Reload Header Name Header that is used for SDK configuration sync.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "salesforce_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for salesforce commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "xc_mesh" ] }, "status": { "type": "string", "description": "Protected application status.", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "xc_mesh": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationXCMeshConnector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector" ] } }, "x-f5xc-description-short": "GET applications protected by Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseprotected_applicationGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bot_defenseprotected_applicationReplaceSpecType": { "type": "object", "description": "Replace applications protected by Bot Defense.", "title": "Replace protected application", "x-displayname": "Replace Protected Application.", "x-ves-oneof-field-connector_type_choice": "[\"adobe_commerce_connector\",\"big_ip_iapp\",\"cloudflare\",\"cloudfront\",\"custom_connector\",\"f5_big_ip\",\"not_applicable_connector\",\"salesforce_commerce_connector\",\"xc_mesh\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ReplaceSpecType", "properties": { "adobe_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for adobe commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "big_ip_iapp": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "cloudflare": { "allOf": [ { "$ref": "#/components/schemas/cloudflareCloudflareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "cloudfront": { "allOf": [ { "$ref": "#/components/schemas/cloudfrontCloudfrontType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "custom_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for custom connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "f5_big_ip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "not_applicable_connector", "salesforce_commerce_connector", "xc_mesh" ] }, "not_applicable_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for not applicable connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "salesforce_commerce_connector", "xc_mesh" ] }, "salesforce_commerce_connector": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for salesforce commerce connector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "xc_mesh" ] }, "xc_mesh": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationXCMeshConnector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "adobe_commerce_connector", "big_ip_iapp", "cloudflare", "cloudfront", "custom_connector", "f5_big_ip", "not_applicable_connector", "salesforce_commerce_connector" ] } }, "x-f5xc-description-short": "Replace applications protected by Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bot_defenseprotected_applicationReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "bot_and_threat_defense", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloudflareCloudflareType": { "type": "object", "description": "Bot Defense policy configuration for Cloudflare.", "title": "CloudflareType", "x-displayname": "Cloudflare.", "x-ves-displayorder": "20,1,2,3,24,35,103,102,100", "x-ves-oneof-field-java_script_choice": "[\"disable_js_insert\",\"js_insertion_rules\",\"manual_js_insert\"]", "x-ves-oneof-field-mobile_sdk_choice": "[\"disable_mobile_sdk\",\"mobile_sdk_config\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.CloudflareType", "properties": { "continue_mitigation_action_hdr": { "type": "string", "description": "A case-insensitive HTTP header name for Continue Mitigation Action when add header selected.", "title": "Continue Header name", "maxLength": 256, "x-displayname": "Header Name For Continue Mitigation Action.", "x-ves-example": "X-F5-bot-inference.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-example": "x-f5-bot-inference", "x-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-description-short": "Case-insensitive HTTP header name for Continue Mitigation Action when add header selected.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disable_js_insert": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable js insert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "js_insertion_rules", "manual_js_insert" ] }, "disable_mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_sdk_config" ] }, "js_insertion_rules": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareJavaScriptInsertType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_js_insert", "manual_js_insert" ] }, "loglevel": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareLogLevel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual_js_insert": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareJavaScriptInsertManualType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_js_insert", "js_insertion_rules" ] }, "mobile_sdk_config": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareMobileSDKConfigType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_mobile_sdk" ] }, "protected_endpoints": { "type": "array", "description": "List of protected endpoints (max 128 items)", "title": "protected_endpoints", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareProtectedEndpointType" }, "x-displayname": "Protected Endpoints.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of protected endpoints (max 128 items).", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "timeout": { "type": "integer", "description": "The timeout for the inference check, in milliseconds.", "title": "timeout", "format": "int64", "x-displayname": "Timeout", "x-ves-example": "300", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-example": "300", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-description-short": "The timeout for the inference check, in milliseconds.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 60000, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_clients": { "type": "array", "description": "Define your allowlists to skip Bot Defense inference processing.", "title": "Trusted Client Rules", "maxItems": 256, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareClientBypassRule" }, "x-displayname": "Trusted Client Rules.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Define your allowlists to skip Bot Defense inference processing.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot Defense policy configuration for Cloudflare.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloudflareCloudflareType", "required_fields": [ "protected_endpoints" ], "mutually_exclusive_groups": [], "example_json": "{\n \"protected_endpoints\": [\n {\n \"http_methods\": [\n \"METHOD_ANY\"\n ]\n }\n ]\n}", "example_yaml": "protected_endpoints:\n- http_methods:\n - METHOD_ANY" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloudflarePathType": { "type": "object", "description": "URI Path", "title": "Path case sensitive", "x-displayname": "Path", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.PathType", "properties": { "caseinsensitive": { "type": "boolean", "description": "Should path be searched case insensitive;", "title": "Case insensitive", "format": "boolean", "x-displayname": "Case insensitive.", "x-f5xc-description-short": "Should path be searched case insensitive;.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "type": "string", "description": "URI Path", "title": "Path", "minLength": 1, "maxLength": 256, "x-displayname": "Path", "x-ves-example": "/not-found.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$" }, "x-f5xc-example": "/not-found", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256, "min": 1 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloudflarePathType", "required_fields": [ "path" ], "mutually_exclusive_groups": [], "example_json": "{\n \"path\": \"/not-found\"\n}", "example_yaml": "path: /not-found" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloudfrontCloudfrontType": { "type": "object", "description": "Bot Defense policy configuration for AWS Cloudfront.", "title": "CloudfrontType", "x-displayname": "Cloudfront.", "x-ves-displayorder": "19,20,1,2,3,24,35,103,102,100,101", "x-ves-oneof-field-aws_configuration_type_choice": "[\"aws_configuration_id_selector\",\"aws_configuration_tag_selector\",\"disable_aws_configuration\"]", "x-ves-oneof-field-java_script_choice": "[\"disable_js_insert\",\"js_insertion_rules\",\"manual_js_insert\"]", "x-ves-oneof-field-mobile_sdk_choice": "[\"disable_mobile_sdk\",\"mobile_sdk_config\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.CloudfrontType", "properties": { "aws_configuration_id_selector": { "allOf": [ { "$ref": "#/components/schemas/cloudfrontDistributionIDList" } ], "x-f5xc-description-short": "Configuration parameter for aws configuration id selector.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "aws_configuration_tag_selector", "disable_aws_configuration" ] }, "aws_configuration_tag_selector": { "allOf": [ { "$ref": "#/components/schemas/cloudfrontDistributionTagList" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_configuration_id_selector", "disable_aws_configuration" ] }, "continue_mitigation_action_hdr": { "type": "string", "description": "A case-insensitive HTTP header name for Continue Mitigation Action when add header selected.", "title": "Continue Header name", "maxLength": 256, "x-displayname": "Header Name For Continue Mitigation Action.", "x-ves-example": "X-F5-bot-inference.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-example": "x-f5-bot-inference", "x-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-description-short": "Case-insensitive HTTP header name for Continue Mitigation Action when add header selected.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data_sample": { "type": "integer", "description": "Limit on amount of request-body data (other than F5 telemetry) to send\nfor analysis (limit 1,048,576 == 1 MiByte)", "title": "DataSample", "format": "int64", "x-displayname": "Body Sample Size Limit.", "x-ves-example": "1024", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "1048576" }, "x-f5xc-example": "1024", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "1048576" }, "x-f5xc-description-short": "Limit on amount of request-body data (other than F5 telemetry) to send for analysis (limit 1,048,576 == 1 MiByte).", "x-f5xc-description-medium": "Limit on amount of request-body data (other than F5 telemetry) to send for analysis (limit 1,048,576 == 1 MiByte).", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 1048576, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disable_aws_configuration": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable aws configuration.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_configuration_id_selector", "aws_configuration_tag_selector" ] }, "disable_js_insert": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable js insert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "js_insertion_rules", "manual_js_insert" ] }, "disable_mobile_sdk": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_sdk_config" ] }, "js_insertion_rules": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptInsertType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_js_insert", "manual_js_insert" ] }, "loglevel": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontLogLevel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual_js_insert": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptInsertManualType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_js_insert", "js_insertion_rules" ] }, "mobile_sdk_config": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontMobileSDKConfigType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_mobile_sdk" ] }, "protected_endpoints": { "type": "array", "description": "List of protected endpoints (max 128 items)", "title": "protected_endpoints", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontProtectedEndpointType" }, "x-displayname": "Protected Endpoints.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of protected endpoints (max 128 items).", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "timeout": { "type": "integer", "description": "The timeout for the inference check, in milliseconds.", "title": "timeout", "format": "int64", "x-displayname": "Timeout", "x-ves-example": "300", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-example": "300", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "60000" }, "x-f5xc-description-short": "The timeout for the inference check, in milliseconds.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 60000, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_clients": { "type": "array", "description": "Define your allowlists to skip Bot Defense inference processing.", "title": "Trusted Client Rules", "maxItems": 256, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontClientBypassRule" }, "x-displayname": "Trusted Client Rules.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "256", "ves.io.schema.rules.repeated.unique_metadata_name": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Define your allowlists to skip Bot Defense inference processing.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot Defense policy configuration for AWS Cloudfront.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloudfrontCloudfrontType", "required_fields": [ "protected_endpoints" ], "mutually_exclusive_groups": [], "example_json": "{\n \"protected_endpoints\": [\n {\n \"http_methods\": [\n \"METHOD_ANY\"\n ],\n \"path\": \"/id/1\"\n }\n ]\n}", "example_yaml": "protected_endpoints:\n- http_methods:\n - METHOD_ANY\n path: /id/1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloudfrontDistributionIDList": { "type": "object", "description": "List of CloudFront distributions.", "title": "DistributionIDList", "x-displayname": "ID List", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.DistributionIDList", "properties": { "ids": { "type": "array", "description": "Add AWS CloudFront distribution ID, e.g. ABCDEFGHI0JKLM.", "title": "ids", "minItems": 1, "maxItems": 16, "items": { "type": "string", "minLength": 1, "maxLength": 32 }, "x-displayname": "ID", "x-ves-example": "ABCDEFGHI0JKLM.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.items.string.pattern": "^[A-Z0-9]+$", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "ABCDEFGHI0JKLM", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "32", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.items.string.pattern": "^[A-Z0-9]+$", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Add AWS CloudFront distribution ID, e.g. ABCDEFGHI0JKLM.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-example": "ABCDEFGHI0JKLM", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloudfrontDistributionIDList", "required_fields": [ "ids" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ids\": [\n \"value\"\n ]\n}", "example_yaml": "ids:\n- value" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloudfrontDistributionTagList": { "type": "object", "description": "CloudFront distribution tag list.", "title": "DistributionTagList", "x-displayname": "Distribution Tag List.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.DistributionTagList", "properties": { "tags": { "type": "object", "description": "List contains the Cloudfront distribution selection by tags\nkey is a AWS tag name, and the value is regular expression to match.", "title": "tags", "x-displayname": "Tags", "x-ves-example": "{\"env\": \".*\"}", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.min_pairs": "1", "ves.io.schema.rules.map.values.string.max_len": "256", "ves.io.schema.rules.map.values.string.min_len": "1", "ves.io.schema.rules.map.values.string.regex": "true", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "\"{\"env\"\".*\"}\"", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.min_pairs": "1", "ves.io.schema.rules.map.values.string.max_len": "256", "ves.io.schema.rules.map.values.string.min_len": "1", "ves.io.schema.rules.map.values.string.regex": "true", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "List contains the Cloudfront distribution selection by tags key is a AWS tag name, and the value is regular expression to match.", "x-f5xc-description-medium": "List contains the Cloudfront distribution selection by tags key is a AWS tag name, and the value is regular expression to match.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloudfrontDistributionTagList", "required_fields": [ "tags" ], "mutually_exclusive_groups": [], "example_json": "{\n \"tags\": {}\n}", "example_yaml": "tags: {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ioschemaPathMatcherType": { "type": "object", "description": "Path match of the URI can be either be, Prefix match or exact match or regular expression match.", "title": "PathMatcherType", "x-displayname": "Path to Match.", "x-ves-displayorder": "4", "x-ves-oneof-field-path_match": "[\"path\",\"prefix\",\"regex\"]", "x-ves-proto-message": "ves.io.schema.PathMatcherType", "properties": { "path": { "type": "string", "description": "Exclusive with [prefix regex]\nExact path value to match.", "title": "exact", "maxLength": 256, "x-displayname": "Exact", "x-ves-example": "/logout", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/logout", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [prefix regex] Exact path value to match.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "prefix", "regex" ] }, "prefix": { "type": "string", "description": "Exclusive with [path regex]\nPath prefix to match (e.g. The value / will match on all paths)", "title": "prefix", "maxLength": 256, "x-displayname": "Prefix", "x-ves-example": "/register/.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/register/", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [path regex] Path prefix to match (e.g. The value / will match on all paths)", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "path", "regex" ] }, "regex": { "type": "string", "description": "Exclusive with [path prefix]\nRegular expression of path match (e.g. The value .* will match on all paths)", "title": "regex", "minLength": 1, "maxLength": 256, "x-displayname": "Regex", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.regex": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths)", "x-f5xc-description-medium": "Exclusive with [path prefix] Regular expression of path match (e.g. The value .* will match on all paths).", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256, "min": 1 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "path", "prefix" ] } }, "x-f5xc-description-short": "Path match of the URI can be either be, Prefix match or exact match or regular expression match.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaPathMatcherType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "protected_applicationApiEndpoint": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ApiEndpoint", "properties": { "telemetry_prefix": { "type": "string", "description": "Telemetry Prefix for a region.", "title": "Telemetry Prefix", "x-displayname": "Telemetry Prefix.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "API hostname for a region.", "title": "API Hostname", "x-displayname": "API Hostname.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationApiEndpoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationApiKeyResponse": { "type": "object", "description": "Response for getting API key.", "title": "ApiKeyResponse", "x-displayname": "ApiKey Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ApiKeyResponse", "properties": { "api_key": { "type": "string", "description": "API Key", "title": "api_key", "x-displayname": "API Key", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "characterSet": { "allowed": "[a-zA-Z0-9_-]", "description": "Alphanumeric with underscores and hyphens" }, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationApiKeyResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationBotDefenseRegion": { "type": "string", "description": "Defines a selection for Bot Defense region\n\n- US: US\n\nUnited States of America\n- EU: EU\n\nEuropean Union\n- ASIA: ASIA\n\nAsia\n- CA: CA\n\nCanada.", "title": "BotDefenseRegion", "enum": [ "US", "EU", "ASIA", "CA" ], "default": "US", "x-displayname": "Bot Defense Region.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.BotDefenseRegion", "x-f5xc-description-short": "Defines a selection for Bot Defense region - US: US United States of America - EU: EU European Union - ASIA: ASIA Asia - CA: CA Canada.", "x-f5xc-description-medium": "Defines a selection for Bot Defense region - US: US United States of America - EU: EU European Union - ASIA: ASIA Asia - CA: CA Canada.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationBotDefenseRegion", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"US\"", "example_yaml": "US\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationConnectorConfigResponse": { "type": "object", "description": "Connector configuration response.", "title": "ConnectorConfigResponse", "x-displayname": "Connector Configuration Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ConnectorConfigResponse", "properties": { "config": { "type": "string", "description": "Connector configuration.", "title": "Connector Config", "x-displayname": "Connector Config.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Connector config file name.", "title": "Connector name", "x-displayname": "Connector file name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationConnectorConfigResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of protected_application", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseprotected_applicationCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseprotected_applicationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a protected_application", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read protected_application", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseprotected_applicationGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/protected_applicationStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of protected_application", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/protected_applicationListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationListResponseItem": { "type": "object", "description": "By default a summary of protected_application is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of protected_application", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this protected_application.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this protected_application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this protected_application.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this protected_application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates protected_application is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates protected_application is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseprotected_applicationGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this protected_application.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this protected_application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this protected_application.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/protected_applicationStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this protected_application.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this protected_application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of protected_application is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of protected_application is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationRegion": { "type": "object", "description": "Region for protected application.", "title": "Region Details", "x-displayname": "Region Details.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.Region", "properties": { "mobile_endpoint": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationApiEndpoint" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationBotDefenseRegion" } ], "x-f5xc-example": "us-west-2", "x-f5xc-description-short": "Geographic region for resource placement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web_endpoint": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationApiEndpoint" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationRegion", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationRegionsListResponse": { "type": "object", "description": "Response for getting regions list.", "title": "RegionsListResponse", "x-displayname": "RegionsList Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.RegionsListResponse", "properties": { "regions": { "type": "array", "description": "List of regions for protected applications.", "title": "Regions", "items": { "$ref": "#/components/schemas/protected_applicationRegion" }, "x-displayname": "Regions List.", "x-f5xc-description-short": "List of regions for protected applications.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationRegionsListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a protected_application", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/bot_defenseprotected_applicationReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "StatusObject", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationTemplateConnectorResponse": { "type": "object", "description": "Response for iApp template connector.", "title": "TemplateConnectorResponse", "x-displayname": "Template Connector Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.TemplateConnectorResponse", "properties": { "name": { "type": "string", "description": "IApp template connector file name.", "title": "Template Connector name", "x-displayname": "Template connector file name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "template": { "type": "string", "description": "IApp template connector.", "title": "Template Connector", "x-displayname": "Template Connector.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationTemplateConnectorResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationXCMeshConnector": { "type": "object", "description": "Configures HTTP Load Balancer connector.", "title": "XCMeshConnector", "x-displayname": "HTTP Load Balancer.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.XCMeshConnector", "properties": { "http_load_balancer": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for http load balancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "http_load_balancer", "field_path": "http_load_balancer", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Configures HTTP Load Balancer connector.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationXCMeshConnector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareBlockMitigationChoiceType": { "type": "object", "description": "Block Response.", "title": "BlockMitigationChoiceType", "x-displayname": "Block Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.BlockMitigationChoiceType", "properties": { "body": { "type": "string", "description": "Custom body message.", "title": "body", "maxLength": 4096, "x-displayname": "Body", "x-ves-example": "

Your request was blocked

", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "

Your request was blocked

", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Content type to use in a block response.", "title": "content_type", "maxLength": 128, "x-displayname": "Content Type.", "x-ves-example": "Text/HTML", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "text/html", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Content type to use in a block response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareBlockMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareBlockMobileMitigationChoiceType": { "type": "object", "description": "Block Response.", "title": "BlockMobileMitigationChoiceType", "x-displayname": "Block Response for Mobile.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.BlockMobileMitigationChoiceType", "properties": { "body": { "type": "string", "description": "Custom body message.", "title": "body", "maxLength": 4096, "x-displayname": "Body", "x-ves-example": "

Your request was blocked

", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "

Your request was blocked

", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Content type to use in a block response.", "title": "content_type", "maxLength": 128, "x-displayname": "Content Type.", "x-ves-example": "Text/HTML", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "text/html", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Content type to use in a block response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareBlockMobileMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareClientBypassRule": { "type": "object", "description": "Client source rule specifies the sources to be trusted.", "title": "ClientBypassRule", "x-displayname": "Client Bypass Rule.", "x-ves-displayorder": "1,3", "x-ves-oneof-field-client_source_choice": "[\"http_header\",\"ip_prefix\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.ClientBypassRule", "properties": { "http_header": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareHttpHeaderMatcherList" } ], "x-f5xc-description-short": "Configuration parameter for http header.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_prefix" ] }, "ip_prefix": { "type": "string", "description": "Exclusive with [http_header]\nIP prefix string.", "title": "ip prefix", "x-displayname": "IP Prefix", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-description-short": "Exclusive with [http_header] IP prefix string.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "cidr", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_header" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Client source rule specifies the sources to be trusted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareClientBypassRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareContinueMitigationChoiceType": { "type": "object", "description": "Continue mitigation action.", "title": "ShapeBotFlagMitigationActionChoiceType", "x-displayname": "Select Continue Bot Mitigation Action.", "x-ves-oneof-field-add_header_choice": "[\"add_header\",\"no_header\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.ContinueMitigationChoiceType", "properties": { "add_header": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_header" ] }, "no_header": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "add_header" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareContinueMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareHeaderMatcherType": { "type": "object", "description": "Header match is done using the name of the header and its value.\nThe value match is done using one of the following\nregex match on value\nexact match of value\npresence of header.", "title": "HeaderMatcherType", "x-displayname": "Header To Match.", "x-ves-oneof-field-value_match": "[\"exact\",\"regex\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.HeaderMatcherType", "properties": { "exact": { "type": "string", "description": "Exclusive with [regex]\nHeader value to match exactly.", "title": "exact", "maxLength": 256, "x-displayname": "Exact", "x-ves-example": "Application/JSON.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "application/json", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Exclusive with [regex] Header value to match exactly.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regex" ] }, "name": { "type": "string", "description": "Name of the header.", "title": "name", "minLength": 1, "maxLength": 63, "x-displayname": "Name", "x-ves-example": "Content-Type.", "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", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "Content-Type", "x-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", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 256, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "regex": { "type": "string", "description": "Exclusive with [exact]\nRegex match of the header value in re2 format.", "title": "regex", "maxLength": 256, "x-displayname": "Regex", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true", "ves.io.schema.rules.string.regex": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Exclusive with [exact] Regex match of the header value in re2 format.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact" ] } }, "x-f5xc-description-short": "Header match is done using the name of the header and its value.", "x-f5xc-description-medium": "Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareHeaderMatcherType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"Content-Type\"\n}", "example_yaml": "name: Content-Type" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareHttpHeaderMatcherList": { "type": "object", "description": "Request header name and value pairs.", "title": "HTTP Header", "x-displayname": "HTTP Header.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.HttpHeaderMatcherList", "properties": { "headers": { "type": "array", "description": "List of HTTP header name and value pairs.", "title": "headers", "maxItems": 16, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareHeaderMatcherType" }, "x-displayname": "HTTP Headers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of HTTP header name and value pairs.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareHttpHeaderMatcherList", "required_fields": [ "headers" ], "mutually_exclusive_groups": [], "example_json": "{\n \"headers\": [\n {\n \"name\": \"Content-Type\"\n }\n ]\n}", "example_yaml": "headers:\n- name: Content-Type" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareJavaScriptExclusionRule": { "type": "object", "description": "Define JavaScript insertion exclusion rule.", "title": "JavaScriptExclusionRule", "x-displayname": "JavaScript Insertion Exclusion Rule.", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptExclusionRule", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "allOf": [ { "$ref": "#/components/schemas/ioschemaPathMatcherType" } ], "x-f5xc-example": "/api/v1/resources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Define JavaScript insertion exclusion rule.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareJavaScriptExclusionRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareJavaScriptInsertManualType": { "type": "object", "description": "Insert JavaScript manually.", "title": "manual_js_insert", "x-displayname": "Insert JavaScript Manually.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertManualType", "properties": { "js_download_path": { "type": "string", "description": "Web client will fetch F5 Client JavaScript from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.", "title": "js_download_path", "x-displayname": "Web Client JavaScript Path.", "x-ves-example": "/common.js.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-example": "/common.js", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-description-short": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "x-f5xc-description-medium": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths. If not specified, default to ‘/common.js’.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareJavaScriptInsertManualType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareJavaScriptInsertType": { "type": "object", "description": "This defines custom JavaScript insertion rules for Bot Defense Policy.", "title": "JavaScriptInsertType", "x-displayname": "JavaScript Custom Insertion Rules.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertType", "properties": { "exclude_list": { "type": "array", "description": "Optional JavaScript insertions exclude list of domain and path matchers.", "title": "exclude_list", "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareJavaScriptExclusionRule" }, "x-displayname": "JavaScript Exclude Paths.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Optional JavaScript insertions exclude list of domain and path matchers.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "javascript_location": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareJavaScriptLocation" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "js_download_path": { "type": "string", "description": "Web client will fetch F5 Client JavaScript from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.", "title": "js_download_path", "x-displayname": "Web Client JavaScript Path.", "x-ves-example": "/common.js.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-example": "/common.js", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-description-short": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "x-f5xc-description-medium": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths. If not specified, default to ‘/common.js’.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rules": { "type": "array", "description": "Required list of pages to insert Bot Defense client JavaScript.", "title": "rules", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareJavaScriptInsertionRule" }, "x-displayname": "JavaScript Insertion Paths.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Required list of pages to insert Bot Defense client JavaScript.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines custom JavaScript insertion rules for Bot Defense Policy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareJavaScriptInsertType", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {}\n ]\n}", "example_yaml": "rules:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareJavaScriptInsertionRule": { "type": "object", "description": "This defines a rule for Bot Defense JavaScript insertion.", "title": "JavaScriptInsertionRule", "x-displayname": "JavaScript Insertion Rule.", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-oneof-field-uri_path": "[\"exact_path\",\"glob\",\"prefix\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptInsertionRule", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "exact_path": { "type": "string", "description": "Exclusive with [glob prefix]\nExact path value to match.", "title": "path", "maxLength": 256, "x-displayname": "Path", "x-ves-example": "/logout", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/logout", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [glob prefix] Exact path value to match.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "glob", "prefix" ] }, "glob": { "type": "string", "description": "Exclusive with [exact_path prefix]\n\nAccepts wildcards * to match multiple characters or ? To match a single character.", "title": "glob", "minLength": 1, "maxLength": 256, "x-displayname": "Glob", "x-ves-example": "/ID/1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$" }, "x-f5xc-example": "/id/1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$" }, "x-f5xc-description-short": "Exclusive with [exact_path prefix] Accepts wildcards * to match multiple characters or ?", "x-f5xc-description-medium": "Exclusive with [exact_path prefix] Accepts wildcards * to match multiple characters or ? To match a single character.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_path", "prefix" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix": { "type": "string", "description": "Exclusive with [exact_path glob]\nPath prefix to match (e.g. The value / will match on all paths)", "title": "prefix", "maxLength": 256, "x-displayname": "Prefix", "x-ves-example": "/register/.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/register/", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [exact_path glob] Path prefix to match (e.g. The value / will match on all paths)", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_path", "glob" ] } }, "x-f5xc-description-short": "Defines a rule for Bot Defense JavaScript insertion.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareJavaScriptInsertionRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareJavaScriptLocation": { "type": "string", "description": "All inside networks.\n\n- JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED\n\nUndefined\nInsert JavaScript after tag\nInsert JavaScript after tag.\nInsert JavaScript before first tag.", "title": "JavaScriptLocation", "enum": [ "JAVA_SCRIPT_LOCATION_UNDEFINED", "AFTER_HEAD", "AFTER_TITLE_END", "BEFORE_SCRIPT" ], "default": "JAVA_SCRIPT_LOCATION_UNDEFINED", "x-displayname": "JavaScript Location.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.JavaScriptLocation", "x-f5xc-description-short": "All inside networks. - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED Undefined Insert JavaScript after tag Insert...", "x-f5xc-description-medium": "All inside networks. - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED Undefined Insert JavaScript after tag Insert JavaScript after tag. Insert JavaScript before first tag.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareJavaScriptLocation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"JAVA_SCRIPT_LOCATION_UNDEFINED\"", "example_yaml": "JAVA_SCRIPT_LOCATION_UNDEFINED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareLogLevel": { "type": "string", "description": "Select the level of logging desired. Levels are cumulative\n(e.g. Debug includes Error, Warning, and Informational)\n\n- LOG_UNDEFINED: Undefined\n\n- LOG_ERROR: Error\n\nLog only errors\n- LOG_WARNING: Warning\n\nLog malicious requests\n- LOG_INFO: Info\n\nLog all requests\n- LOG_DEBUG: Debug\n\nLog debugging data.", "title": "loglevel", "enum": [ "LOG_UNDEFINED", "LOG_ERROR", "LOG_WARNING", "LOG_INFO", "LOG_DEBUG" ], "default": "LOG_UNDEFINED", "x-displayname": "Log Level", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.LogLevel", "x-f5xc-description-short": "Select the level of logging desired. Levels are cumulative (e.g.", "x-f5xc-description-medium": "Select the level of logging desired. Levels are cumulative (e.g. Debug includes Error, Warning, and Informational) - LOG_UNDEFINED: Undefined - LOG_ERROR: Error Log only errors - LOG_WARNING: Warning Log malicious requests - LOG_INFO: Info Log all requests - LOG_DEBUG: Debug Log debugging data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareLogLevel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LOG_UNDEFINED\"", "example_yaml": "LOG_UNDEFINED\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareMobileClientType": { "type": "object", "description": "Mobile client configuration OPTIONS.", "title": "MobileClientType", "x-displayname": "Mobile Client.", "x-ves-oneof-field-mitigation": "[\"block\",\"continue\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileClientType", "properties": { "block": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareBlockMobileMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareMobileClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareMobileSDKConfigType": { "type": "object", "description": "Mobile SDK configuration.", "title": "MobileSDKConfigType", "x-displayname": "Mobile SDK Configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileSDKConfigType", "properties": { "mobile_identifier": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareMobileTrafficIdentifierType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareMobileSDKConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareMobileTrafficIdentifierType": { "type": "object", "description": "Mobile traffic identifier type.", "title": "MobileTrafficIdentifierType", "x-displayname": "Mobile Traffic Identifier.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.MobileTrafficIdentifierType", "properties": { "headers": { "type": "array", "description": "A list of headers that can be used to identify mobile traffic.", "title": "Mobile headers", "maxItems": 16, "items": { "$ref": "#/components/schemas/protected_applicationcloudflareHeaderMatcherType" }, "x-displayname": "Mobile Request Identifier Headers.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of headers that can be used to identify mobile traffic.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareMobileTrafficIdentifierType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareProtectedEndpointType": { "type": "object", "description": "Add the name and description for the protected endpoint.", "title": "ProtectedEndpointType", "x-displayname": "Protected Endpoint.", "x-ves-displayorder": "1,2,3,4,5,6,7,12,8", "x-ves-oneof-field-client_type_choice": "[\"mobile_client\",\"web_client\",\"web_mobile_client\"]", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.ProtectedEndpointType", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "http_methods": { "type": "array", "description": "List of HTTP methods.", "title": "HTTP Methods", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaBotHttpMethod" }, "x-displayname": "HTTP Methods.", "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": "[1,3,4]", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-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": "[1,3,4]", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mobile_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareMobileClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "web_client", "web_mobile_client" ] }, "path": { "allOf": [ { "$ref": "#/components/schemas/cloudflarePathType" } ], "x-f5xc-example": "/api/v1/resources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "query": { "type": "string", "description": "Enter a regular expression to match your query parameters of interest.", "title": "Query", "maxLength": 256, "x-displayname": "Query", "x-ves-example": "(^|[^\\\\w])action=login([^\\\\w]|$)", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "(^|[^\\\\w])action=login([^\\\\w]|$)", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Enter a regular expression to match your query parameters of interest.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareWebClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_client", "web_mobile_client" ] }, "web_mobile_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareWebMobileClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_client", "web_client" ] } }, "x-f5xc-description-short": "Add the name and description for the protected endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareProtectedEndpointType", "required_fields": [ "http_methods" ], "mutually_exclusive_groups": [], "example_json": "{\n \"http_methods\": [\n \"METHOD_ANY\"\n ]\n}", "example_yaml": "http_methods:\n- METHOD_ANY" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareRedirectMitigationChoiceType": { "type": "object", "description": "Redirect.", "title": "RedirectMitigationChoiceType", "x-displayname": "Redirect", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.RedirectMitigationChoiceType", "properties": { "location": { "type": "string", "description": "URI location for redirect response.", "title": "URI", "maxLength": 512, "x-displayname": "Location", "x-ves-example": "https://example.com/landing/page.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "512", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-example": "https://example.com/landing/page", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "512", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "byteLength": { "max": 512 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareRedirectMitigationChoiceType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"https://example.com/landing/page\"\n}", "example_yaml": "location: https://example.com/landing/page" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareWebClientType": { "type": "object", "description": "Web client configuration OPTIONS.", "title": "WebClientType", "x-displayname": "Web Client.", "x-ves-oneof-field-mitigation": "[\"block\",\"continue\",\"redirect\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.WebClientType", "properties": { "block": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareBlockMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue", "redirect" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block", "redirect" ] }, "redirect": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareRedirectMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block", "continue" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareWebClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudflareWebMobileClientType": { "type": "object", "description": "Web and Mobile client configuration OPTIONS.", "title": "WebMobileClientType", "x-displayname": "Web and Mobile Client.", "x-ves-oneof-field-mobile_mitigation": "[\"block_mobile\",\"continue_mobile\"]", "x-ves-oneof-field-web_mitigation": "[\"block_web\",\"continue_web\",\"redirect_web\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudflare.WebMobileClientType", "properties": { "block_mobile": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareBlockMobileMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue_mobile" ] }, "block_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareBlockMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue_web", "redirect_web" ] }, "continue_mobile": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_mobile" ] }, "continue_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareContinueMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_web", "redirect_web" ] }, "redirect_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudflareRedirectMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_web", "continue_web" ] } }, "x-f5xc-description-short": "Web and Mobile client configuration OPTIONS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudflareWebMobileClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontBlockMitigationChoiceType": { "type": "object", "description": "Block Response.", "title": "BlockMitigationChoiceType", "x-displayname": "Block Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.BlockMitigationChoiceType", "properties": { "body": { "type": "string", "description": "Custom body message.", "title": "body", "maxLength": 4096, "x-displayname": "Body", "x-ves-example": "

Your request was blocked

", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "

Your request was blocked

", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Content type to use in a block response.", "title": "content_type", "maxLength": 128, "x-displayname": "Content Type.", "x-ves-example": "Text/HTML", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "text/html", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Content type to use in a block response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontBlockMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontBlockMobileMitigationChoiceType": { "type": "object", "description": "Block Response.", "title": "BlockMobileMitigationChoiceType", "x-displayname": "Block Response for Mobile.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.BlockMobileMitigationChoiceType", "properties": { "body": { "type": "string", "description": "Custom body message.", "title": "body", "maxLength": 4096, "x-displayname": "Body", "x-ves-example": "

Your request was blocked

", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "

Your request was blocked

", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "content_type": { "type": "string", "description": "Content type to use in a block response.", "title": "content_type", "maxLength": 128, "x-displayname": "Content Type.", "x-ves-example": "Text/HTML", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "text/html", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Content type to use in a block response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontBlockMobileMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontClientBypassRule": { "type": "object", "description": "Client source rule specifies the sources to be trusted.", "title": "ClientBypassRule", "x-displayname": "Client Bypass Rule.", "x-ves-displayorder": "1,3", "x-ves-oneof-field-client_source_choice": "[\"http_header\",\"ip_prefix\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.ClientBypassRule", "properties": { "http_header": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontHttpHeaderMatcherList" } ], "x-f5xc-description-short": "Configuration parameter for http header.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ip_prefix" ] }, "ip_prefix": { "type": "string", "description": "Exclusive with [http_header]\nIP prefix string.", "title": "ip prefix", "x-displayname": "IP Prefix", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.string.ip_prefix": "true" }, "x-f5xc-description-short": "Exclusive with [http_header] IP prefix string.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "cidr", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_header" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Client source rule specifies the sources to be trusted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontClientBypassRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontContinueMitigationChoiceType": { "type": "object", "description": "Continue mitigation action.", "title": "ShapeBotFlagMitigationActionChoiceType", "x-displayname": "Select Continue Bot Mitigation Action.", "x-ves-oneof-field-add_header_choice": "[\"add_header\",\"no_header\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.ContinueMitigationChoiceType", "properties": { "add_header": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_header" ] }, "no_header": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "add_header" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontContinueMitigationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontHeaderMatcherType": { "type": "object", "description": "Header match is done using the name of the header and its value.\nThe value match is done using one of the following\nregex match on value\nexact match of value\npresence of header.", "title": "HeaderMatcherType", "x-displayname": "Header To Match.", "x-ves-oneof-field-value_match": "[\"exact\",\"regex\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.HeaderMatcherType", "properties": { "exact": { "type": "string", "description": "Exclusive with [regex]\nHeader value to match exactly.", "title": "exact", "maxLength": 256, "x-displayname": "Exact", "x-ves-example": "Application/JSON.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "application/json", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "Exclusive with [regex] Header value to match exactly.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regex" ] }, "name": { "type": "string", "description": "Name of the header.", "title": "name", "minLength": 1, "maxLength": 63, "x-displayname": "Name", "x-ves-example": "Content-Type.", "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", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "Content-Type", "x-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", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 63, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 256, "min": 1 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "regex": { "type": "string", "description": "Exclusive with [exact]\nRegex match of the header value in re2 format.", "title": "regex", "maxLength": 256, "x-displayname": "Regex", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true", "ves.io.schema.rules.string.regex": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Exclusive with [exact] Regex match of the header value in re2 format.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact" ] } }, "x-f5xc-description-short": "Header match is done using the name of the header and its value.", "x-f5xc-description-medium": "Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontHeaderMatcherType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"Content-Type\"\n}", "example_yaml": "name: Content-Type" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontHttpHeaderMatcherList": { "type": "object", "description": "Request header name and value pairs.", "title": "HTTP Header", "x-displayname": "HTTP Header.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.HttpHeaderMatcherList", "properties": { "headers": { "type": "array", "description": "List of HTTP header name and value pairs.", "title": "headers", "maxItems": 16, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontHeaderMatcherType" }, "x-displayname": "HTTP Headers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of HTTP header name and value pairs.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontHttpHeaderMatcherList", "required_fields": [ "headers" ], "mutually_exclusive_groups": [], "example_json": "{\n \"headers\": [\n {\n \"name\": \"Content-Type\"\n }\n ]\n}", "example_yaml": "headers:\n- name: Content-Type" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptExclusionRule": { "type": "object", "description": "Define JavaScript insertion exclusion rule.", "title": "JavaScriptExclusionRule", "x-displayname": "JavaScript Insertion Exclusion Rule.", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptExclusionRule", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "path": { "allOf": [ { "$ref": "#/components/schemas/ioschemaPathMatcherType" } ], "x-f5xc-example": "/api/v1/resources", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Define JavaScript insertion exclusion rule.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptExclusionRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptInsertManualType": { "type": "object", "description": "Insert JavaScript manually.", "title": "manual_js_insert", "x-displayname": "Insert JavaScript Manually.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertManualType", "properties": { "javascript_mode": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "js_download_path": { "type": "string", "description": "Web client will fetch F5 Client JavaScript from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.", "title": "js_download_path", "x-displayname": "Web Client JavaScript Path.", "x-ves-example": "/common.js.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-example": "/common.js", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-description-short": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "x-f5xc-description-medium": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths. If not specified, default to ‘/common.js’.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptInsertManualType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptInsertType": { "type": "object", "description": "This defines custom JavaScript insertion rules for Bot Defense Policy.", "title": "JavaScriptInsertType", "x-displayname": "JavaScript Custom Insertion Rules.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertType", "properties": { "exclude_list": { "type": "array", "description": "Optional JavaScript insertions exclude list of domain and path matchers.", "title": "exclude_list", "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptExclusionRule" }, "x-displayname": "JavaScript Exclude Paths.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Optional JavaScript insertions exclude list of domain and path matchers.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "javascript_location": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptLocation" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "javascript_mode": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "js_download_path": { "type": "string", "description": "Web client will fetch F5 Client JavaScript from this path.\nThis path must not conflict with any other website/application paths.\n\nIf not specified, default to ‘/common.js’.", "title": "js_download_path", "x-displayname": "Web Client JavaScript Path.", "x-ves-example": "/common.js.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-example": "/common.js", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true" }, "x-f5xc-description-short": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths.", "x-f5xc-description-medium": "Web client will fetch F5 Client JavaScript from this path. This path must not conflict with any other website/application paths. If not specified, default to ‘/common.js’.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rules": { "type": "array", "description": "Required list of pages to insert Bot Defense client JavaScript.", "title": "rules", "minItems": 1, "maxItems": 128, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontJavaScriptInsertionRule" }, "x-displayname": "JavaScript Insertion Paths.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Required list of pages to insert Bot Defense client JavaScript.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 128, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines custom JavaScript insertion rules for Bot Defense Policy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptInsertType", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {}\n ]\n}", "example_yaml": "rules:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptInsertionRule": { "type": "object", "description": "This defines a rule for Bot Defense JavaScript insertion.", "title": "JavaScriptInsertionRule", "x-displayname": "JavaScript Insertion Rule.", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-oneof-field-uri_path": "[\"exact_path\",\"glob\",\"prefix\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptInsertionRule", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "exact_path": { "type": "string", "description": "Exclusive with [glob prefix]\nExact path value to match.", "title": "path", "maxLength": 256, "x-displayname": "Path", "x-ves-example": "/logout", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/logout", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [glob prefix] Exact path value to match.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "glob", "prefix" ] }, "glob": { "type": "string", "description": "Exclusive with [exact_path prefix]\n\nAccepts wildcards * to match multiple characters or ? To match a single character.", "title": "glob", "minLength": 1, "maxLength": 256, "x-displayname": "Glob", "x-ves-example": "/ID/1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$" }, "x-f5xc-example": "/id/1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$" }, "x-f5xc-description-short": "Exclusive with [exact_path prefix] Accepts wildcards * to match multiple characters or ?", "x-f5xc-description-medium": "Exclusive with [exact_path prefix] Accepts wildcards * to match multiple characters or ? To match a single character.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "byteLength": { "max": 256, "min": 1 }, "pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,256}$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_path", "prefix" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix": { "type": "string", "description": "Exclusive with [exact_path glob]\nPath prefix to match (e.g. The value / will match on all paths)", "title": "prefix", "maxLength": 256, "x-displayname": "Prefix", "x-ves-example": "/register/.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/register/", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [exact_path glob] Path prefix to match (e.g. The value / will match on all paths)", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_path", "glob" ] } }, "x-f5xc-description-short": "Defines a rule for Bot Defense JavaScript insertion.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptInsertionRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptLocation": { "type": "string", "description": "All inside networks.\n\n- JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED\n\nUndefined\nInsert JavaScript after tag\nInsert JavaScript after tag.\nInsert JavaScript before first tag.", "title": "JavaScriptLocation", "enum": [ "JAVA_SCRIPT_LOCATION_UNDEFINED", "AFTER_HEAD", "AFTER_TITLE_END", "BEFORE_SCRIPT" ], "default": "JAVA_SCRIPT_LOCATION_UNDEFINED", "x-displayname": "JavaScript Location.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptLocation", "x-f5xc-description-short": "All inside networks. - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED Undefined Insert JavaScript after tag Insert...", "x-f5xc-description-medium": "All inside networks. - JAVA_SCRIPT_LOCATION_UNDEFINED: JAVA_SCRIPT_LOCATION_UNDEFINED Undefined Insert JavaScript after tag Insert JavaScript after tag. Insert JavaScript before first tag.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptLocation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"JAVA_SCRIPT_LOCATION_UNDEFINED\"", "example_yaml": "JAVA_SCRIPT_LOCATION_UNDEFINED\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontJavaScriptMode": { "type": "string", "description": "Web Client JavaScript Mode.\n\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable\nBot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is non-cacheable\nBot Defense JavaScript for telemetry collection is requested synchronously, and it is cacheable.", "title": "JavaScript Mode", "enum": [ "ASYNC_JS_NO_CACHING", "ASYNC_JS_CACHING", "SYNC_JS_NO_CACHING", "SYNC_JS_CACHING" ], "default": "ASYNC_JS_NO_CACHING", "x-displayname": "Web Client JavaScript Mode.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.JavaScriptMode", "x-f5xc-description-medium": "Web Client JavaScript Mode. Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is non-cacheable Bot Defense JavaScript for telemetry collection is requested asynchronously, and it is cacheable Bot Defense JavaScript for telemetry collection is requested...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontJavaScriptMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ASYNC_JS_NO_CACHING\"", "example_yaml": "ASYNC_JS_NO_CACHING\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontLogLevel": { "type": "string", "description": "Select the level of logging desired. Levels are cumulative\n(e.g. Debug includes Error, Warning, and Informational)\n\n- LOG_UNDEFINED: Undefined\n\n- LOG_ERROR: Error\n\nLog only errors\n- LOG_WARNING: Warning\n\nLog malicious requests\n- LOG_INFO: Info\n\nLog all requests\n- LOG_DEBUG: Debug\n\nLog debugging data.", "title": "loglevel", "enum": [ "LOG_UNDEFINED", "LOG_ERROR", "LOG_WARNING", "LOG_INFO", "LOG_DEBUG" ], "default": "LOG_UNDEFINED", "x-displayname": "Log Level", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.LogLevel", "x-f5xc-description-short": "Select the level of logging desired. Levels are cumulative (e.g.", "x-f5xc-description-medium": "Select the level of logging desired. Levels are cumulative (e.g. Debug includes Error, Warning, and Informational) - LOG_UNDEFINED: Undefined - LOG_ERROR: Error Log only errors - LOG_WARNING: Warning Log malicious requests - LOG_INFO: Info Log all requests - LOG_DEBUG: Debug Log debugging data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontLogLevel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LOG_UNDEFINED\"", "example_yaml": "LOG_UNDEFINED\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontMobileClientType": { "type": "object", "description": "Mobile client configuration OPTIONS.", "title": "MobileClientType", "x-displayname": "Mobile Client.", "x-ves-oneof-field-mitigation": "[\"block\",\"continue\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileClientType", "properties": { "block": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontBlockMobileMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontMobileClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontMobileSDKConfigType": { "type": "object", "description": "Mobile SDK configuration.", "title": "MobileSDKConfigType", "x-displayname": "Mobile SDK Configuration.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileSDKConfigType", "properties": { "mobile_identifier": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontMobileTrafficIdentifierType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontMobileSDKConfigType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontMobileTrafficIdentifierType": { "type": "object", "description": "Mobile traffic identifier type.", "title": "MobileTrafficIdentifierType", "x-displayname": "Mobile Traffic Identifier.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.MobileTrafficIdentifierType", "properties": { "headers": { "type": "array", "description": "A list of headers that can be used to identify mobile traffic.", "title": "Mobile headers", "maxItems": 16, "items": { "$ref": "#/components/schemas/protected_applicationcloudfrontHeaderMatcherType" }, "x-displayname": "Mobile Request Identifier Headers.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of headers that can be used to identify mobile traffic.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "minItems": 0, "uniqueItems": false, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontMobileTrafficIdentifierType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontProtectedEndpointType": { "type": "object", "description": "Add the name and description for the protected endpoint.", "title": "ProtectedEndpointType", "x-displayname": "Protected Endpoint.", "x-ves-displayorder": "1,2,3,4,5,6,7,12,8", "x-ves-oneof-field-client_type_choice": "[\"mobile_client\",\"web_client\",\"web_mobile_client\"]", "x-ves-oneof-field-domain_matcher_choice": "[\"any_domain\",\"domain\"]", "x-ves-oneof-field-flow_label_choice": "[\"flow_label\",\"undefined_flow_label\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.ProtectedEndpointType", "properties": { "any_domain": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "domain" ] }, "domain": { "allOf": [ { "$ref": "#/components/schemas/schemaDomainType" } ], "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "any_domain" ] }, "flow_label": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelCategoriesChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "undefined_flow_label" ] }, "http_methods": { "type": "array", "description": "List of HTTP methods.", "title": "HTTP Methods", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaBotHttpMethod" }, "x-displayname": "HTTP Methods.", "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": "[1,3,4]", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-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": "[1,3,4]", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaMessageMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mobile_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontMobileClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "web_client", "web_mobile_client" ] }, "path": { "type": "string", "description": "Accepts wildcards * to match multiple characters or ? To match a single character.", "title": "Path", "minLength": 1, "maxLength": 256, "x-displayname": "Path", "x-ves-example": "/ID/1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$" }, "x-f5xc-example": "/id/1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.min_bytes": "1", "ves.io.schema.rules.string.pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$" }, "x-f5xc-description-short": "Accepts wildcards * to match multiple characters or ? To match a single character.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^[\\\\\\\"$&'*+./0-9:?@A-Z_a-z~-]{1,999}$", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256, "min": 1 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "query": { "type": "string", "description": "Enter a regular expression to match your query parameters of interest.", "title": "Query", "maxLength": 256, "x-displayname": "Query", "x-ves-example": "(^|[^\\\\w])action=login([^\\\\w]|$)", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "(^|[^\\\\w])action=login([^\\\\w]|$)", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Enter a regular expression to match your query parameters of interest.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 0, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 256 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "undefined_flow_label": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "flow_label" ] }, "web_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontWebClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_client", "web_mobile_client" ] }, "web_mobile_client": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontWebMobileClientType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "mobile_client", "web_client" ] } }, "x-f5xc-description-short": "Add the name and description for the protected endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontProtectedEndpointType", "required_fields": [ "http_methods", "path" ], "mutually_exclusive_groups": [], "example_json": "{\n \"http_methods\": [\n \"METHOD_ANY\"\n ],\n \"path\": \"/id/1\"\n}", "example_yaml": "http_methods:\n- METHOD_ANY\npath: /id/1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontRedirectMitigationChoiceType": { "type": "object", "description": "Redirect.", "title": "RedirectMitigationChoiceType", "x-displayname": "Redirect", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.RedirectMitigationChoiceType", "properties": { "location": { "type": "string", "description": "URI location for redirect response.", "title": "URI", "maxLength": 512, "x-displayname": "Location", "x-ves-example": "https://example.com/landing/page.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "512", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-example": "https://example.com/landing/page", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "512", "ves.io.schema.rules.string.url_or_uri_ref": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "byteLength": { "max": 512 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontRedirectMitigationChoiceType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"https://example.com/landing/page\"\n}", "example_yaml": "location: https://example.com/landing/page" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontWebClientType": { "type": "object", "description": "Web client configuration OPTIONS.", "title": "WebClientType", "x-displayname": "Web Client.", "x-ves-oneof-field-mitigation": "[\"block\",\"continue\",\"redirect\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.WebClientType", "properties": { "block": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontBlockMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue", "redirect" ] }, "continue": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 0, "minLength": 0, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "x-f5xc-conflicts-with": [ "block", "redirect" ] }, "redirect": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontRedirectMitigationChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block", "continue" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontWebClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "protected_applicationcloudfrontWebMobileClientType": { "type": "object", "description": "Web and Mobile client configuration OPTIONS.", "title": "WebMobileClientType", "x-displayname": "Web and Mobile Client.", "x-ves-oneof-field-mobile_mitigation": "[\"block_mobile\",\"continue_mobile\"]", "x-ves-oneof-field-web_mitigation": "[\"block_web\",\"continue_web\",\"redirect_web\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.protected_application.cloudfront.WebMobileClientType", "properties": { "block_mobile": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontBlockMobileMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue_mobile" ] }, "block_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontBlockMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "continue_web", "redirect_web" ] }, "continue_mobile": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_mobile" ] }, "continue_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontContinueMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_web", "redirect_web" ] }, "redirect_web": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationcloudfrontRedirectMitigationChoiceType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "block_web", "continue_web" ] } }, "x-f5xc-description-short": "Web and Mobile client configuration OPTIONS.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protected_applicationcloudfrontWebMobileClientType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "none" } } }, "schemaBotDefenseFlowLabelAccountManagementChoiceType": { "type": "object", "description": "Bot Defense Flow Label Account Management Category.", "title": "BotDefenseFlowLabelAccountManagementChoiceType", "x-displayname": "Bot Defense Flow Label Account Management Category.", "x-ves-oneof-field-label_choice": "[\"create\",\"password_reset\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelAccountManagementChoiceType", "properties": { "create": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "password_reset" ] }, "password_reset": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for password reset.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Account Management Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelAccountManagementChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelAuthenticationChoiceType": { "type": "object", "description": "Bot Defense Flow Label Authentication Category.", "title": "BotDefenseFlowLabelCategoryChoiceType", "x-displayname": "Bot Defense Flow Label Authentication Category.", "x-ves-oneof-field-label_choice": "[\"login\",\"login_mfa\",\"login_partner\",\"logout\",\"token_refresh\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelAuthenticationChoiceType", "properties": { "login": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseTransactionResult" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login_mfa", "login_partner", "logout", "token_refresh" ] }, "login_mfa": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_partner", "logout", "token_refresh" ] }, "login_partner": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for login partner.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_mfa", "logout", "token_refresh" ] }, "logout": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_mfa", "login_partner", "token_refresh" ] }, "token_refresh": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for token refresh.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "login", "login_mfa", "login_partner", "logout" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Authentication Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelAuthenticationChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelCategoriesChoiceType": { "type": "object", "description": "Bot Defense Flow Label Category allows to associate traffic with selected category.", "title": "BotDefenseFlowLabelCategoryChoiceType", "x-displayname": "Bot Defense Flow Label Category.", "x-ves-oneof-field-flow_label_choice": "[\"account_management\",\"authentication\",\"financial_services\",\"flight\",\"profile_management\",\"search\",\"shopping_gift_cards\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelCategoriesChoiceType", "properties": { "account_management": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelAccountManagementChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for account management.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "authentication", "financial_services", "flight", "profile_management", "search", "shopping_gift_cards" ] }, "authentication": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelAuthenticationChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "financial_services", "flight", "profile_management", "search", "shopping_gift_cards" ] }, "financial_services": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelFinancialServicesChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for financial services.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "flight", "profile_management", "search", "shopping_gift_cards" ] }, "flight": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelFlightChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "financial_services", "profile_management", "search", "shopping_gift_cards" ] }, "profile_management": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelProfileManagementChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for profile management.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "financial_services", "flight", "search", "shopping_gift_cards" ] }, "search": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelSearchChoiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "financial_services", "flight", "profile_management", "shopping_gift_cards" ] }, "shopping_gift_cards": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseFlowLabelShoppingGiftCardsChoiceType" } ], "x-f5xc-description-short": "Configuration parameter for shopping gift cards.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "account_management", "authentication", "financial_services", "flight", "profile_management", "search" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Category allows to associate traffic with selected category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelCategoriesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelFinancialServicesChoiceType": { "type": "object", "description": "Bot Defense Flow Label Financial Services Category.", "title": "BotDefenseFlowLabelFinancialServicesChoiceType", "x-displayname": "Bot Defense Flow Label Financial Services Category.", "x-ves-oneof-field-label_choice": "[\"apply\",\"money_transfer\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelFinancialServicesChoiceType", "properties": { "apply": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "money_transfer" ] }, "money_transfer": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for money transfer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "apply" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Financial Services Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelFinancialServicesChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelFlightChoiceType": { "type": "object", "description": "Bot Defense Flow Label Flight Category.", "title": "BotDefenseFlowLabelFlightChoiceType", "x-displayname": "Bot Defense Flow Label Flight Category.", "x-ves-oneof-field-label_choice": "[\"checkin\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelFlightChoiceType", "properties": { "checkin": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelFlightChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelProfileManagementChoiceType": { "type": "object", "description": "Bot Defense Flow Label Profile Management Category.", "title": "BotDefenseFlowLabelProfileManagementChoiceType", "x-displayname": "Bot Defense Flow Label Profile Management Category.", "x-ves-oneof-field-label_choice": "[\"create\",\"update\",\"view\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelProfileManagementChoiceType", "properties": { "create": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "update", "view" ] }, "update": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create", "view" ] }, "view": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "create", "update" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Profile Management Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelProfileManagementChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelSearchChoiceType": { "type": "object", "description": "Bot Defense Flow Label Search Category.", "title": "BotDefenseFlowLabelSearchChoiceType", "x-displayname": "Bot Defense Flow Label Search Category.", "x-ves-oneof-field-label_choice": "[\"flight_search\",\"product_search\",\"reservation_search\",\"room_search\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelSearchChoiceType", "properties": { "flight_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for flight search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "product_search", "reservation_search", "room_search" ] }, "product_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for product search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "flight_search", "reservation_search", "room_search" ] }, "reservation_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for reservation search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "flight_search", "product_search", "room_search" ] }, "room_search": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for room search.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "flight_search", "product_search", "reservation_search" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelSearchChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseFlowLabelShoppingGiftCardsChoiceType": { "type": "object", "description": "Bot Defense Flow Label Shopping & Gift Cards Category.", "title": "BotDefenseFlowLabelShoppingGiftCardsChoiceType", "x-displayname": "Bot Defense Flow Label Shopping & Gift Cards Category.", "x-ves-oneof-field-label_choice": "[\"gift_card_make_purchase_with_gift_card\",\"gift_card_validation\",\"shop_add_to_cart\",\"shop_checkout\",\"shop_choose_seat\",\"shop_enter_drawing_submission\",\"shop_make_payment\",\"shop_order\",\"shop_price_inquiry\",\"shop_promo_code_validation\",\"shop_purchase_gift_card\",\"shop_update_quantity\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseFlowLabelShoppingGiftCardsChoiceType", "properties": { "gift_card_make_purchase_with_gift_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for gift card make purchase with gift card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "gift_card_validation": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for gift card validation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_add_to_cart": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop add to cart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_checkout": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop checkout.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_choose_seat": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop choose seat.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_enter_drawing_submission": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop enter drawing submission.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_make_payment": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop make payment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_order": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_price_inquiry": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop price inquiry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_promo_code_validation", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_promo_code_validation": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop promo code validation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_purchase_gift_card", "shop_update_quantity" ] }, "shop_purchase_gift_card": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop purchase gift card.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_update_quantity" ] }, "shop_update_quantity": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for shop update quantity.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gift_card_make_purchase_with_gift_card", "gift_card_validation", "shop_add_to_cart", "shop_checkout", "shop_choose_seat", "shop_enter_drawing_submission", "shop_make_payment", "shop_order", "shop_price_inquiry", "shop_promo_code_validation", "shop_purchase_gift_card" ] } }, "x-f5xc-description-short": "Bot Defense Flow Label Shopping & Gift Cards Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseFlowLabelShoppingGiftCardsChoiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseTransactionResult": { "type": "object", "description": "Bot Defense Transaction Result.", "title": "BotDefenseTransactionResult", "x-displayname": "Bot Defense Transaction Result.", "x-ves-oneof-field-transaction_result_choice": "[\"disable_transaction_result\",\"transaction_result\"]", "x-ves-proto-message": "ves.io.schema.BotDefenseTransactionResult", "properties": { "disable_transaction_result": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "transaction_result" ] }, "transaction_result": { "allOf": [ { "$ref": "#/components/schemas/schemaBotDefenseTransactionResultType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_transaction_result" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseTransactionResult", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseTransactionResultCondition": { "type": "object", "description": "Bot Defense Transaction Result Condition.", "title": "BotDefenseTransactionResultCondition", "x-displayname": "Bot Defense Transaction Result Condition.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BotDefenseTransactionResultCondition", "properties": { "name": { "type": "string", "description": "A case-insensitive HTTP header name.", "title": "name", "maxLength": 63, "x-displayname": "Header Name.", "x-ves-example": "Accept-Encoding.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-example": "Accept-Encoding", "x-validation-rules": { "ves.io.schema.rules.string.http_header_field": "true", "ves.io.schema.rules.string.max_bytes": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 256 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "regex_values": { "type": "array", "description": "A list of regular expressions to match the input against.", "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" }, "x-f5xc-example": "['^new .*$', 'san f.*', '.* del .*']", "x-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" }, "x-f5xc-description-short": "List of regular expressions to match the input against.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Bot Defense Transaction Result Condition.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseTransactionResultCondition", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotDefenseTransactionResultType": { "type": "object", "description": "Bot Defense Transaction ResultType.", "title": "BotDefenseTransactionResultType", "x-displayname": "Bot Defense Transaction Result Type.", "x-ves-displayorder": "4,3", "x-ves-proto-message": "ves.io.schema.BotDefenseTransactionResultType", "properties": { "failure_conditions": { "type": "array", "description": "Failure Conditions.", "title": "Failure Conditions", "maxItems": 3, "items": { "$ref": "#/components/schemas/schemaBotDefenseTransactionResultCondition" }, "x-displayname": "Failure Conditions.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "success_conditions": { "type": "array", "description": "Success Conditions.", "title": "Success Conditions", "maxItems": 3, "items": { "$ref": "#/components/schemas/schemaBotDefenseTransactionResultCondition" }, "x-displayname": "Success Conditions.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "3", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 3, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotDefenseTransactionResultType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaBotHttpMethod": { "type": "string", "description": "Specifies the HTTP method used to access a resource.\n\nAny HTTP Method\nGET method for XMLHttpRequest or Fetch\nPOST method\nPUT method\nPATCH method\nDELETE method\nGET method for HTML document.", "title": "BotHttpMethod", "enum": [ "METHOD_ANY", "METHOD_GET", "METHOD_POST", "METHOD_PUT", "METHOD_PATCH", "METHOD_DELETE", "METHOD_GET_DOCUMENT" ], "default": "METHOD_ANY", "x-displayname": "HTTP Method.", "x-ves-proto-enum": "ves.io.schema.BotHttpMethod", "x-f5xc-description-short": "Specifies the HTTP method used to access a resource.", "x-f5xc-description-medium": "Specifies the HTTP method used to access a resource. Any HTTP Method GET method for XMLHttpRequest or Fetch POST method PUT method PATCH method DELETE method GET method for HTML document.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBotHttpMethod", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"METHOD_ANY\"", "example_yaml": "METHOD_ANY\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaDomainType": { "type": "object", "description": "Domains names.", "title": "Domains", "x-displayname": "Domains", "x-ves-oneof-field-domain_choice": "[\"exact_value\",\"regex_value\",\"suffix_value\"]", "x-ves-proto-message": "ves.io.schema.DomainType", "properties": { "exact_value": { "type": "string", "description": "Exclusive with [regex_value suffix_value]\nExact domain name.", "title": "exact value", "minLength": 1, "maxLength": 256, "x-displayname": "Exact Value.", "x-ves-example": "abc.zyz.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "abc.zyz.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [regex_value suffix_value] Exact domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regex_value", "suffix_value" ] }, "regex_value": { "type": "string", "description": "Exclusive with [exact_value suffix_value]\nRegular Expression value for the domain name.", "title": "regex values of Domains", "minLength": 1, "maxLength": 256, "x-displayname": "Regex Values of Domains.", "x-ves-example": "([a-z]([-a-z0-9]*[a-z0-9])?)\\\\.com$.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "([a-z]([-a-z0-9]*[a-z0-9])?)\\\\.com$", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Exclusive with [exact_value suffix_value] Regular Expression value for the domain name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_value", "suffix_value" ] }, "suffix_value": { "type": "string", "description": "Exclusive with [exact_value regex_value]\nSuffix of domain name e.g \"xyz.com\" will match \"*.xyz.com\" and \"xyz.com\"", "title": "suffix value", "minLength": 1, "maxLength": 256, "x-displayname": "Suffix Value.", "x-ves-example": "xyz.com", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "xyz.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Exclusive with [exact_value regex_value] Suffix of domain name e.g \"xyz.com\" will match \"*.xyz.com\" and \"xyz.com\".", "x-f5xc-description-medium": "Exclusive with [exact_value regex_value] Suffix of domain name e.g \"xyz.com\" will match \"*.xyz.com\" and \"xyz.com\".", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_value", "regex_value" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaDomainType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "report_configReportFreqDaily": { "type": "object", "description": "Create report daily.", "title": "Report Frequency Daily", "x-displayname": "Report Frequency Daily.", "x-ves-proto-message": "ves.io.schema.report_config.ReportFreqDaily", "properties": { "report_generation_time": { "type": "string", "description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "title": "report generation time", "x-displayname": "Report Generation Time.", "x-ves-example": "08:30:00 PM.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-example": "08:30:00 PM", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-description-short": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for report_configReportFreqDaily", "required_fields": [ "report_generation_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"report_generation_time\": \"08:30:00 PM\"\n}", "example_yaml": "report_generation_time: 08:30:00 PM" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "report_configReportFreqMonthly": { "type": "object", "description": "Create report monthly.", "title": "Report Frequency Monthly", "x-displayname": "Report Frequency Monthly.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.report_config.ReportFreqMonthly", "properties": { "date": { "allOf": [ { "$ref": "#/components/schemas/report_configReportGenerationDate" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_generation_time": { "type": "string", "description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "title": "time report is generated", "x-displayname": "Time Report is Generated.", "x-ves-example": "08:30:00 PM.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-example": "08:30:00 PM", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-description-short": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for report_configReportFreqMonthly", "required_fields": [ "report_generation_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"report_generation_time\": \"08:30:00 PM\"\n}", "example_yaml": "report_generation_time: 08:30:00 PM" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "report_configReportFreqWeekly": { "type": "object", "description": "Create report weekly.", "title": "Report Frequency Weekly", "x-displayname": "Report Frequency Weekly.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.report_config.ReportFreqWeekly", "properties": { "day": { "allOf": [ { "$ref": "#/components/schemas/report_configReportGenerationWeekday" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "report_generation_time": { "type": "string", "description": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "title": "report generation time", "x-displayname": "Report Generation Time.", "x-ves-example": "08:30:00 PM.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-example": "08:30:00 PM", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)" }, "x-f5xc-description-short": "Times are in UTC time. Generating reports may be delayed up to 30 minutes from the time set.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "(((0[1-9])|(1[0-2])):([0-5])([0-9]):([0-5])([0-9])\\\\s?(A|P)M)", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for report_configReportFreqWeekly", "required_fields": [ "report_generation_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"report_generation_time\": \"08:30:00 PM\"\n}", "example_yaml": "report_generation_time: 08:30:00 PM" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "report_configReportGenerationDate": { "type": "string", "description": "Report generation date\n\nIndicates field not being set\nCreate report on Last day of month.", "title": "Report Generation Date", "enum": [ "DATE_NONE", "DATE_ONE", "DATE_TWO", "DATE_THREE", "DATE_FOUR", "DATE_FIVE", "DATE_SIX", "DATE_SEVEN", "DATE_EIGHT", "DATE_NINE", "DATE_TEN", "DATE_ELEVEN", "DATE_TWELVE", "DATE_THIRTEEN", "DATE_FOURTEEN", "DATE_FIFTEEN", "DATE_SIXTEEN", "DATE_SEVENTEEN", "DATE_EIGHTEEN", "DATE_NINETEEN", "DATE_TWENTY", "DATE_TWENTYONE", "DATE_TWENTYTWO", "DATE_TWENTYTHREE", "DATE_TWENTYFOUR", "DATE_TWENTYFIVE", "DATE_TWENTYSIX", "DATE_TWENTYSEVEN", "DATE_TWENTYEIGHT", "DATE_LAST" ], "default": "DATE_NONE", "x-displayname": "Report Generation Date.", "x-ves-proto-enum": "ves.io.schema.report_config.ReportGenerationDate", "x-f5xc-description-short": "Report generation date Indicates field not being set Create report on Last day of month.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for report_configReportGenerationDate", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DATE_NONE\"", "example_yaml": "DATE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "report_configReportGenerationWeekday": { "type": "string", "description": "Report generation weekday\n\nIndicates field not being set.", "title": "Report Generation Weekday", "enum": [ "WEEKDAY_NONE", "WEEKDAY_MONDAY", "WEEKDAY_TUESDAY", "WEEKDAY_WEDNESDAY", "WEEKDAY_THURSDAY", "WEEKDAY_FRIDAY", "WEEKDAY_SATURDAY", "WEEKDAY_SUNDAY" ], "default": "WEEKDAY_NONE", "x-displayname": "Report Generation Weekday.", "x-ves-proto-enum": "ves.io.schema.report_config.ReportGenerationWeekday", "x-f5xc-description-short": "Report generation weekday Indicates field not being set.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for report_configReportGenerationWeekday", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"WEEKDAY_NONE\"", "example_yaml": "WEEKDAY_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingASOrgFilter": { "type": "object", "description": "Query Filter by AS Organizations.", "title": "ASOrg Filter", "x-displayname": "AS Organization Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ASOrgFilter", "properties": { "as_orgs": { "type": "array", "description": "An unordered list of as org strings.", "title": "AS Organizations", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 1024 }, "x-displayname": "AS Organizations.", "x-ves-example": "['Google LLC', 'Facebook, Inc']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "1024", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Google LLC', 'Facebook, Inc']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "1024", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingASOrgFilter", "required_fields": [ "as_orgs" ], "mutually_exclusive_groups": [], "example_json": "{\n \"as_orgs\": [\n \"value\"\n ]\n}", "example_yaml": "as_orgs:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingATBRequest": { "type": "object", "description": "Request for ATB.", "title": "ATBRequest", "x-displayname": "Request for ATB.", "x-ves-oneof-field-frequency": "[\"daily\",\"monthly\",\"weekly\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ATBRequest", "properties": { "daily": { "allOf": [ { "$ref": "#/components/schemas/report_configReportFreqDaily" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "monthly", "weekly" ] }, "enable": { "type": "boolean", "description": "Enable ATB or not.", "title": "Enable", "format": "boolean", "x-displayname": "Enable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "monthly": { "allOf": [ { "$ref": "#/components/schemas/report_configReportFreqMonthly" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "daily", "weekly" ] }, "namespace": { "type": "string", "description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "resource_id": { "type": "string", "description": "Resource ID of ATB report configuration object.", "title": "Resource ID", "x-displayname": "Resource ID.", "x-ves-example": "1234567", "x-f5xc-example": "1234567", "x-f5xc-description-short": "Resource ID of ATB report configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "virtual_host": { "type": "string", "description": "Name of Virtual Host to scope traffic overview query.", "title": "Virtual Host Name", "x-displayname": "Virtual Host Name.", "x-ves-example": "Example-app-vh-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-app-vh-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "weekly": { "allOf": [ { "$ref": "#/components/schemas/report_configReportFreqWeekly" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "daily", "monthly" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingATBRequest", "required_fields": [ "namespace", "virtual_host" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\",\n \"virtual_host\": \"example-app-vh-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1\nvirtual_host: example-app-vh-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingATBResponse": { "type": "object", "description": "Response for ATB.", "title": "ATBResponse", "x-displayname": "Response for ATB.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ATBResponse", "properties": { "enable": { "type": "boolean", "description": "Enable ATB or not.", "title": "Enable", "format": "boolean", "x-displayname": "Enable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingATBResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingActionData": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ActionData", "properties": { "action_taken": { "type": "string", "description": "The Action Taken for automated bot traffic.", "title": "Item Name", "x-displayname": "Action Taken.", "x-ves-example": "Blocked", "x-f5xc-example": "blocked", "x-f5xc-description-short": "The Action Taken for automated bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count": { "type": "string", "description": "The total count of the action taken.", "title": "Current Total Count for the action", "format": "uint64", "x-displayname": "Total Count.", "x-ves-example": "70", "x-f5xc-example": "70", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingActionData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingActionTakenData": { "type": "object", "title": "Action Taken Data", "x-displayname": "Action Taken Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ActionTakenData", "properties": { "action_taken": { "type": "string", "description": "The Action Taken for the malicious traffic.", "title": "Item Name", "x-displayname": "Action Taken.", "x-ves-example": "Blocked", "x-f5xc-example": "blocked", "x-f5xc-description-short": "The Action Taken for the malicious traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "current_total": { "type": "string", "description": "The total count of the action taken.", "title": "Current Total Count for the action", "format": "uint64", "x-displayname": "Total Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "previous_total": { "type": "string", "description": "The total number of malicious bot traffic in the action taken within the previous specified time interval.", "title": "Total count of Action Taken in the previous time interval", "format": "uint64", "x-displayname": "Previous Count in last X days.", "x-f5xc-example": "34", "x-f5xc-description-short": "The total number of malicious bot traffic in the action taken within the previous specified time interval.", "x-f5xc-description-medium": "The total number of malicious bot traffic in the action taken within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "type": "string", "description": "The sentiment for the trend of malicious traffic in the Action Taken.", "title": "Sentiment for the Action Taken", "x-displayname": "Action Taken Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of malicious traffic in the Action Taken.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Trend of the number of malicious bot traffic in the Action Taken.", "title": "Trend for the Action Taken", "format": "double", "x-displayname": "Action Taken Trend.", "x-f5xc-example": "0.4 or null", "x-f5xc-description-short": "Trend of the number of malicious bot traffic in the Action Taken.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingActionTakenData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingActionTakenFilter": { "type": "object", "description": "Query Filter by action taken.", "title": "Action Taken Filter", "x-displayname": "Action Taken Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ActionTakenFilter", "properties": { "actions_taken": { "type": "array", "description": "A list of strings.", "title": "Action Taken", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Actions Taken.", "x-ves-example": "['Block', 'Continue']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Block', 'Continue']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingActionTakenFilter", "required_fields": [ "actions_taken" ], "mutually_exclusive_groups": [], "example_json": "{\n \"actions_taken\": [\n \"value\"\n ]\n}", "example_yaml": "actions_taken:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingActionsPerCategoryResponse": { "type": "object", "description": "Response for Actions Per Category with global filters.", "title": "Actions Per Category Response", "x-displayname": "Actions Per Category Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ActionsPerCategoryResponse", "properties": { "action_taken_summary": { "type": "array", "description": "Action Taken Summary.", "title": "Action Taken Summary", "items": { "$ref": "#/components/schemas/reportingKnownBotGenericMetric" }, "x-displayname": "Action Taken Summary.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category_action_breakdown": { "type": "array", "description": "Category Action Breakdown.", "title": "Category Action Breakdown", "items": { "$ref": "#/components/schemas/reportingCategoryActionBreakdown" }, "x-displayname": "Category Action Breakdown.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Actions Per Category with global filters.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingActionsPerCategoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingActiveAIKnownBotResponse": { "type": "object", "description": "Active AI Known Bot Response.", "title": "Active AI Known Bot Response", "x-displayname": "Active AI Known Bot Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ActiveAIKnownBotResponse", "properties": { "active_ai_bots": { "type": "array", "description": "Active AI Bots.", "title": "Active AI Bots", "items": { "$ref": "#/components/schemas/reportingKnownBotDistribution" }, "x-displayname": "Active AI Bots.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingActiveAIKnownBotResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAppIDFilter": { "type": "object", "description": "Query Filter by app ID filter strings.", "title": "App ID Filter", "x-displayname": "App ID Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AppIDFilter", "properties": { "app_id_strings": { "type": "array", "description": "An unordered list of App ID strings.", "title": "App ID Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "App ID Strings.", "x-ves-example": "['05e6f9399cbb4e18b5775fb206d37312']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['05e6f9399cbb4e18b5775fb206d37312']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAppIDFilter", "required_fields": [ "app_id_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"app_id_strings\": [\n \"value\"\n ]\n}", "example_yaml": "app_id_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingApplicationNameFilter": { "type": "object", "description": "Query Filter by application name.", "title": "Application Name Filter", "x-displayname": "Application Name Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ApplicationNameFilter", "properties": { "application_names": { "type": "array", "description": "A list of strings.", "title": "Application Name", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Application Names.", "x-ves-example": "['app1', 'app2']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['app1', 'app2']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingApplicationNameFilter", "required_fields": [ "application_names" ], "mutually_exclusive_groups": [], "example_json": "{\n \"application_names\": [\n \"value\"\n ]\n}", "example_yaml": "application_names:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackIntentData": { "type": "object", "description": "Attack Intent Data.", "title": "Attack Intent Data", "x-displayname": "Attack Intent Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackIntentData", "properties": { "count": { "type": "string", "description": "The Number of Each Attack Intent Type.", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The Name of Attack Intent Type.", "title": "Attack Intent Type Name", "x-displayname": "Name", "x-ves-example": "Carding", "x-f5xc-example": "Carding", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "The Percentage of the number of each attack intent type / the total traffic or bad bot.", "title": "Attack Intent Type Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "50.0", "x-f5xc-description-short": "The Percentage of the number of each attack intent type / the total traffic or bad bot.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_series": { "type": "array", "description": "Time Series Data for Each Attack Intent Type.", "title": "Attack Intent Time Series", "items": { "$ref": "#/components/schemas/reportingTimeSeriesDataV2" }, "x-displayname": "Attack Intent Time Series.", "x-f5xc-description-short": "Time Series Data for Each Attack Intent Type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackIntentData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackIntentFilter": { "type": "object", "description": "Query Filter by attack intent filter strings.", "title": "Attack Intent Filter", "x-displayname": "Attack Intent Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackIntentFilter", "properties": { "attack_intent_strings": { "type": "array", "description": "An list of strings.", "title": "Attack Intent Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Attack Intent Strings.", "x-ves-example": "['Credential Stuffing', 'Carding']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Credential Stuffing', 'Carding']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by attack intent filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackIntentFilter", "required_fields": [ "attack_intent_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"attack_intent_strings\": [\n \"value\"\n ]\n}", "example_yaml": "attack_intent_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackIntentTimeSeriesResponse": { "type": "object", "description": "The Response of Attack Intent Time Series API.", "title": "Attack Intent Time Series Response", "x-displayname": "Attack Intent Time Series Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackIntentTimeSeriesResponse", "properties": { "attack_intent_data": { "type": "array", "title": "Attack Intent Data", "items": { "$ref": "#/components/schemas/reportingAttackIntentData" }, "x-displayname": "Attack Intent Data.", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The Response of Attack Intent Time Series API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackIntentTimeSeriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackedBFPData": { "type": "object", "description": "Attacked BFP Data.", "title": "Attacked BFP Data", "x-displayname": "Attacked BFP Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackedBFPData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "Testbfp", "x-f5xc-example": "testbfp", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "Percentage.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackedBFPData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackedEndpointData": { "type": "object", "description": "Attacked application endpoint data.", "title": "Attacked Endpoint Data", "x-displayname": "Attacked Endpoint Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackedEndpointData", "properties": { "app_name": { "type": "string", "description": "The data for the application name column shown on the top bot endpoints panel on the traffic page.", "title": "Application Name", "x-displayname": "Application Name.", "x-ves-example": "Test-BIG-IP-app.", "x-f5xc-example": "test-bigip-app", "x-f5xc-description-short": "The data for the application name column shown on the top bot endpoints panel on the traffic page.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostname": { "type": "string", "description": "Hostname of attacked app endpoint.", "title": "Hostname", "x-displayname": "Hostname", "x-ves-example": "xyz.example.com.", "x-f5xc-example": "xyz.example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "human_request_count": { "type": "string", "description": "Number of HTTP requests identified as human.", "title": "Human Request Count", "format": "uint64", "x-displayname": "Human Request Count.", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of HTTP requests identified as human.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method": { "type": "string", "description": "HTTP method of attacked app endpoint.", "title": "HTTP Method", "x-displayname": "HTTP Method.", "x-ves-example": "POST", "x-f5xc-example": "POST", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri": { "type": "string", "description": "URI of attacked app endpoint.", "title": "URI", "x-displayname": "URI", "x-ves-example": "/index.php.", "x-f5xc-example": "/index.php", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackedEndpointData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackedEndpointDataV2": { "type": "object", "description": "Attacked application endpoint data V2.", "title": "Attacked Endpoint Data V2", "x-displayname": "Attacked Endpoint Data V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackedEndpointDataV2", "properties": { "endpoint_traffic_details": { "type": "array", "description": "Endpoint Traffic Details.", "title": "Endpoint Traffic Details", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Endpoint Traffic Details.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "string", "description": "Number of Total Traffic Count for Each Endpoints.", "title": "Total Traffic Count for Each Endpoints", "format": "uint64", "x-displayname": "Total Traffic Count for Each Endpoints.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of Total Traffic Count for Each Endpoints.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri": { "type": "string", "description": "URI of attacked app endpoint.", "title": "URI", "x-displayname": "URI", "x-ves-example": "/index.php.", "x-f5xc-example": "/index.php", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackedEndpointDataV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAttackedEndpointDataV4": { "type": "object", "description": "Attacked application endpoint data V4.", "title": "Attacked Endpoint Data V4", "x-displayname": "Attacked Endpoint Data V4.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AttackedEndpointDataV4", "properties": { "category": { "type": "string", "description": "Category", "title": "Category", "x-displayname": "Category", "x-ves-example": "Shopping", "x-f5xc-example": "Shopping", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_traffic_details": { "type": "array", "description": "Endpoint Traffic Details.", "title": "Endpoint Traffic Details", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Endpoint Traffic Details.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flow_label": { "type": "string", "description": "Flow Label.", "title": "Flow Label", "x-displayname": "Flow Label.", "x-ves-example": "Login", "x-f5xc-example": "Login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "string", "description": "Number of Total Traffic Count for Each Endpoints.", "title": "Total Traffic Count for Each Endpoints", "format": "uint64", "x-displayname": "Total Traffic Count for Each Endpoints.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of Total Traffic Count for Each Endpoints.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri": { "type": "string", "description": "URI of attacked app endpoint.", "title": "URI", "x-displayname": "URI", "x-ves-example": "/index.php.", "x-f5xc-example": "/index.php", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAttackedEndpointDataV4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAutomatedTrafficActionsResponse": { "type": "object", "description": "Automated Bot Taffic in Actions Response.", "title": "AutomatedTrafficActionsResponse", "x-displayname": "Automated Bot Taffic Overview in Actions.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AutomatedTrafficActionsResponse", "properties": { "actions": { "type": "array", "title": "x-displayName: \"Action taken Details\"", "items": { "$ref": "#/components/schemas/reportingActionData" }, "description": "Action or operation type", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "current_total": { "type": "string", "description": "The total count of all the action taken.", "title": "Current Total Count for the action", "format": "uint64", "x-displayname": "Total Count.", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "The total count of all the action taken.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "previous_total": { "type": "string", "description": "The total number of automated bot traffic in the action taken within the previous specified time interval.", "title": "Total count of All the Action Taken in the previous time interval", "format": "uint64", "x-displayname": "Previous Count in last X days.", "x-f5xc-example": "31", "x-f5xc-description-short": "The total number of automated bot traffic in the action taken within the previous specified time interval.", "x-f5xc-description-medium": "The total number of automated bot traffic in the action taken within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "type": "string", "description": "The sentiment for the total automated bot traffic Actions.", "title": "Sentiment for the total automated bot traffic Actions", "x-displayname": "Action Taken Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the total automated bot traffic Actions.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Trend of the number of automated bot traffic in the Action Taken.", "title": "Trend for the total automated bot traffic Actions", "format": "double", "x-displayname": "Action Taken Trend.", "x-f5xc-example": "0.4 or null", "x-f5xc-description-short": "Trend of the number of automated bot traffic in the Action Taken.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Automated Bot Taffic in Actions Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAutomatedTrafficActionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAutomationTypeData": { "type": "object", "description": "Malicious bot automation type.", "title": "Automation Type Data", "x-displayname": "Malicious Bot Automation Type Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AutomationTypeData", "properties": { "automation_type": { "type": "string", "description": "Malicious Bot Automation Type.", "title": "Malicious Bot Automation Type", "x-displayname": "Malicious Bot Automation Type.", "x-ves-example": "Token Expired.", "x-f5xc-example": "Token Expired", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "previous_request_count": { "type": "string", "description": "Previous Request Count.", "title": "Previous Request Count", "format": "uint64", "x-displayname": "Previous Request Count.", "x-ves-example": "2000", "x-f5xc-wire-name": "previous_reqeust_count", "x-f5xc-example": "2000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_count": { "type": "string", "description": "Number of requests with the specified automation type.", "title": "Request Count", "format": "uint64", "x-displayname": "Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of requests with the specified automation type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_percentage": { "type": "number", "description": "Request Percentage.", "title": "Request Percentage", "format": "double", "x-displayname": "Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_sentiment": { "type": "string", "description": "Request Sentiment.", "title": "Request Sentiment", "x-displayname": "Request Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "Trend", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "0.3 or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAutomationTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingAutomationTypeFilter": { "type": "object", "description": "Query Filter by automation type filter strings.", "title": "Automation Type Filter", "x-displayname": "Automation Type Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.AutomationTypeFilter", "properties": { "automation_type_strings": { "type": "array", "description": "An list of strings.", "title": "Automation Type Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Automation Type Strings.", "x-ves-example": "['Aggregator']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Aggregator']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by automation type filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingAutomationTypeFilter", "required_fields": [ "automation_type_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"automation_type_strings\": [\n \"value\"\n ]\n}", "example_yaml": "automation_type_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingBrowserFilter": { "type": "object", "description": "Query Filter by browser filter strings.", "title": "Browser Filter", "x-displayname": "Browser Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.BrowserFilter", "properties": { "browser_strings": { "type": "array", "description": "An list of strings.", "title": "Browser Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Browser Strings.", "x-ves-example": "['chrome', 'firefox']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['chrome', 'firefox']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingBrowserFilter", "required_fields": [ "browser_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"browser_strings\": [\n \"value\"\n ]\n}", "example_yaml": "browser_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCategoriesData": { "type": "object", "description": "Flow label categories data. Includes total number of requests and requests time series.", "title": "Flow Label Categories", "x-displayname": "Categories.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CategoriesData", "properties": { "category": { "type": "string", "description": "Flow label category name.", "title": "Category Name", "x-displayname": "Category", "x-ves-example": "Authentication.", "x-f5xc-example": "Authentication", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "The request for each category / the total traffic.", "title": "The request percentage of each category", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "23.5", "x-f5xc-description-short": "The request for each category / the total traffic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requests": { "type": "string", "description": "Number of requests labeled as a specific flow label category.", "title": "Number of Requests", "format": "uint64", "x-displayname": "Number of Requests.", "x-f5xc-example": "342", "x-f5xc-description-short": "Number of requests labeled as a specific flow label category.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Flow label categories data. Includes total number of requests and requests time series.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCategoriesData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCategoriesTimeSeriesResponse": { "type": "object", "description": "The Response contains the time series data list for each endpoint category.", "title": "Categories Time Series Response", "x-displayname": "Response for Categories TimeSeries.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CategoriesTimeSeriesResponse", "properties": { "category_time_series_data": { "type": "array", "title": "Response for Category TimeSeries", "items": { "$ref": "#/components/schemas/reportingCategoryTimeSeriesData" }, "x-displayname": "Category TimeSeries Data.", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The Response contains the time series data list for each endpoint category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCategoriesTimeSeriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCategoryActionBreakdown": { "type": "object", "description": "Category Action Breakdown.", "title": "Category Action Breakdown", "x-displayname": "Category Action Breakdown.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CategoryActionBreakdown", "properties": { "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_category": { "type": "string", "description": "Known Bot Category.", "title": "Known Bot Category", "x-displayname": "Known Bot Category.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_action_distribution": { "type": "array", "description": "Traffic Action Distribution.", "title": "Traffic Action Distribution", "items": { "$ref": "#/components/schemas/reportingKnownBotGenericMetric" }, "x-displayname": "Traffic Action Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCategoryActionBreakdown", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCategoryTimeSeriesData": { "type": "object", "title": "Category Time Series Data", "x-displayname": "Category Timeseries Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CategoryTimeSeriesData", "properties": { "count": { "type": "string", "description": "The Number of Each Category.", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The Name of Category.", "title": "Category Name", "x-displayname": "Name", "x-ves-example": "Authentication.", "x-f5xc-example": "Authentication", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "time_series": { "type": "array", "description": "Time Series Data for Each Category Type.", "title": "Category Time Series", "items": { "$ref": "#/components/schemas/reportingTimeSeriesDataV2" }, "x-displayname": "Category Time Series.", "x-f5xc-description-short": "Time Series Data for Each Category Type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCategoryTimeSeriesData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingConsumptionData": { "type": "object", "title": "Consumption Summary Data", "x-displayname": "Consumption Summary Data.", "x-ves-oneof-field-aggregation_level": "[\"day\",\"month\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ConsumptionData", "properties": { "all": { "type": "string", "description": "All traffic count.", "title": "All Traffic", "format": "uint64", "x-displayname": "All", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "day": { "type": "string", "description": "Exclusive with [month]\nDay Identifier, format: YYYYMMDD.", "title": "Day of the traffic Consumption Summary", "x-displayname": "Day", "x-ves-example": "20240701", "x-f5xc-example": "20240701", "x-f5xc-description-short": "Exclusive with [month] Day Identifier, format: YYYYMMDD.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "month" ] }, "month": { "type": "string", "description": "Exclusive with [day]\nMonth Identifier, format: YYYYMM.", "title": "Month of the traffic Consumption Summary", "x-displayname": "Month", "x-ves-example": "202407", "x-f5xc-example": "202407", "x-f5xc-description-short": "Exclusive with [day] Month Identifier, format: YYYYMM.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "day" ] }, "telemetry_client": { "type": "string", "description": "Counts of telemetry client.", "title": "Telemetry Client Count", "format": "uint64", "x-displayname": "Telemetry Client.", "x-ves-example": "21", "x-f5xc-example": "21", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingConsumptionData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingConsumptionSummaryResponse": { "type": "object", "description": "Response for Consumption Summary.", "title": "Consumption Summary Response", "x-displayname": "Response for Consumption Summary.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ConsumptionSummaryResponse", "properties": { "sums": { "type": "array", "description": "Consumption summary data.", "title": "Consumption Summary", "items": { "$ref": "#/components/schemas/reportingConsumptionData" }, "x-displayname": "Consumption Summary Data.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingConsumptionSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCountryFilter": { "type": "object", "description": "Query Filter by country filter strings.", "title": "Country Filter", "x-displayname": "Country Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CountryFilter", "properties": { "country_strings": { "type": "array", "description": "An list of strings.", "title": "Country Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Country Strings.", "x-ves-example": "['US']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['US']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCountryFilter", "required_fields": [ "country_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"country_strings\": [\n \"value\"\n ]\n}", "example_yaml": "country_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingCredentialStuffingAttackResponse": { "type": "object", "description": "Response for Credential Stuffing Attack.", "title": "InsightEvent: Credential Stuffing Attack", "x-displayname": "Credential Stuffing Attack Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.CredentialStuffingAttackResponse", "properties": { "bad_bot_login": { "type": "string", "description": "The Number of Bad Bot Activity with Login Endpoint.", "title": "Bad Bot Login endpoint", "format": "uint64", "x-displayname": "The Number of Bad Bot Login endpoint.", "x-ves-example": "13", "x-f5xc-example": "13", "x-f5xc-description-short": "The Number of Bad Bot Activity with Login Endpoint.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_login_percentage": { "type": "number", "description": "The Percentage for Bad Bot Activity with Login Endpoint.", "title": "Bad Bot Login endpoint Percentage", "format": "double", "x-displayname": "Bad Bot Login endpoint Percentage.", "x-ves-example": "78.9", "x-f5xc-example": "78.9", "x-f5xc-description-short": "The Percentage for Bad Bot Activity with Login Endpoint.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "create_date": { "type": "number", "description": "UTC Create Date in seconds.", "title": "Create_Date", "format": "double", "x-displayname": "Create Date.", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "title": "Mitigated Count Percentage", "format": "double", "x-displayname": "Mitigated Count Percentage.", "x-f5xc-example": "25.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_series": { "type": "array", "description": "Time Series Graph Data.", "title": "Time Series Graph Data", "items": { "$ref": "#/components/schemas/reportingTimeSeriesGraphData" }, "x-displayname": "Time Series Graph Data.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "The Trend of Credential Stuffing Attack.", "title": "Trend", "format": "double", "x-displayname": "Trend of Credential Stuffing Attack.", "x-f5xc-example": "\"13.4\" or null", "x-f5xc-description-short": "The Trend of Credential Stuffing Attack.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Credential Stuffing Attack.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingCredentialStuffingAttackResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingDistributionData": { "type": "object", "description": "Distribution Data.", "title": "DistributionData", "x-displayname": "Distribution Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.DistributionData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "WIN", "x-f5xc-example": "WIN", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "Percentage.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "10.1", "x-f5xc-example": "10.1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingDistributionData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointCategoryData": { "type": "object", "description": "Response that contains Endpoint Category Data.", "title": "Endpoint Category Data", "x-displayname": "Endpoint Category Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointCategoryData", "properties": { "action_distribution": { "type": "array", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "description": "Action or operation type", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category_label": { "type": "string", "description": "Flow Label or Flow Category.", "title": "x-displayName: \"Flow Label or Flow Category\"\nx-example: \"Login\"\nFlow Label or Flow Category", "x-displayname": "Flow Label or Flow Category.", "x-ves-example": "Login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_count": { "type": "string", "description": "Endpoint or connection point", "title": "x-displayName: \"Endpoint Count\"", "format": "uint64", "x-displayname": "Endpoint Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "event_count": { "type": "string", "description": "Event or occurrence data", "title": "x-displayName: \"Event Count\"", "format": "uint64", "x-displayname": "Event Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "event_percentage": { "type": "number", "description": "Event percentage.", "title": "percentage of total event", "format": "double", "x-displayname": "% of Total Events.", "x-ves-example": "10.7", "x-f5xc-example": "10.7", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_channel": { "type": "array", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "description": "Configuration parameter for traffic channel", "x-f5xc-description-short": "Configuration parameter for traffic channel.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_distribution": { "type": "array", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "description": "Configuration parameter for traffic distribution", "x-f5xc-description-short": "Configuration parameter for traffic distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Endpoint Category Data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointCategoryData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointCategoryResponse": { "type": "object", "description": "Response that contains Endpoint Data.", "title": "EndpointCategoryResponse", "x-displayname": "Endpoint Category Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointCategoryResponse", "properties": { "endpoint_categories": { "type": "array", "description": "Endpoint Category Data.", "title": "x-displayName: \"Endpoint Category Data\"\nx-example: \"\"\nEndpoint Category Data", "items": { "$ref": "#/components/schemas/reportingEndpointCategoryData" }, "x-displayname": "Endpoint Category Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_count": { "type": "string", "description": "Endpoint or connection point", "title": "x-displayName: \"Total Endpoint Count\"", "format": "uint64", "x-displayname": "Total Endpoint Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "event_count": { "type": "string", "description": "Event or occurrence data", "title": "x-displayName: \"Total Event Count\"", "format": "uint64", "x-displayname": "Total Event Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointCategoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointLabelsData": { "type": "object", "description": "Endpoint Labels Data.", "title": "Endpoint Labels Data", "x-displayname": "Endpoint Labels Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointLabelsData", "properties": { "endpointLabel": { "type": "string", "description": "Endpoint Label.", "title": "Endpoint Label", "x-displayname": "EndpointLabel.", "x-ves-example": "Logout", "x-f5xc-example": "Logout", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "requests": { "type": "string", "description": "Requests number for top Endpoint Labels.", "title": "Requests", "format": "uint64", "x-displayname": "Requests", "x-f5xc-example": "342", "x-f5xc-description-short": "Requests number for top Endpoint Labels.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointLabelsData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointListData": { "type": "object", "description": "Response that contains All Protected Endpoints Data.", "title": "EndpointListData", "x-displayname": "Endpoints Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointListData", "properties": { "application": { "type": "string", "description": "Application.", "title": "x-displayName: \"Application\"\nx-example: \"AppA\"\nApplication", "x-displayname": "Application.", "x-ves-example": "AppA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "category": { "type": "string", "description": "Flow Category.", "title": "x-displayName: \"Flow Category\"\nx-example: \"Authentication\"\nFlow Category", "x-displayname": "Flow Category.", "x-ves-example": "Authentication.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count": { "type": "string", "description": "Number of items or occurrences", "title": "x-displayName: \"Count\"", "format": "uint64", "x-displayname": "Count", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count_percentage": { "type": "number", "description": "Traffic percentage.", "title": "percentage of total traffic", "format": "double", "x-displayname": "% of Total Traffic.", "x-ves-example": "10.7", "x-f5xc-example": "10.7", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Domain", "title": "x-displayName: \"Domain\"", "x-displayname": "Domain", "x-ves-example": "target-us.com.", "x-f5xc-example": "target-us.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "endpoint": { "type": "string", "description": "Endpoint", "title": "x-displayName: \"Endpoint\"\nx-example: \"/media-resource/abcdef\"\nEndpoint", "x-displayname": "Endpoint", "x-ves-example": "/media-resource/abcdef.", "x-f5xc-example": "https://api.example.com/v1/users", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^https?://[^\\s/$.?#].[^\\s]*$", "format": "uri", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label": { "type": "string", "description": "Flow Label.", "title": "x-displayName: \"Flow Label\"\nx-example: \"Login\"\nFlow Label", "x-displayname": "Flow Label.", "x-ves-example": "Login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "labeling", "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains All Protected Endpoints Data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointListData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointListResponse": { "type": "object", "description": "Response that contains Endpoint Data.", "title": "EndpointListResponse", "x-displayname": "Endpoints Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointListResponse", "properties": { "endpoints": { "type": "array", "description": "Endpoints Response.", "title": "x-displayName: \"Endpoints Response\"\nx-example: \"\"\nEndpoints Response", "items": { "$ref": "#/components/schemas/reportingEndpointListData" }, "x-displayname": "Endpoints Response.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "api", "minItems": 0, "maxItems": 100, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointSummaryResponse": { "type": "object", "description": "Response that contains Endpoint Summary.", "title": "EndpointSummaryResponse", "x-displayname": "Endpoint Summary Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointSummaryResponse", "properties": { "total_applications": { "type": "string", "description": "Configuration parameter for total applications", "title": "Total number of Applications", "format": "uint64", "x-displayname": "The Total Number of Applications.", "x-f5xc-example": "8", "x-f5xc-description-short": "Configuration parameter for total applications.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_distinct_endpoints": { "type": "string", "description": "The number of distinct endpoints.", "title": "Total number of distinct Endpoints", "format": "uint64", "x-displayname": "The Total Number of distinct endpoints.", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Endpoint Summary.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEndpointSummaryResponseV2": { "type": "object", "description": "Response that contains Endpoint Summary with Unevaluated Transactions.", "title": "EndpointSummaryResponseV2", "x-displayname": "Endpoint Summary Response V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EndpointSummaryResponseV2", "properties": { "total_applications": { "type": "string", "description": "Configuration parameter for total applications", "title": "Total number of Applications", "format": "uint64", "x-displayname": "The Total Number of Applications.", "x-f5xc-example": "8", "x-f5xc-description-short": "Configuration parameter for total applications.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_distinct_endpoints": { "type": "string", "description": "The number of distinct endpoints.", "title": "Total number of distinct Endpoints", "format": "uint64", "x-displayname": "The Total Number of distinct endpoints.", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_unevaluated_transactions": { "type": "string", "description": "Action or operation type", "title": "Total number of Unevaluated Transactions", "format": "uint64", "x-displayname": "The Total Number of Unevaluated Transactions.", "x-f5xc-example": "8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Endpoint Summary with Unevaluated Transactions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEndpointSummaryResponseV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingEnterpriseConfigResponse": { "type": "object", "description": "Response for Enterprise Config.", "title": "Enterprise Config Response", "x-displayname": "Response for Enterprise Config.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.EnterpriseConfigResponse", "properties": { "eid": { "type": "string", "description": "Enterprise ID.", "title": "Enterprise ID", "maxLength": 1024, "x-displayname": "Enterprise ID.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "max_time_range_days": { "type": "integer", "description": "Max Time Range Days.", "title": "Max Time Range Days", "format": "int64", "x-displayname": "Max Time Range Days.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingEnterpriseConfigResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingFilterKey": { "type": "string", "description": "Key for query filter\n\n- TIMESTAMP: Timestamp Filter Key\n\nUse Timestamp as key to query.", "title": "Filter Key", "enum": [ "TIMESTAMP", "USERNAME", "CLIENT_TOKEN", "IP_ADDRESS", "ASN", "AS_ORGANIZATION", "COUNTRY", "METHOD", "HOST", "PATH", "URL", "REFERER", "TRAFFIC_CHANNEL", "IS_ATTACK", "BOT_REASON", "TRAFFIC_TYPE", "THREAT_TYPE", "SDK_VERSION", "ACTION_TAKEN", "COOKIE_AGE", "BOT_COOKIE", "USER_AGENT", "USER_AGENT_OS_FAMILY", "USER_AGENT_FAMILY", "BROWSER_FINGERPRINT", "USER_FINGERPRINT", "HEADER_FINGERPRINT", "DEVICE_ID", "FLOW", "AGENT", "APPLICATION_NAME", "PROTECTED_APPLICATION", "RESPONSE_CODE", "SERVER_RESPONSE_CODE", "TRANSACTION_RESULT", "MOBILE_TRANSACTION_INSIGHT", "WEB_TRANSACTION_INSIGHT", "TRIGGERED_RULE", "FLOW_CATEGORY", "FLOW_LABEL", "ENDPOINT_NAME", "ENDPOINT_LABEL", "BOT_ENDPOINT_POLICY", "KNOWN_BOT_NAME", "KNOWN_BOT_CATEGORY", "KNOWN_BOT_PROVIDER", "KNOWN_BOT_CATEGORY_TYPE", "KNOWN_BOT_MITIGATION", "ABSOLUTE", "PERCENTAGE", "TREND", "ENDPOINT_POLICY" ], "default": "TIMESTAMP", "x-displayname": "Filter Key.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.reporting.FilterKey", "x-f5xc-example": "TIMESTAMP", "x-f5xc-description-short": "Key for query filter - TIMESTAMP: Timestamp Filter Key Use Timestamp as key to query.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingFilterKey", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TIMESTAMP\"", "example_yaml": "TIMESTAMP\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingFilterOperator": { "type": "string", "description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values\n- MATCHES_REGEX: Filter Operator\n\nSpecifies that query result matches filter regex\n- DOES_NOT_MATCH_REGEX: Filter Operator\n\nSpecifies that query result not matches filter regex\n- INCLUDES: Filter Operator\n\nSpecifies that query result includes filter values\n- DOES_NOT_INCLUDE: Filter Operator\n\nSpecifies that query result not include filter values\n- STARTS_WITH: Filter Operator\n\nSpecifies that query result starts with filter values\n- ENDS_WITH: Filter Operator\n\nSpecifies that query result ends with filter values.", "title": "Filter Operator", "enum": [ "IN", "NOT_IN", "MATCHES_REGEX", "DOES_NOT_MATCH_REGEX", "INCLUDES", "DOES_NOT_INCLUDE", "STARTS_WITH", "ENDS_WITH" ], "default": "IN", "x-displayname": "Filter Operator.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.reporting.FilterOperator", "x-f5xc-example": "IN or NOT_IN", "x-f5xc-description-short": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query...", "x-f5xc-description-medium": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query result excludes filter values - MATCHES_REGEX: Filter Operator Specifies that query result matches filter regex - DOES_NOT_MATCH_REGEX: Filter...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingFilterOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IN or NOT_IN\"", "example_yaml": "IN or NOT_IN\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingFilters": { "type": "object", "description": "Reporting API query filters.", "title": "Filters", "x-displayname": "Filters", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.Filters", "properties": { "action_taken": { "allOf": [ { "$ref": "#/components/schemas/reportingActionTakenFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "app_id_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingAppIDFilter" } ], "x-f5xc-description-short": "Configuration parameter for app id filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "application_name": { "allOf": [ { "$ref": "#/components/schemas/reportingApplicationNameFilter" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "as_org_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingASOrgFilter" } ], "x-f5xc-description-short": "Configuration parameter for as org filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "attack_intent_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingAttackIntentFilter" } ], "x-f5xc-description-short": "Configuration parameter for attack intent filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automation_type_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingAutomationTypeFilter" } ], "x-f5xc-description-short": "Configuration parameter for automation type filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "browser_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingBrowserFilter" } ], "x-f5xc-description-short": "Configuration parameter for browser filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingCountryFilter" } ], "x-f5xc-description-short": "Configuration parameter for country filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "host_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingHostFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inference_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingInferenceFilter" } ], "x-f5xc-description-short": "Configuration parameter for inference filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingIPFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingMethodFilter" } ], "x-f5xc-description-short": "Configuration parameter for method filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingOSFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referer_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingRefererFilter" } ], "x-f5xc-description-short": "Configuration parameter for referer filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region_filter": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationBotDefenseRegion" } ], "x-f5xc-description-short": "Configuration parameter for region filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingTrafficTypeFilter" } ], "x-f5xc-description-short": "Configuration parameter for traffic type filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingUserAgentFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri_filter": { "allOf": [ { "$ref": "#/components/schemas/reportingURIFilter" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingFilters", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicAggregateType": { "type": "object", "description": "Forensic AggregateType fields.", "title": "ForensicAggregateType", "x-displayname": "Forensic AggregateType.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicAggregateType", "properties": { "count": { "type": "string", "description": "Forensic Aggregate Count.", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "42", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "percent": { "type": "number", "description": "Forensic Aggregate Percent.", "title": "Percent", "format": "double", "x-displayname": "Percent", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "value": { "type": "string", "description": "Forensic Aggregate Value.", "title": "Value", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicAggregateType", "required_fields": [ "count", "percent", "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"count\": \"42\",\n \"percent\": 0,\n \"value\": \"value\"\n}", "example_yaml": "count: '42'\npercent: 0\nvalue: value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicData": { "type": "object", "description": "Forensic Data.", "title": "ForensicData", "x-displayname": "Forensic Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicData", "properties": { "aggregate": { "type": "array", "description": "Optional\nForensic Aggregate Type.", "title": "Forensic Aggregate", "items": { "$ref": "#/components/schemas/reportingForensicAggregateType" }, "x-displayname": "Forensic Aggregate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "errors": { "allOf": [ { "$ref": "#/components/schemas/reportingForensicErrorType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterKey" } ], "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "mode": { "allOf": [ { "$ref": "#/components/schemas/reportingForensicModeTypes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "suggest": { "type": "array", "description": "Optional\nForensic Suggest Type.", "title": "Forensic Suggest", "items": { "$ref": "#/components/schemas/reportingForensicSuggestType" }, "x-displayname": "Forensic Suggest.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicErrorType": { "type": "object", "description": "Forensic ErrorType.", "title": "ForensicErrorType", "x-displayname": "Forensic ErrorType.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicErrorType", "properties": { "code": { "type": "string", "description": "Forensic Error Code.", "title": "Forensic Error Code", "format": "uint64", "x-displayname": "Forensic Error Code.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "message": { "type": "string", "description": "Forensic Error Message.", "title": "Forensic Error Message", "x-displayname": "Forensic Error Message.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicErrorType", "required_fields": [ "code", "message" ], "mutually_exclusive_groups": [], "example_json": "{\n \"code\": \"value\",\n \"message\": \"value\"\n}", "example_yaml": "code: value\nmessage: value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicField": { "type": "object", "description": "Forensic query field.", "title": "ForensicField", "x-displayname": "Forensic Field.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicField", "properties": { "key": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterKey" } ], "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "limit": { "type": "integer", "description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "100", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-example": "100", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...", "x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 500, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mode": { "allOf": [ { "$ref": "#/components/schemas/reportingForensicModeTypes" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/reportingForensicSortOption" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicFieldsRequest": { "type": "object", "description": "Request for Shape Bot Defense Forensic Fields.", "title": "ForensicFieldsRequest", "x-displayname": "Forensic Fields Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicFieldsRequest", "properties": { "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fields": { "type": "array", "description": "Additional fields for the query.", "title": "Fields", "items": { "$ref": "#/components/schemas/reportingForensicField" }, "x-displayname": "Fields", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingGlobalFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Namespace1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "namespace1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense Forensic Fields.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicFieldsRequest", "required_fields": [ "fields", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fields\": [\n {}\n ],\n \"namespace\": \"namespace1\"\n}", "example_yaml": "fields:\n- {}\nnamespace: namespace1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicFieldsResponse": { "type": "object", "description": "Response for Shape Bot Defense Forensic Fields.", "title": "ForensicFieldsResponse", "x-displayname": "Forensic Fields Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicFieldsResponse", "properties": { "fields": { "type": "array", "description": "Field specification or configuration", "title": "Response for Forensic Fields", "items": { "$ref": "#/components/schemas/reportingForensicData" }, "x-displayname": "Forensic Fields Details.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Shape Bot Defense Forensic Fields.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicFieldsResponse", "required_fields": [ "fields" ], "mutually_exclusive_groups": [], "example_json": "{\n \"fields\": [\n {}\n ]\n}", "example_yaml": "fields:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicModeTypes": { "type": "string", "description": "Forensic Mode Types\n\n- AGGREGATE: Aggregate Mode\n\nUse Aggregate Mode as key to query\n- SUGGEST: Suggest Mode\n\nUse Suggest Mode as key to query.", "title": "Forensic Mode Types", "enum": [ "AGGREGATE", "SUGGEST" ], "default": "AGGREGATE", "x-displayname": "Forensic Mode Types.", "x-ves-proto-enum": "ves.io.schema.shape.bot_defense.reporting.ForensicModeTypes", "x-f5xc-example": "aggregate", "x-f5xc-description-short": "Forensic Mode Types - AGGREGATE: Aggregate Mode Use Aggregate Mode as key to query - SUGGEST: Suggest Mode Use Suggest Mode as key to query.", "x-f5xc-description-medium": "Forensic Mode Types - AGGREGATE: Aggregate Mode Use Aggregate Mode as key to query - SUGGEST: Suggest Mode Use Suggest Mode as key to query.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicModeTypes", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"aggregate\"", "example_yaml": "aggregate\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicSortOption": { "type": "object", "description": "Query Result Forensic Sort Option.", "title": "Forensic Sort Option", "x-displayname": "Forensic Sort Option.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicSortOption", "properties": { "key": { "type": "string", "description": "Key to sort.", "title": "Sort Key", "x-displayname": "Sort Key", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "order": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicSortOption", "required_fields": [ "key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"key\": \"[REDACTED_PUBLIC_KEY]\"\n}", "example_yaml": "key: '[REDACTED_PUBLIC_KEY]'" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingForensicSuggestType": { "type": "object", "description": "Forensic SuggestType fields.", "title": "ForensicSuggestType", "x-displayname": "Forensic SuggestType.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ForensicSuggestType", "properties": { "value": { "type": "string", "description": "Forensic Suggest Value.", "title": "Value", "x-displayname": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingForensicSuggestType", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"value\"\n}", "example_yaml": "value: value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingGlobalFilter": { "type": "object", "description": "Query Global Filter.", "title": "Global Filter", "x-displayname": "Global Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.GlobalFilter", "properties": { "key": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterKey" } ], "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "An unordered list of filter strings.", "title": "Values", "minItems": 1, "maxItems": 64, "items": { "type": "string", "maxLength": 1024 }, "x-displayname": "Values", "x-ves-example": "['Google LLC', 'Facebook, Inc']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "1024", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Google LLC', 'Facebook, Inc']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "1024", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingGlobalFilter", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingGlobalFilters": { "type": "object", "description": "Query Global Filters.", "title": "Global Filters", "x-displayname": "Global Filters.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.GlobalFilters", "properties": { "global_filters": { "type": "array", "description": "List of global filters.", "title": "Filters", "items": { "$ref": "#/components/schemas/reportingGlobalFilter" }, "x-displayname": "Global Filters.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "region_filter": { "allOf": [ { "$ref": "#/components/schemas/protected_applicationBotDefenseRegion" } ], "x-f5xc-description-short": "Configuration parameter for region filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingGlobalFilters", "required_fields": [ "global_filters" ], "mutually_exclusive_groups": [], "example_json": "{\n \"global_filters\": [\n {\n \"values\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "global_filters:\n- values:\n - value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingHostFilter": { "type": "object", "description": "Query Filter by host filter strings.", "title": "Host Filter", "x-displayname": "Host Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.HostFilter", "properties": { "host_strings": { "type": "array", "description": "An list of strings.", "title": "Host Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Host Strings.", "x-ves-example": "['www.testhost.com']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['www.testhost.com']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingHostFilter", "required_fields": [ "host_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"host_strings\": [\n \"value\"\n ]\n}", "example_yaml": "host_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingHumanBrowserData": { "type": "object", "description": "Human Browser Data.", "title": "Human Browser Data", "x-displayname": "Human Browser Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.HumanBrowserData", "properties": { "browser": { "type": "string", "description": "Browser", "title": "Browser", "x-displayname": "Browser", "x-ves-example": "Chrome", "x-f5xc-example": "chrome", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingHumanBrowserData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingHumanDeviceData": { "type": "object", "description": "Human Device Data.", "title": "Human Device Data", "x-displayname": "Human Device Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.HumanDeviceData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device": { "type": "string", "description": "Device", "title": "Device", "x-displayname": "Device", "x-ves-example": "IPhone", "x-f5xc-example": "iPhone", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingHumanDeviceData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingHumanGeolocationData": { "type": "object", "description": "Human Geolocation Data.", "title": "Human Geolocation Data", "x-displayname": "Human Geolocation Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.HumanGeolocationData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count_percentage": { "type": "number", "description": "Count percentage for count / total human count.", "title": "Count percentage", "format": "double", "x-displayname": "Count percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Count percentage for count / total human count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flag_string": { "type": "string", "description": "The flag string for flag icon display.", "title": "Flag Icon String", "x-displayname": "Flag String.", "x-ves-example": "Flag_jp", "x-f5xc-example": "flag_jp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "geolocation": { "type": "string", "description": "Geolocation.", "title": "Geolocation", "x-displayname": "Geolocation.", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingHumanGeolocationData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingHumanPlatformData": { "type": "object", "description": "Human Platform Data.", "title": "Human Platform Data", "x-displayname": "Human Platform Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.HumanPlatformData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "platform": { "type": "string", "description": "Platform", "title": "Platform", "x-displayname": "Platform", "x-ves-example": "IOS", "x-f5xc-example": "iOS", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingHumanPlatformData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingIPFilter": { "type": "object", "description": "Query Filter by IP addresses.", "title": "IPFilter", "x-displayname": "IP Filter", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.IPFilter", "properties": { "ips": { "type": "array", "description": "An unordered list of IPv4 addresses.", "title": "IP Addresses", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "IP addresses.", "x-ves-example": "['192.0.2.103', '192.0.2.50']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['192.0.2.103', '192.0.2.50']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "minItems": 0, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingIPFilter", "required_fields": [ "ips" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ips\": [\n \"value\"\n ]\n}", "example_yaml": "ips:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingInferenceFilter": { "type": "object", "description": "Query Filter by Inference filter strings.", "title": "Inference Filter", "x-displayname": "Inference Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InferenceFilter", "properties": { "inference_strings": { "type": "array", "description": "An list of strings.", "title": "Inference Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Inference Strings.", "x-ves-example": "['Good Bot']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Good Bot']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by Inference filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingInferenceFilter", "required_fields": [ "inference_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"inference_strings\": [\n \"value\"\n ]\n}", "example_yaml": "inference_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingInsightBadBotReductionResponse": { "type": "object", "description": "Insight Bad Bot Reduction Response.", "title": "Insight Bad Bot Reduction Response", "x-displayname": "Insight Bad Bot Reduction Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightBadBotReductionResponse", "properties": { "create_date": { "type": "number", "description": "UTC Create Date in seconds.", "title": "Create Date", "format": "double", "x-displayname": "Create Date.", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reduction": { "type": "number", "description": "Reduction", "title": "Reduction", "format": "double", "x-displayname": "Reduction", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_series_data": { "type": "array", "description": "Time Series Data.", "title": "Time Series Data", "items": { "$ref": "#/components/schemas/reportingTimeSeriesDataV2" }, "x-displayname": "Time Series Data.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingInsightBadBotReductionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingInsightPersonalStatsResponse": { "type": "object", "description": "Insight Personal Stats Response.", "title": "Insight Personal Stats Response", "x-displayname": "Insight Personal Stats Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightPersonalStatsResponse", "properties": { "bots": { "type": "string", "description": "Configuration parameter for bots", "title": "Bots", "format": "uint64", "x-displayname": "Bots", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human": { "type": "string", "description": "Configuration parameter for human", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "200", "x-f5xc-example": "200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingInsightPersonalStatsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingInsightRequest": { "type": "object", "description": "Insight Request.", "title": "Insight Request", "x-displayname": "Insight Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightRequest", "properties": { "date": { "type": "string", "description": "Date\nFormat: YYYY/MM/DD.", "title": "Date", "x-displayname": "Date", "x-ves-example": "2023/03/01.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "2023/03/01", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 10, "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "format": "date", "formatDescription": "ISO 8601 date (e.g., 2026-01-19)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Default", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "default", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "region": { "type": "string", "description": "Region", "title": "Region", "x-displayname": "Region", "x-ves-example": "US", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "US", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingInsightRequest", "required_fields": [ "date", "namespace", "region" ], "mutually_exclusive_groups": [], "example_json": "{\n \"date\": \"2023/03/01\",\n \"namespace\": \"default\",\n \"region\": \"US\"\n}", "example_yaml": "date: 2023/03/01\nnamespace: default\nregion: US" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingInsightUnaddressedAutomationsResponse": { "type": "object", "description": "Insight Unaddressed Automations Response.", "title": "Insight Unaddressed Automations Response", "x-displayname": "Insight Unaddressed Automations Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.InsightUnaddressedAutomationsResponse", "properties": { "bad_bots": { "type": "number", "description": "Bad Bots", "title": "Bad Bots", "format": "double", "x-displayname": "Bad Bots", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "create_date": { "type": "number", "description": "UTC Create Date in seconds.", "title": "Create Date", "format": "double", "x-displayname": "Create Date.", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_endpoints": { "type": "string", "description": "Flagged Endpoints.", "title": "Flagged Endpoints", "format": "uint64", "x-displayname": "Flagged Endpoints.", "x-ves-example": "200", "x-f5xc-example": "200", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unaddressed": { "type": "number", "description": "Unaddressed.", "title": "Unaddressed", "format": "double", "x-displayname": "Unaddressed.", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Insight Unaddressed Automations Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingInsightUnaddressedAutomationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotCategoriesOverTimeResponse": { "type": "object", "description": "Time Series of Known Bot Transactions Grouped by Known Bot Category.", "title": "Known Bot Categories Over Time Response", "x-displayname": "Known Bot Categories Over Time Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotCategoriesOverTimeResponse", "properties": { "known_bot_category_time_series_data": { "type": "array", "description": "Transactions per known bot category over time distribution.", "title": "Known Bot Category Time Series Data", "items": { "$ref": "#/components/schemas/reportingKnownBotCategoryTimeSeries" }, "x-displayname": "Known Bot Category Time Series Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Transactions per known bot category over time distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Time Series of Known Bot Transactions Grouped by Known Bot Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotCategoriesOverTimeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotCategoryTimeSeries": { "type": "object", "title": "Known Bot Category Time Series", "x-displayname": "Known Bot Category Time Series.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotCategoryTimeSeries", "properties": { "known_bot_category": { "type": "string", "description": "Configuration parameter for known bot category", "title": "Known Bot Category", "x-displayname": "Known Bot Category.", "x-ves-example": "Web Crawler.", "x-f5xc-example": "Web Crawler", "x-f5xc-description-short": "Configuration parameter for known bot category.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_series": { "type": "array", "description": "Time series data for this known bot category.", "title": "Time Series", "items": { "$ref": "#/components/schemas/reportingKnownBotTimeSeriesPoint" }, "x-displayname": "Time Series.", "x-f5xc-description-short": "Time series data for this known bot category.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_absolute": { "type": "string", "description": "Total transactions for this category over the requested time range.", "title": "Total Absolute", "format": "uint64", "x-displayname": "Total Absolute.", "x-f5xc-example": "4000", "x-f5xc-description-short": "Total transactions for this category over the requested time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotCategoryTimeSeries", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotDistribution": { "type": "object", "description": "Known Bot Distribution.", "title": "Known Bot Distribution", "x-displayname": "Known Bot Distribution.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotDistribution", "properties": { "absolute": { "type": "string", "description": "Configuration parameter for absolute", "title": "Absolute", "format": "uint64", "x-displayname": "Absolute", "x-ves-example": "4000", "x-f5xc-example": "4000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_sentiment": { "type": "string", "description": "The sentiment for the trend of known bot traffic.", "title": "Known Bot Sentiment", "x-displayname": "Known Bot Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of known bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "Block", "x-f5xc-example": "Block", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "Tag for categorization and filtering", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "80.0", "x-f5xc-example": "80.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "Trend", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "0.3 or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotDistribution", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotEndpointResponse": { "type": "object", "description": "Known Bot Endpoint Response.", "title": "Known Bot Endpoint Response", "x-displayname": "Known Bot Endpoint Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotEndpointResponse", "properties": { "known_bot_endpoints": { "type": "array", "description": "Known Bot Endpoints.", "title": "Known Bot Endpoints", "items": { "$ref": "#/components/schemas/reportingKnownBotEndpoints" }, "x-displayname": "Known Bot Endpoints.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/reportingPaginationInfo" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotEndpointResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotEndpoints": { "type": "object", "description": "Known Bot Endpoints.", "title": "Known Bot Endpoints", "x-displayname": "Known Bot Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotEndpoints", "properties": { "absolute": { "type": "string", "description": "Configuration parameter for absolute", "title": "Absolute", "format": "uint64", "x-displayname": "Absolute", "x-ves-example": "4000", "x-f5xc-example": "4000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339.", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_label": { "type": "string", "description": "Endpoint or connection point", "title": "Endpoint Label\nx-displayName: \"Endpoint Label\"\nx-example: \"Login Page\"", "x-displayname": "Endpoint Label.", "x-ves-example": "Login Page.", "x-f5xc-example": "Login Page", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Endpoint Name\nx-displayName: \"Endpoint Name\"\nx-example: \"/login\"", "x-displayname": "Endpoint Name.", "x-ves-example": "/login", "x-f5xc-example": "/login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_policy": { "type": "string", "description": "Endpoint or connection point", "title": "Endpoint Policy\nx-displayName: \"Endpoint Policy\"\nx-example: \"Protect\"", "x-displayname": "Endpoint Policy.", "x-ves-example": "Protect", "x-f5xc-example": "Protect", "x-f5xc-description-short": "Policy configuration for this feature.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_category": { "type": "string", "description": "Configuration parameter for known bot category", "title": "Known Bot Category\nx-displayName: \"Known Bot Category\"\nx-example: \"Search Engine Crawler\"", "x-displayname": "Known Bot Category.", "x-ves-example": "Search Engine Crawler.", "x-f5xc-example": "Search Engine Crawler", "x-f5xc-description-short": "Configuration parameter for known bot category.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_name": { "type": "string", "description": "Human-readable name for the resource", "title": "Known Bot Name\nx-displayName: \"Known Bot Name\"\nx-example: \"Googlebot\"", "x-displayname": "Known Bot Name.", "x-ves-example": "Googlebot", "x-f5xc-example": "Googlebot", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_provider": { "type": "string", "description": "Configuration parameter for known bot provider", "title": "Known Bot Provider\nx-displayName: \"Known Bot Provider\"\nx-example: \"Google LLC\"", "x-displayname": "Known Bot Provider.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "x-f5xc-description-short": "Configuration parameter for known bot provider.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "known_bot_sentiment": { "type": "string", "description": "The sentiment for the trend of known bot traffic.", "title": "Known Bot Sentiment", "x-displayname": "Known Bot Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of known bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "Tag for categorization and filtering", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "80.0", "x-f5xc-example": "80.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_action_distribution": { "type": "array", "description": "Traffic Action Distribution.", "title": "Traffic Action Distribution\nx-displayName: \"Traffic Action Distribution\"\nTraffic Action Distribution", "items": { "$ref": "#/components/schemas/reportingKnownBotGenericMetric" }, "x-displayname": "Traffic Action Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "Trend", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "0.3 or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotEndpoints", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotGenericMetric": { "type": "object", "description": "Known Bot Generic Metric.", "title": "Known Bot Generic Metric", "x-displayname": "Known Bot Generic Metric.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotGenericMetric", "properties": { "absolute": { "type": "string", "description": "Configuration parameter for absolute", "title": "Absolute", "format": "uint64", "x-displayname": "Absolute", "x-ves-example": "4000", "x-f5xc-example": "4000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "Block", "x-f5xc-example": "Block", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "Tag for categorization and filtering", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "80.0", "x-f5xc-example": "80.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotGenericMetric", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotOverviewStatisticsResponse": { "type": "object", "description": "Response containing overview statistics for known bot traffic.", "title": "Known Bot Overview Statistics Response", "x-displayname": "Known Bot Overview Statistics Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotOverviewStatisticsResponse", "properties": { "distinct_ai_bots": { "type": "string", "description": "Distinct AI bot entities observed in the selected time range.", "title": "Distinct AI Bots", "format": "uint64", "x-displayname": "Distinct AI Bots.", "x-f5xc-description-short": "Distinct AI bot entities observed in the selected time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_ai_bots_sentiment": { "type": "string", "description": "Trend sentiment indicator for distinct AI bots.", "title": "Distinct AI Bots Sentiment", "x-displayname": "Distinct AI Bots Sentiment.", "x-f5xc-description-short": "Trend sentiment indicator for distinct AI bots.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_ai_bots_trend": { "type": "number", "description": "Percentage change of distinct AI bots versus the previous period.", "title": "Distinct AI Bots Trend", "format": "double", "x-displayname": "Distinct AI Bots Trend.", "x-f5xc-description-short": "Percentage change of distinct AI bots versus the previous period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_categories": { "type": "string", "description": "Distinct known-bot categories observed in the selected time range.", "title": "Distinct Categories", "format": "uint64", "x-displayname": "Distinct Categories.", "x-f5xc-description-short": "Distinct known-bot categories observed in the selected time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_categories_sentiment": { "type": "string", "description": "Trend sentiment indicator for distinct categories.", "title": "Distinct Categories Sentiment", "x-displayname": "Distinct Categories Sentiment.", "x-f5xc-description-short": "Trend sentiment indicator for distinct categories.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_categories_trend": { "type": "number", "description": "Percentage change of distinct categories versus the previous period.", "title": "Distinct Categories Trend", "format": "double", "x-displayname": "Distinct Categories Trend.", "x-f5xc-description-short": "Percentage change of distinct categories versus the previous period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_known_bots": { "type": "string", "description": "Distinct known bot entities observed in the selected time range.", "title": "Distinct Known Bots", "format": "uint64", "x-displayname": "Distinct Known Bots.", "x-f5xc-description-short": "Distinct known bot entities observed in the selected time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_known_bots_sentiment": { "type": "string", "description": "Trend sentiment indicator for distinct known bots.", "title": "Distinct Known Bots Sentiment", "x-displayname": "Distinct Known Bots Sentiment.", "x-f5xc-description-short": "Trend sentiment indicator for distinct known bots.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_known_bots_trend": { "type": "number", "description": "Percentage change of distinct known bots versus the previous period.", "title": "Distinct Known Bots Trend", "format": "double", "x-displayname": "Distinct Known Bots Trend.", "x-f5xc-description-short": "Percentage change of distinct known bots versus the previous period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_ai_transactions": { "type": "string", "description": "Total AI bot transactions in the selected time range.", "title": "Total AI Transactions", "format": "uint64", "x-displayname": "Total AI Transactions.", "x-f5xc-description-short": "Total AI bot transactions in the selected time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_ai_transactions_sentiment": { "type": "string", "description": "Trend sentiment indicator for AI bot transactions.", "title": "Total AI Transactions Sentiment", "x-displayname": "Total AI Transactions Sentiment.", "x-f5xc-description-short": "Trend sentiment indicator for AI bot transactions.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_ai_transactions_trend": { "type": "number", "description": "Percentage change of AI bot transactions versus the previous period.", "title": "Total AI Transactions Trend", "format": "double", "x-displayname": "Total AI Transactions Trend.", "x-f5xc-description-short": "Percentage change of AI bot transactions versus the previous period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_distinct_ai_bots": { "type": "string", "description": "Total distinct AI bot count.", "title": "Total Distinct AI Bots", "format": "uint64", "x-displayname": "Total Distinct AI Bots.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_distinct_categories": { "type": "string", "description": "Total distinct known-bot category count.", "title": "Total Distinct Categories", "format": "uint64", "x-displayname": "Total Distinct Categories.", "x-f5xc-description-short": "Total distinct known-bot category count.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_distinct_known_bots": { "type": "string", "description": "Total distinct known bot count.", "title": "Total Distinct Known Bots", "format": "uint64", "x-displayname": "Total Distinct Known Bots.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_transactions": { "type": "string", "description": "Total known bot transactions in the selected time range.", "title": "Total Transactions", "format": "uint64", "x-displayname": "Total Transactions.", "x-f5xc-description-short": "Total known bot transactions in the selected time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_transactions_sentiment": { "type": "string", "description": "Trend sentiment indicator for total transactions.", "title": "Total Transactions Sentiment", "x-displayname": "Total Transactions Sentiment.", "x-f5xc-description-short": "Trend sentiment indicator for total transactions.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_transactions_trend": { "type": "number", "description": "Percentage change of total known bot transactions versus the previous period.", "title": "Total Transactions Trend", "format": "double", "x-displayname": "Total Transactions Trend.", "x-f5xc-description-short": "Percentage change of total known bot transactions versus the previous period.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response containing overview statistics for known bot traffic.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotOverviewStatisticsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotRequest": { "type": "object", "description": "Known Bot Request.", "title": "Known Bot Request", "x-displayname": "Known Bot Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotRequest", "properties": { "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570197600", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingGlobalFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...", "x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/reportingPagination" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_metrics": { "type": "array", "description": "Optional, list of metric identifiers to retrieve.", "title": "Request Metrics", "items": { "type": "string" }, "x-displayname": "Request Metrics.", "x-f5xc-description-short": "Optional, list of metric identifiers to retrieve.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_options": { "type": "array", "description": "Sort OPTIONS for the query result. If unspecified, sort is by\ncount, in descending order.", "title": "Sort Option", "items": { "$ref": "#/components/schemas/reportingSortOption" }, "x-displayname": "Sort", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_bucket_size": { "type": "string", "description": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.\n\nOptional: If specified, timeseries style APIs should use this as the bucket size.\nIf not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.", "title": "Time Bucket Size", "x-displayname": "Time Bucket Size.", "x-ves-example": "PT1H", "x-f5xc-example": "PT1H", "x-f5xc-description-short": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day.", "x-f5xc-description-medium": "ISO 8601 duration, e.g. \"PT5M\" = 5 minutes, \"PT1H\" = 1 hour, \"P1D\" = 1 day. Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotTimeSeriesPoint": { "type": "object", "description": "Time Series Point for a Known Bot Category.", "title": "Known Bot Time Series Point", "x-displayname": "Known Bot Time Series Point.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotTimeSeriesPoint", "properties": { "absolute": { "type": "string", "description": "Transactions count within this time bucket.", "title": "Absolute", "format": "uint64", "x-displayname": "Absolute", "x-f5xc-description-short": "Transactions count within this time bucket.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "Percentage of this category within this time bucket.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-description-short": "Percentage of this category within this time bucket.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transaction_timestamp": { "type": "string", "description": "Unix time (seconds since 1970-01-01 UTC)", "title": "Transaction Timestamp", "format": "uint64", "x-displayname": "Transaction Timestamp.", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-description-short": "Unix time (seconds since 1970-01-01 UTC).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Time Series Point for a Known Bot Category.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotTimeSeriesPoint", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingKnownBotTransactionsPerCategoryResponse": { "type": "object", "description": "Known Bot Transactions Per Category Response.", "title": "Known Bot Transactions Per Category Response", "x-displayname": "Known Bot Transactions Per Category Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.KnownBotTransactionsPerCategoryResponse", "properties": { "known_bot_category_distribution": { "type": "array", "description": "Known Bot Category Distribution.", "title": "Known Bot Category Distribution", "items": { "$ref": "#/components/schemas/reportingKnownBotDistribution" }, "x-displayname": "Known Bot Category Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Known Bot Transactions Per Category Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingKnownBotTransactionsPerCategoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotASOrgData": { "type": "object", "description": "Malicious Bot ASOrg Data.", "title": "Malicious Bot ASOrg Data", "x-displayname": "Malicious Bot ASOrg Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotASOrgData", "properties": { "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_ip_count": { "type": "string", "description": "The number of distinct IP addresses corresponding to the AS number.", "title": "Distinct IP count", "format": "uint64", "x-displayname": "Distinct IP Count.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "The number of distinct IP addresses corresponding to the AS number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_request_count": { "type": "string", "description": "Number of HTTP requests identified as human.", "title": "Human Request Count", "format": "uint64", "x-displayname": "Human Request Count.", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of HTTP requests identified as human.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotASOrgData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotASOrgDataV3": { "type": "object", "description": "Malicious Bot ASOrg Data with action distribution.", "title": "Malicious Bot ASOrg Data V3", "x-displayname": "Malicious Bot ASOrg Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotASOrgDataV3", "properties": { "actions": { "type": "array", "description": "Endpoint Traffic Actions.", "title": "Endpoint Traffic Actions", "items": { "$ref": "#/components/schemas/reportingActionData" }, "x-displayname": "Endpoint Traffic Actions.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "distinct_ip_count": { "type": "string", "description": "The number of distinct IP addresses corresponding to the AS number.", "title": "Distinct IP count", "format": "uint64", "x-displayname": "Distinct IP Count.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "The number of distinct IP addresses corresponding to the AS number.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Bot ASOrg Data with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotASOrgDataV3", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotAppData": { "type": "object", "description": "Malicious Bot per App Data.", "title": "Malicious Bot per Application Data", "x-displayname": "Malicious Bot per Application Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotAppData", "properties": { "app_sentiment": { "type": "string", "description": "The sentiment for the trend of malicious bot traffic per application.", "title": "Trend Sentiment", "x-displayname": "Trend Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of malicious bot traffic per application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "application": { "type": "string", "description": "Application Name.", "title": "Application Name", "x-displayname": "Application Name.", "x-ves-example": "App A", "x-f5xc-example": "app A", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot per application.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot per application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests per application in total malicious request.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests per application in total malicious request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_trend": { "type": "number", "description": "The trend of malicious bot requests per application.", "title": "Malicious Bot Request Trend", "format": "double", "x-displayname": "Malicious Bot Request Trend.", "x-f5xc-example": "-23.5 or null", "x-f5xc-description-short": "The trend of malicious bot requests per application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotAppData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotAttackIntentASOrgData": { "type": "object", "title": "Malicious Bot Event of Attack Intent by ASOrg Data", "x-displayname": "Malicious Bot Event of Attack Intent by ASOrg Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentASOrgData", "properties": { "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_count": { "type": "string", "description": "Number of total Malicious Bot HTTP requests.", "title": "Malicious Bot Count", "format": "uint64", "x-displayname": "Events", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of total Malicious Bot HTTP requests.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_percentage": { "type": "number", "description": "The percentage of traffic requests by as_org / total requests.", "title": "Taffic Event Count Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of traffic requests by as_org / total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_distribution": { "type": "array", "description": "Taffic details for Attack Intent Distribution.", "title": "Attack Intent Distribution", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Traffic Details.", "x-f5xc-description-short": "Taffic details for Attack Intent Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotAttackIntentASOrgData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotAttackIntentIPData": { "type": "object", "title": "Malicious Bot Event of Attack Intent by IP Data", "x-displayname": "Malicious Bot Event of Attack Intent by IP Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentIPData", "properties": { "as_org": { "type": "string", "description": "Configuration parameter for as org", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_count": { "type": "string", "description": "Number of total Malicious Bot HTTP requests.", "title": "Malicious Bot Count", "format": "uint64", "x-displayname": "Events", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of total Malicious Bot HTTP requests.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_percentage": { "type": "number", "description": "The percentage of traffic requests by source IP / total requests.", "title": "Taffic Event Count Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of traffic requests by source IP / total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Geolocation.", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "Source IP data.", "title": "IP Address", "x-displayname": "Source IP", "x-ves-example": "192.0.2.103.", "x-f5xc-example": "192.0.2.103", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_distribution": { "type": "array", "description": "Taffic details for Attack Intent Distribution.", "title": "Attack Intent Distribution", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Traffic Details.", "x-f5xc-description-short": "Taffic details for Attack Intent Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotAttackIntentIPData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotAttackIntentUAData": { "type": "object", "title": "Malicious Bot Event of Attack Intent by UA Data", "x-displayname": "Malicious Bot Event of Attack Intent by User Agent Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotAttackIntentUAData", "properties": { "bad_bot_count": { "type": "string", "description": "Number of total Malicious Bot HTTP requests.", "title": "Malicious Bot Count", "format": "uint64", "x-displayname": "Events", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of total Malicious Bot HTTP requests.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bad_bot_percentage": { "type": "number", "description": "The percentage of traffic requests by as_org / total requests.", "title": "Taffic Event Count Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of traffic requests by as_org / total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "browser": { "type": "string", "description": "Browser name.", "title": "Browser", "x-displayname": "Browser", "x-ves-example": "Firefox", "x-f5xc-example": "Firefox", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_distribution": { "type": "array", "description": "Taffic details for Attack Intent Distribution.", "title": "Attack Intent Distribution", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Traffic Details.", "x-f5xc-description-short": "Taffic details for Attack Intent Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua": { "type": "string", "description": "User Agent String.", "title": "User Agent String", "x-displayname": "User Agent String.", "x-ves-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0.", "x-f5xc-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotAttackIntentUAData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotIPData": { "type": "object", "description": "Malicious Bot IP Data.", "title": "Malicious Bot IP Data", "x-displayname": "Malicious Bot IP Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotIPData", "properties": { "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_request_count": { "type": "string", "description": "Number of HTTP requests identified as human.", "title": "Human Request Count", "format": "uint64", "x-displayname": "Human Request Count.", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of HTTP requests identified as human.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.103.", "x-f5xc-example": "192.0.2.103", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotIPData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotIPDataV3": { "type": "object", "description": "Malicious Bot IP Data with action distribution.", "title": "Malicious Bot IP Data V3", "x-displayname": "Malicious Bot IP Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotIPDataV3", "properties": { "actions": { "type": "array", "description": "Endpoint Traffic Actions.", "title": "Endpoint Traffic Actions", "items": { "$ref": "#/components/schemas/reportingActionData" }, "x-displayname": "Endpoint Traffic Actions.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.103.", "x-f5xc-example": "192.0.2.103", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Bot IP Data with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotIPDataV3", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotUAData": { "type": "object", "description": "Malicious bot user agent data.", "title": "Malicious Bot User Agent Data", "x-displayname": "Malicious Bot User Agent Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotUAData", "properties": { "browser": { "type": "string", "description": "Browser name.", "title": "Browser", "x-displayname": "Browser", "x-ves-example": "Firefox", "x-f5xc-example": "Firefox", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_request_count": { "type": "string", "description": "Number of HTTP requests identified as human.", "title": "Human Request Count", "format": "uint64", "x-displayname": "Human Request Count.", "x-ves-example": "20000", "x-f5xc-example": "20000", "x-f5xc-description-short": "Number of HTTP requests identified as human.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua": { "type": "string", "description": "User Agent String.", "title": "User Agent String", "x-displayname": "User Agent String.", "x-ves-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0.", "x-f5xc-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotUAData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousBotUADataV4": { "type": "object", "description": "Malicious bot user agent data with action distribution.", "title": "Malicious Bot User Agent Data V4", "x-displayname": "Malicious Bot User Agent Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousBotUADataV4", "properties": { "actions": { "type": "array", "description": "Endpoint Traffic Actions.", "title": "Endpoint Traffic Actions", "items": { "$ref": "#/components/schemas/reportingActionData" }, "x-displayname": "Endpoint Traffic Actions.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "browser": { "type": "string", "description": "Browser name.", "title": "Browser", "x-displayname": "Browser", "x-ves-example": "Firefox", "x-f5xc-example": "Firefox", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_count": { "type": "string", "description": "Number of HTTP requests identified as malicious bot.", "title": "Malicious Bot Request Count", "format": "uint64", "x-displayname": "Malicious Bot Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_request_percentage": { "type": "number", "description": "The percentage of malicious bot requests in total requests.", "title": "Malicious Bot Request Percentage", "format": "double", "x-displayname": "Malicious Bot Request Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-description-short": "The percentage of malicious bot requests in total requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_percentage": { "type": "number", "description": "Total Percentage.", "title": "Total Percentage", "format": "double", "x-displayname": "Total Percentage.", "x-ves-example": "94.6", "x-f5xc-example": "94.6", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua": { "type": "string", "description": "User Agent String.", "title": "User Agent String", "x-displayname": "User Agent String.", "x-ves-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0.", "x-f5xc-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious bot user agent data with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousBotUADataV4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportAPPData": { "type": "object", "description": "Malicious Report APP Data.", "title": "Malicious Report APP Data", "x-displayname": "Malicious Report APP Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPData", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "App", "x-f5xc-example": "app", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "percentage": { "type": "number", "description": "Percentage.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "50.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_series": { "type": "array", "description": "APP Time Series.", "title": "APP Time Series", "items": { "$ref": "#/components/schemas/reportingMaliciousReportAPPTimeSeries" }, "x-displayname": "APP Time Series.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "type": "string", "description": "Configuration parameter for total", "title": "Total", "format": "uint64", "x-displayname": "Total", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportAPPData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportAPPTimeSeries": { "type": "object", "description": "Malicious Report APP Time Series.", "title": "Malicious Report APP Time Series", "x-displayname": "Malicious Report APP Time Series.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPTimeSeries", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "Percentage.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "50.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_count": { "type": "string", "description": "Total Count.", "title": "Total Count", "format": "uint64", "x-displayname": "Total Count.", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportAPPTimeSeries", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportAPPTimeSeriesResponse": { "type": "object", "description": "Malicious Report APP Time Series Response.", "title": "MaliciousReportAPPTimeSeriesResponse", "x-displayname": "Malicious Report APP Time Series Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportAPPTimeSeriesResponse", "properties": { "app_data": { "type": "array", "description": "App Data", "title": "App Data", "items": { "$ref": "#/components/schemas/reportingMaliciousReportAPPData" }, "x-displayname": "App Data", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Report APP Time Series Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportAPPTimeSeriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportEndpointData": { "type": "object", "description": "Malicious Report Endpoint Data.", "title": "MaliciousReportEndpointData", "x-displayname": "Malicious Report Endpoint Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportEndpointData", "properties": { "base_path": { "type": "string", "description": "Base Path", "title": "Base Path", "x-displayname": "Base Path", "x-ves-example": "/", "x-f5xc-example": "/", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "collapsed_url": { "type": "string", "description": "Collapsed URL.", "title": "Collapsed URL", "x-displayname": "Collapsed URL.", "x-ves-example": "/test/test.", "x-f5xc-example": "/test/test", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "leaves_count": { "type": "string", "description": "Number of leaves.", "title": "Leaves Count", "format": "uint64", "x-displayname": "Leaves Count.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "level": { "type": "string", "description": "Endpoint level.", "title": "Level", "format": "uint64", "x-displayname": "Endpoint level.", "x-ves-example": "2", "x-f5xc-example": "2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method": { "type": "string", "description": "Method", "title": "Method", "x-displayname": "Method", "x-ves-example": "GET", "x-f5xc-example": "GET", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the endpoint.", "title": "Name", "x-displayname": "Name", "x-ves-example": "/test", "x-f5xc-example": "/test", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "parent": { "type": "string", "description": "Parent endpoint.", "title": "Parent", "x-displayname": "Parent endpoint.", "x-ves-example": "/root", "x-f5xc-example": "/root", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "Percentage of the endpoint.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_percentage": { "type": "number", "description": "Request Percentage.", "title": "Request Percentage", "format": "double", "x-displayname": "Request Percentage.", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportEndpointData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportEndpointsResponse": { "type": "object", "description": "Malicious Report Endpoints Response.", "title": "MaliciousReportEndpointsResponse", "x-displayname": "Malicious Report Endpoints Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportEndpointsResponse", "properties": { "endpoint_data": { "type": "array", "description": "Malicious Report Endpoints Response.", "title": "Malicious Report Endpoints Response", "items": { "$ref": "#/components/schemas/reportingMaliciousReportEndpointData" }, "x-displayname": "Malicious Report Endpoints Response.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportEndpointsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportTransactionsData": { "type": "object", "description": "Malicious Report Transactions Data.", "title": "MaliciousReportTransactionsData", "x-displayname": "Malicious Report Transactions Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportTransactionsData", "properties": { "ASN": { "type": "string", "description": "Configuration parameter for ASN", "title": "ASN", "format": "uint64", "x-displayname": "ASN", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "BFP": { "type": "string", "description": "Configuration parameter for BFP", "title": "BFP", "format": "uint64", "x-displayname": "BFP", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "HFP": { "type": "string", "description": "Configuration parameter for HFP", "title": "HFP", "format": "uint64", "x-displayname": "HFP", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "IP": { "type": "string", "description": "Configuration parameter for IP", "title": "IP", "format": "uint64", "x-displayname": "IP", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "UFP": { "type": "string", "description": "Configuration parameter for UFP", "title": "UFP", "format": "uint64", "x-displayname": "UFP", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "attack_intent_distribution": { "type": "array", "description": "Attack Intent Distribution.", "title": "Attack Intent Distribution", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Attack Intent Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "WIN", "x-f5xc-example": "WIN", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "reason_code_distribution": { "type": "array", "description": "Reason Code Distribution.", "title": "Reason Code Distribution", "items": { "$ref": "#/components/schemas/reportingDistributionData" }, "x-displayname": "Bad Bot Reason Code Distribution.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_agent": { "type": "string", "description": "User Agent.", "title": "User Agent", "format": "uint64", "x-displayname": "User Agent.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportTransactionsData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousReportTransactionsResponse": { "type": "object", "description": "Malicious Report Transactions Response.", "title": "MaliciousReportTransactionsResponse", "x-displayname": "Malicious Report Transactions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousReportTransactionsResponse", "properties": { "malicious_bot": { "type": "array", "description": "Malicious Report Transactions Response.", "title": "Malicious Report Transactions Response", "items": { "$ref": "#/components/schemas/reportingMaliciousReportTransactionsData" }, "x-displayname": "Malicious Report Transactions Response.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousReportTransactionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficOverviewActionsResponse": { "type": "object", "description": "Malicious Bot Taffic Overview in Actions Response.", "title": "MaliciousTrafficOverviewActionsResponse", "x-displayname": "Malicious Bot Taffic Overview in Actions.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewActionsResponse", "properties": { "flagged_count": { "type": "string", "description": "The total number of malicious bot traffic in flagged.", "title": "Flagged Count", "format": "uint64", "x-displayname": "Flagged Count.", "x-f5xc-example": "43", "x-f5xc-description-short": "The total number of malicious bot traffic in flagged.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "title": "Flagged Count Percentage", "format": "double", "x-displayname": "Flagged Count Percentage.", "x-f5xc-example": "43.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_previous": { "type": "string", "description": "The total number of malicious bot traffic in flagged within the previous specified time interval.", "title": "Flagged count in the previous time interval", "format": "uint64", "x-displayname": "Flagged Count in last X days.", "x-f5xc-example": "34", "x-f5xc-description-short": "The total number of malicious bot traffic in flagged within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_sentiment": { "type": "string", "description": "The sentiment for the trend of malicious traffic in flagged.", "title": "Flagged Sentiment", "x-displayname": "Flagged Sentiment.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "The sentiment for the trend of malicious traffic in flagged.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_trend": { "type": "number", "description": "Trend of the number of malicious bot traffic in flagged.", "title": "Flagged Trend", "format": "double", "x-displayname": "Flagged Trend.", "x-f5xc-example": "0.4 or null", "x-f5xc-description-short": "Trend of the number of malicious bot traffic in flagged.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_count": { "type": "string", "description": "The total number of malicious bot traffic in mitigated.", "title": "Mitigated Count", "format": "uint64", "x-displayname": "Mitigated Count.", "x-f5xc-example": "24", "x-f5xc-description-short": "The total number of malicious bot traffic in mitigated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "title": "Mitigated Count Percentage", "format": "double", "x-displayname": "Mitigated Count Percentage.", "x-f5xc-example": "25.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_previous": { "type": "string", "description": "The total number of malicious bot traffic in mitigated within the previous specified time interval.", "title": "Mitigated count in the previous time interval", "format": "uint64", "x-displayname": "Mitigated Count in last X days.", "x-f5xc-example": "12", "x-f5xc-description-short": "The total number of malicious bot traffic in mitigated within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_sentiment": { "type": "string", "description": "The sentiment for the trend of malicious traffic in mitigated.", "title": "Mitigated Sentiment", "x-displayname": "Mitigated Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of malicious traffic in mitigated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_trend": { "type": "number", "description": "Trend of the number of malicious bot traffic in mitigated.", "title": "Mitigated Trend", "format": "double", "x-displayname": "Mitigated Trend.", "x-f5xc-example": "0.3 or null", "x-f5xc-description-short": "Trend of the number of malicious bot traffic in mitigated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "type": "string", "description": "The total number of malicious bot traffic.", "title": "Total Count", "format": "uint64", "x-displayname": "Total Count.", "x-f5xc-example": "100", "x-f5xc-description-short": "The total number of malicious bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unknown_count": { "type": "string", "description": "The total number of malicious bot traffic in Unknown.", "title": "Unknown Count", "format": "uint64", "x-displayname": "Unknown Count.", "x-f5xc-example": "23", "x-f5xc-description-short": "The total number of malicious bot traffic in Unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unknown_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "title": "Unknown Count Percentage", "format": "double", "x-displayname": "Unknown Count Percentage.", "x-f5xc-example": "45.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Bot Taffic Overview in Actions Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficOverviewActionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficOverviewActionsV2Response": { "type": "object", "description": "Malicious Bot Taffic in Actions Response V2.", "title": "MaliciousTrafficOverviewActionsV2Response", "x-displayname": "Malicious Bot Taffic Overview in Actions V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewActionsV2Response", "properties": { "actions": { "type": "array", "title": "x-displayName: \"Action taken Details\"", "items": { "$ref": "#/components/schemas/reportingActionTakenData" }, "description": "Action or operation type", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Bot Taffic in Actions Response V2.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficOverviewActionsV2Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficOverviewMetricsResponse": { "type": "object", "description": "Malicious Traffic Overview Metrics Response.", "title": "MaliciousTrafficOverviewMetricsResponse", "x-displayname": "Malicious Traffic Overview Metrics Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficOverviewMetricsResponse", "properties": { "ASN": { "type": "string", "description": "Configuration parameter for ASN", "title": "ASN", "format": "uint64", "x-displayname": "ASN", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "BFP": { "type": "string", "description": "Configuration parameter for BFP", "title": "BFP", "format": "uint64", "x-displayname": "BFP", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "HFP": { "type": "string", "description": "Configuration parameter for HFP", "title": "HFP", "format": "uint64", "x-displayname": "HFP", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "IP": { "type": "string", "description": "Configuration parameter for IP", "title": "IP", "format": "uint64", "x-displayname": "IP", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "UFP": { "type": "string", "description": "Configuration parameter for UFP", "title": "UFP", "format": "uint64", "x-displayname": "UFP", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_agent": { "type": "string", "description": "User Agent.", "title": "User Agent", "format": "uint64", "x-displayname": "User Agent.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Malicious Traffic Overview Metrics Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficOverviewMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficTimeseriesActions": { "type": "object", "description": "Shape Bot Defense malicious traffic overview timeseries in actions value.", "title": "MaliciousTrafficOverviewTimeseriesActions", "x-displayname": "Malicious Traffic Overview Timeseries in Actions.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActions", "properties": { "flagged_count": { "type": "string", "description": "The number of malicious bot traffic in flagged.", "title": "Flagged Count", "format": "uint64", "x-displayname": "Flagged Count.", "x-f5xc-example": "43", "x-f5xc-description-short": "The number of malicious bot traffic in flagged.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "title": "Flagged Count Percentage", "format": "double", "x-displayname": "Flagged Count Percentage.", "x-f5xc-example": "74.3", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in flagged / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_count": { "type": "string", "description": "The number of malicious bot traffic in mitigated.", "title": "Mitigated Count", "format": "uint64", "x-displayname": "Mitigated Count.", "x-f5xc-example": "24", "x-f5xc-description-short": "The number of malicious bot traffic in mitigated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "title": "Mitigated Count Percentage", "format": "double", "x-displayname": "Mitigated Count Percentage.", "x-f5xc-example": "25.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in mitigated / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unknown_count": { "type": "string", "description": "The number of malicious bot traffic that are unknown.", "title": "Unknown Count", "format": "uint64", "x-displayname": "Unknown Count.", "x-f5xc-example": "24", "x-f5xc-description-short": "The number of malicious bot traffic that are unknown.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unknown_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "title": "Unknown Count Percentage", "format": "double", "x-displayname": "Unknown Count Percentage.", "x-f5xc-example": "74.3", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "x-f5xc-description-medium": "The percentage of the number of malicious bot traffic in unknown / total malicious bot traffic count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape Bot Defense malicious traffic overview timeseries in actions value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficTimeseriesActions", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficTimeseriesActionsResponse": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview timeseries in actions value.", "title": "Malicious Traffic Timeseries in Actions Response", "x-displayname": "Malicious Traffic Timeseries in Actions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsResponse", "properties": { "values": { "type": "array", "description": "Maclicious Traffic Overview Timeseries in Actions.", "title": "Malicious Traffic in Actions Timeseries Values", "items": { "$ref": "#/components/schemas/reportingMaliciousTrafficTimeseriesActions" }, "x-displayname": "Malicious Traffic Timeseries in Actions Values.", "x-f5xc-description-short": "Maclicious Traffic Overview Timeseries in Actions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview timeseries in actions value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficTimeseriesActionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficTimeseriesActionsResponseV2": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview timeseries in actions value.", "title": "Malicious Traffic Timeseries in Actions Response V2", "x-displayname": "Malicious Traffic Timeseries in Actions Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsResponseV2", "properties": { "values": { "type": "array", "description": "Maclicious Traffic Overview Timeseries in Actions.", "title": "Malicious Traffic in Actions Timeseries Values", "maxItems": 32, "items": { "$ref": "#/components/schemas/reportingMaliciousTrafficTimeseriesActionsV2" }, "x-displayname": "Malicious Traffic Timeseries in Actions Values.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "0" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "0" }, "x-f5xc-description-short": "Maclicious Traffic Overview Timeseries in Actions.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "minItems": 0, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview timeseries in actions value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficTimeseriesActionsResponseV2", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {}\n ]\n}", "example_yaml": "values:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMaliciousTrafficTimeseriesActionsV2": { "type": "object", "description": "Shape Bot Defense malicious traffic overview timeseries in actions value.", "title": "MaliciousTrafficOverviewTimeseriesActionsV2", "x-displayname": "Malicious Traffic Overview Timeseries in Actions V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MaliciousTrafficTimeseriesActionsV2", "properties": { "name": { "type": "string", "description": "The name of the Traffic Type.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Blocked, Challenged, Flagged, Redirected, Transformed, Undefined.", "x-f5xc-example": "Blocked, Challenged, Flagged, Redirected, Transformed, Undefined", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "time_series": { "type": "array", "description": "Time Series data for each Malicious Traffic Action type.", "title": "Timeseries Values", "items": { "$ref": "#/components/schemas/reportingTimeSeriesDataV2" }, "x-displayname": "Timeseries values.", "x-f5xc-description-short": "Time Series data for each Malicious Traffic Action type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape Bot Defense malicious traffic overview timeseries in actions value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMaliciousTrafficTimeseriesActionsV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMethodFilter": { "type": "object", "description": "Query Filter by traffic method strings.", "title": "Traffic Method Filter", "x-displayname": "Traffic Method Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MethodFilter", "properties": { "method_strings": { "type": "array", "description": "An list of strings.", "title": "Method Strings", "minItems": 1, "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Method Strings.", "x-ves-example": "['POST', 'GET']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['POST', 'GET']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMethodFilter", "required_fields": [ "method_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"method_strings\": [\n \"value\"\n ]\n}", "example_yaml": "method_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingMonthlyUsageSummaryData": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.MonthlyUsageSummaryData", "properties": { "all": { "type": "string", "description": "All traffic counter.", "title": "All Traffic", "format": "uint64", "x-displayname": "All Traffic.", "x-ves-example": "34234", "x-f5xc-example": "34234", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "js": { "type": "string", "description": "Counts the number of Bot JS requests.", "title": "JS Traffic", "format": "uint64", "x-displayname": "JS Traffic.", "x-ves-example": "342", "x-f5xc-example": "342", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mobile_config": { "type": "string", "description": "Counts the number of Bot Mobile SDK Config requests.", "title": "Mobile SDK Config Traffic", "format": "uint64", "x-displayname": "Mobile SDK Config Traffic.", "x-ves-example": "1509", "x-f5xc-example": "1509", "x-f5xc-description-short": "Counts the number of Bot Mobile SDK Config requests.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "month": { "type": "string", "description": "Month Identifier, format: YYYYMM.", "title": "Month", "x-displayname": "Month", "x-ves-example": "202209", "x-f5xc-example": "202209", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingMonthlyUsageSummaryData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingOSFilter": { "type": "object", "description": "Query Filter by OS filter strings.", "title": "Header OS Filter", "x-displayname": "Header OS Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.OSFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "os_strings": { "type": "array", "description": "An list of strings.", "title": "OS Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "OS Strings.", "x-ves-example": "['win', 'linux']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['win', 'linux']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingOSFilter", "required_fields": [ "os_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"os_strings\": [\n \"value\"\n ]\n}", "example_yaml": "os_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPagination": { "type": "object", "description": "Pagination with number and size.", "title": "Pagination", "x-displayname": "Pagination.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.Pagination", "properties": { "page_number": { "type": "integer", "description": "Configuration parameter for page number", "title": "Page Number", "format": "int64", "x-displayname": "Page Number.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Configuration parameter for page number.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "Size or capacity specification", "title": "Page Size", "format": "int64", "x-displayname": "Page Size", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 500, "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPagination", "required_fields": [ "page_number", "page_size" ], "mutually_exclusive_groups": [], "example_json": "{\n \"page_number\": 0,\n \"page_size\": 0\n}", "example_yaml": "page_number: 0\npage_size: 0" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPaginationInfo": { "type": "object", "description": "Pagination Info.", "title": "Pagination Info", "x-displayname": "Pagination Info.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PaginationInfo", "properties": { "page_number": { "type": "integer", "description": "Configuration parameter for page number", "title": "Page Number", "format": "int64", "x-displayname": "Page Number.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0" }, "x-f5xc-description-short": "Configuration parameter for page number.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "page_size": { "type": "integer", "description": "Size or capacity specification", "title": "Page Size", "format": "int64", "x-displayname": "Page Size", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 500, "minimum": 1, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "total_rows": { "type": "string", "description": "Configuration parameter for total rows", "title": "Total Rows", "format": "uint64", "x-displayname": "Total Rows.", "x-ves-example": "4000", "x-f5xc-example": "4000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPaginationInfo", "required_fields": [ "page_number", "page_size" ], "mutually_exclusive_groups": [], "example_json": "{\n \"page_number\": 0,\n \"page_size\": 0\n}", "example_yaml": "page_number: 0\npage_size: 0" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerGroupData": { "type": "object", "title": "Peer Group Data", "x-displayname": "Peer Group Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupData", "properties": { "name": { "type": "string", "description": "The Name of Item.", "title": "Item Name", "x-displayname": "Name", "x-ves-example": "Human", "x-f5xc-example": "human", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "peer_count": { "type": "string", "description": "The count of Peer of the Item.", "title": "Peer Count", "format": "uint64", "x-displayname": "Peer Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_percentage": { "type": "number", "description": "The Peer Percentage of the Item.", "title": "Peer Percentage", "format": "double", "x-displayname": "Peer Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "self_count": { "type": "string", "description": "The count of Self of the item.", "title": "Self Count", "format": "uint64", "x-displayname": "Self Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "self_percentage": { "type": "number", "description": "The Self Percentage of the Item.", "title": "Self Percentage", "format": "double", "x-displayname": "Self Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerGroupData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerGroupRequest": { "type": "object", "description": "Request for Shape Bot Defense Peer Group Peer Benchmarking.", "title": "PeerGroupRequest", "x-displayname": "Peer Group Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupRequest", "properties": { "end_time": { "type": "string", "description": "End time of the query period.", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of transactions returned in the response\nOptional: If not specified (with default value 0), all transactions that match the query will be returned in the response.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the...", "x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified (with default value 0), all transactions that match the query will be returned in the response.", "x-f5xc-constraints": { "constraintType": "number", "category": "policy", "minimum": 1, "maximum": 1000000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rank_by": { "type": "string", "description": "Rank by self or peer.", "title": "Rankby", "x-displayname": "Rank by", "x-ves-example": "Self", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]" }, "x-f5xc-example": "self", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"self\\\",\\\"peer\\\"]" }, "maxLength": 1024, "enum": [ "self", "peer" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the query period.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense Peer Group Peer Benchmarking.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerGroupRequest", "required_fields": [ "end_time", "rank_by", "start_time" ], "mutually_exclusive_groups": [], "example_json": "{\n \"end_time\": \"value\",\n \"rank_by\": \"self\",\n \"start_time\": \"value\"\n}", "example_yaml": "end_time: value\nrank_by: self\nstart_time: value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerGroupResponse": { "type": "object", "description": "The Response contains the total and detail of the Peer Group data.", "title": "Peer Group Response", "x-displayname": "Response for Peer Group Peer Benchmarking.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupResponse", "properties": { "details": { "type": "array", "title": "Response for Peer Group Peer Benchmarking", "items": { "$ref": "#/components/schemas/reportingPeerGroupData" }, "x-displayname": "Peer Group Top Good Bots Details.", "description": "Configuration parameter for details", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The Response contains the total and detail of the Peer Group data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerGroupResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerGroupTrafficOverviewResponse": { "type": "object", "description": "The Response contains the total and detail of the Peer Group data.", "title": "Peer Group Traffic Overview Response", "x-displayname": "Response for Peer Group Peer Benchmarking Traffic Overview.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerGroupTrafficOverviewResponse", "properties": { "details": { "type": "array", "title": "Response for Peer Group Peer Benchmarking Traffic Overview", "items": { "$ref": "#/components/schemas/reportingPeerGroupData" }, "x-displayname": "Peer Group Traffic Overview Details.", "description": "Configuration parameter for details", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_percentage": { "type": "number", "description": "The Peer Percentage of the Item.", "title": "Peer Percentage", "format": "double", "x-displayname": "Peer Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_total": { "type": "string", "description": "The total number of Peer of the Item.", "title": "Peer Total", "format": "uint64", "x-displayname": "Peer Total.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "self_percentage": { "type": "number", "description": "The Self Percentage of the Item.", "title": "Self Percentage", "format": "double", "x-displayname": "Self Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "self_total": { "type": "string", "description": "The total number of Self of the item.", "title": "Self Total", "format": "uint64", "x-displayname": "Self Total.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The Response contains the total and detail of the Peer Group data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerGroupTrafficOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerStatusRequest": { "type": "object", "title": "Peer Status Request", "x-displayname": "Request for checking peers status.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerStatusRequest", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingPeerStatusResponse": { "type": "object", "description": "The Response for checking if the tenant has peers or not.", "title": "PeerStatusResponse", "x-displayname": "Has_Peers Status Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.PeerStatusResponse", "properties": { "has_peers": { "type": "boolean", "description": "The tenat has peers or not.", "title": "has_peers", "format": "boolean", "x-displayname": "Has peers status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The Response for checking if the tenant has peers or not.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingPeerStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingRefererFilter": { "type": "object", "description": "Query Filter by referer filter strings.", "title": "Header Reference Filter", "x-displayname": "Header Reference Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.RefererFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referer_strings": { "type": "array", "description": "An list of strings.", "title": "Inference Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Referer Strings.", "x-ves-example": "['HTTP://192.0.2.101/index.php']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['http://192.0.2.101/index.php']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingRefererFilter", "required_fields": [ "referer_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"referer_strings\": [\n \"value\"\n ]\n}", "example_yaml": "referer_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingReportEndpointDataV2": { "type": "object", "description": "Report Endpoint Data V2.", "title": "ReportEndpointDataV2", "x-displayname": "Report Endpoint Data V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ReportEndpointDataV2", "properties": { "automated_events": { "type": "string", "description": "Automated Events.", "title": "Automated Events", "format": "uint64", "x-displayname": "Automated Events.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automated_percentage": { "type": "number", "description": "Automated Percentage.", "title": "Automated Percentage", "format": "double", "x-displayname": "Automated Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "base_path": { "type": "string", "description": "Base Path", "title": "Base Path", "x-displayname": "Base Path", "x-ves-example": "/", "x-f5xc-example": "/", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "collapsed_url": { "type": "string", "description": "Collapsed URL.", "title": "Collapsed URL", "x-displayname": "Collapsed URL.", "x-ves-example": "/test/test.", "x-f5xc-example": "/test/test", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "events": { "type": "string", "description": "Events", "title": "Events", "format": "uint64", "x-displayname": "Events", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_events": { "type": "string", "description": "Flagged Events.", "title": "Flagged Events", "format": "uint64", "x-displayname": "Flagged Events.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flagged_percentage": { "type": "number", "description": "Flagged Percentage.", "title": "Flagged Percentage", "format": "double", "x-displayname": "Flagged Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_events": { "type": "string", "description": "Human Events.", "title": "Human Events", "format": "uint64", "x-displayname": "Human Events.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_percentage": { "type": "number", "description": "Human Percentage.", "title": "Human Percentage", "format": "double", "x-displayname": "Human Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method": { "type": "string", "description": "Method", "title": "Method", "x-displayname": "Method", "x-ves-example": "GET", "x-f5xc-example": "GET", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_events": { "type": "string", "description": "Mitigated Events.", "title": "Mitigated Events", "format": "uint64", "x-displayname": "Mitigated Events.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigated_percentage": { "type": "number", "description": "Mitigated Percentage.", "title": "Mitigated Percentage", "format": "double", "x-displayname": "Mitigated Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_percentage": { "type": "number", "description": "Request Percentage.", "title": "Request Percentage", "format": "double", "x-displayname": "Request Percentage.", "x-ves-example": "10.0", "x-f5xc-example": "10.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "undefined_events": { "type": "string", "description": "Undefined Events.", "title": "Undefined Events", "format": "uint64", "x-displayname": "Undefined Events.", "x-ves-example": "10", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "undefined_percentage": { "type": "number", "description": "Undefined Percentage.", "title": "Undefined Percentage", "format": "double", "x-displayname": "Undefined Percentage.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingReportEndpointDataV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingReportEndpointsResponse": { "type": "object", "description": "Report Endpoints Response.", "title": "ReportEndpointsResponse", "x-displayname": "Report Endpoints Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.ReportEndpointsResponse", "properties": { "endpoint_data": { "type": "array", "description": "Report Endpoints Response.", "title": "Report Endpoints Response", "items": { "$ref": "#/components/schemas/reportingReportEndpointDataV2" }, "x-displayname": "Report Endpoints Response.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingReportEndpointsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingSortOption": { "type": "object", "description": "Query Result Sort Option.", "title": "Sort Option", "x-displayname": "Sort Option.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.SortOption", "properties": { "key": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterKey" } ], "x-f5xc-example": "[REDACTED_PUBLIC_KEY]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 16, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "order": { "allOf": [ { "$ref": "#/components/schemas/schemaSortOrder" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingSortOption", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTimeSeriesDataV2": { "type": "object", "description": "Time Series Data.", "title": "Time Series Data", "x-displayname": "Time Series Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TimeSeriesDataV2", "properties": { "count": { "type": "string", "description": "Number of items or occurrences", "title": "Count", "format": "uint64", "x-displayname": "Count", "x-f5xc-example": "10", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "percentage": { "type": "number", "description": "Percentage.", "title": "Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "50.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTimeSeriesDataV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTimeSeriesGraphData": { "type": "object", "description": "The data for Timeseries Graph.", "title": "Timeseries Graph Data", "x-displayname": "Timeseries Graph Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TimeSeriesGraphData", "properties": { "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "January", "x-f5xc-example": "January", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "time_series_data": { "type": "array", "description": "Time Series Data.", "title": "Time Series Data", "items": { "$ref": "#/components/schemas/reportingTimeSeriesDataV2" }, "x-displayname": "Time Series Data.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTimeSeriesGraphData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTimeSeriesGraphMinimalData": { "type": "object", "description": "Response that contains timeseries against each traffic or any other type.", "title": "TimeSeriesGraphMinimalData", "x-displayname": "Timeseries Graph Minimal Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TimeSeriesGraphMinimalData", "properties": { "name": { "type": "string", "description": "The name of the Traffic Type.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Human, automated, allowListed, interstitual.", "x-f5xc-example": "Human, automated, allowListed, interstitual", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "time_series": { "type": "array", "description": "Time Series data for each traffic type.", "title": "Timeseries Values", "items": { "$ref": "#/components/schemas/reportingTimeSeriesMinimalData" }, "x-displayname": "Timeseries values.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains timeseries against each traffic or any other type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTimeSeriesGraphMinimalData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTimeSeriesMinimalData": { "type": "object", "description": "Requests over time.", "title": "Requests Time Series", "x-displayname": "Requests Time Series.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TimeSeriesMinimalData", "properties": { "count": { "type": "string", "description": "Number of requests counted at specific time period marked by timestamp.", "title": "Number of Requests", "format": "uint64", "x-displayname": "Number of Requests.", "x-f5xc-example": "342", "x-f5xc-description-short": "Number of requests counted at specific time period marked by timestamp.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTimeSeriesMinimalData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopActiveKnownBotResponse": { "type": "object", "description": "Request for Top Active Known Bot with global filters.", "title": "Top Active Known Bot Response", "x-displayname": "Top Active Known Bot Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopActiveKnownBotResponse", "properties": { "top_known_bots": { "type": "array", "description": "Top Known Bots.", "title": "Top Known Bots", "items": { "$ref": "#/components/schemas/reportingKnownBotGenericMetric" }, "x-displayname": "Top Known Bots.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Top Active Known Bot with global filters.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopActiveKnownBotResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackIntentData": { "type": "object", "description": "Top Attack Intent Data.", "title": "Top Attack Intent Data", "x-displayname": "Top Attack Intent Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackIntentData", "properties": { "color_alert": { "type": "boolean", "description": "Color Alert.", "title": "Color Alert", "format": "boolean", "x-displayname": "Color_alert.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "events": { "type": "string", "description": "Events", "title": "Events", "format": "uint64", "x-displayname": "Events", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "link": { "type": "string", "description": "Link of certain OWASP page.", "title": "Link", "x-displayname": "Link", "x-ves-example": "Link", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "link", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "percentage": { "type": "number", "description": "The Percentage of the number of each attack intent type / the total traffic or bad bot.", "title": "Attack Intent Type Percentage", "format": "double", "x-displayname": "Percentage.", "x-f5xc-example": "50.0", "x-f5xc-description-short": "The Percentage of the number of each attack intent type / the total traffic or bad bot.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "type": "string", "description": "Sentiment", "title": "Sentiment", "x-displayname": "Sentiment", "x-ves-example": "Null", "x-f5xc-example": "null", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "Trend", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "\"0.5\" or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Attack Intent Type.", "title": "Attack Intent Type", "x-displayname": "Type", "x-ves-example": "Carding", "x-f5xc-example": "Carding", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackIntentData", "required_fields": [ "link" ], "mutually_exclusive_groups": [], "example_json": "{\n \"link\": \"link\"\n}", "example_yaml": "link: link" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackIntentResponse": { "type": "object", "description": "The Response of Top Attack Intent API.", "title": "Top Attack Intent Response", "x-displayname": "Top Attack Intent Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackIntentResponse", "properties": { "attack_intents": { "type": "array", "title": "Attack Intent Widget Data", "items": { "$ref": "#/components/schemas/reportingTopAttackIntentData" }, "x-displayname": "Attack Intent List.", "description": "Configuration parameter for attack intents", "x-f5xc-description-short": "Configuration parameter for attack intents.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "type": "string", "description": "Total Events.", "title": "Total", "format": "uint64", "x-displayname": "Total", "x-ves-example": "158", "x-f5xc-example": "158", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackIntentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackedBFPResponse": { "type": "object", "description": "Top Attacked BFP Response.", "title": "TopAttackedBFPResponse", "x-displayname": "Top Attacked BFP Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackedBFPResponse", "properties": { "attacked_bfp": { "type": "array", "description": "Top Attacked BFP.", "title": "Top Attacked BFP", "items": { "$ref": "#/components/schemas/reportingAttackedBFPData" }, "x-displayname": "Top Attacked BFP.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackedBFPResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackedEndpointsResponse": { "type": "object", "description": "Response for top attacked application endpoints.", "title": "TopAttackedEndpointsResponse", "x-displayname": "Response for Top Attacked Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponse", "properties": { "attacked_endpoints": { "type": "array", "description": "Top attacked application endpoints.", "title": "Top Attacked Endpoints", "items": { "$ref": "#/components/schemas/reportingAttackedEndpointData" }, "x-displayname": "Top Attacked Endpoints.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top attacked application endpoints.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackedEndpointsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackedEndpointsResponseV2": { "type": "object", "description": "Response for top attacked application endpoints.", "title": "TopAttackedEndpointsResponseV2", "x-displayname": "Response V2 for Top Attacked Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponseV2", "properties": { "attacked_endpoints": { "type": "array", "description": "Top attacked application endpoints.", "title": "Top Attacked Endpoints", "items": { "$ref": "#/components/schemas/reportingAttackedEndpointDataV2" }, "x-displayname": "Top Attacked Endpoints.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top attacked application endpoints.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackedEndpointsResponseV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAttackedEndpointsResponseV4": { "type": "object", "description": "Response for top attacked application endpoints.", "title": "TopAttackedEndpointsResponseV4", "x-displayname": "Response V2 for Top Attacked Endpoints.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAttackedEndpointsResponseV4", "properties": { "attacked_endpoints": { "type": "array", "description": "Top attacked application endpoints.", "title": "Top Attacked Endpoints", "items": { "$ref": "#/components/schemas/reportingAttackedEndpointDataV4" }, "x-displayname": "Top Attacked Endpoints.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top attacked application endpoints.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAttackedEndpointsResponseV4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopAutomationTypesResponse": { "type": "object", "description": "Response for top malicious bot automation types.", "title": "TopAutomationTypesResponse", "x-displayname": "Response for Top Malicious Bot Automation Types.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopAutomationTypesResponse", "properties": { "automation_types": { "type": "array", "description": "Top malicious bot automation types.", "title": "Top Malicious Bot Automation Types", "items": { "$ref": "#/components/schemas/reportingAutomationTypeData" }, "x-displayname": "Top Malicious Bot Automation Types.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bot automation types.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopAutomationTypesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopCategoriesResponse": { "type": "object", "description": "Response for top flow label categories.", "title": "Categories Response", "x-displayname": "Response for Top Categories.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopCategoriesResponse", "properties": { "categories": { "type": "array", "description": "Requests sorted by flow label categories over a requested period of time (as time series)", "title": "Requests by Flow Label Categories", "items": { "$ref": "#/components/schemas/reportingCategoriesData" }, "x-displayname": "Requests by Categories.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "Requests sorted by flow label categories over a requested period of time (as time series).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_requests": { "type": "string", "description": "Total number of requests for requested period.", "title": "Total Number of Requests", "format": "uint64", "x-displayname": "Total Number of Requests.", "x-f5xc-example": "100", "x-f5xc-description-short": "Total number of requests for requested period.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopCategoriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopEndpointLabelsResponse": { "type": "object", "description": "Response for Top Endpoint Labels.", "title": "EndpointLabelsResponse", "x-displayname": "Response for Top Endpoint Labels.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopEndpointLabelsResponse", "properties": { "endpoint_labels": { "type": "array", "description": "Over a time period.", "title": "Endpoint Labels Requests", "items": { "$ref": "#/components/schemas/reportingEndpointLabelsData" }, "x-displayname": "Endpoint Labels Requests.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_requests": { "type": "string", "description": "Total number of requests.", "title": "Total number of requests", "format": "uint64", "x-displayname": "Total Number of Requests.", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopEndpointLabelsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopGoodBotsData": { "type": "object", "description": "Good bots data.", "title": "Good Bots Data", "x-displayname": "Good Bots Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopGoodBotsData", "properties": { "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "Google Search.", "x-f5xc-example": "Google Search", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "traffic_usage_count": { "type": "string", "description": "Traffic Usage Count.", "title": "Traffic Usage Count", "format": "uint64", "x-displayname": "Traffic Usage Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_usage_percentage": { "type": "number", "description": "Traffic Usage Percentage.", "title": "Traffic Usage Percentage", "format": "double", "x-displayname": "Traffic Usage Percentage.", "x-ves-example": "0.5", "x-f5xc-example": "0.5", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "type": "string", "description": "Type or category classification", "title": "Type", "x-displayname": "Type", "x-ves-example": "Search", "x-f5xc-example": "Search", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopGoodBotsData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopGoodBotsResponse": { "type": "object", "description": "Response for top good bots.", "title": "TopGoodBotsResponse", "x-displayname": "Response for Top God Bots.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopGoodBotsResponse", "properties": { "good_bots": { "type": "array", "description": "Top good bots.", "title": "Top Good Bots", "items": { "$ref": "#/components/schemas/reportingTopGoodBotsData" }, "x-displayname": "Top Good Bots.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopGoodBotsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopGoodBotsResponseV2": { "type": "object", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopGoodBotsResponseV2", "properties": { "good_bots": { "type": "array", "description": "Top good bots.", "title": "Top Good Bots", "items": { "$ref": "#/components/schemas/reportingTopGoodBotsData" }, "x-displayname": "Top Good Bots.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "top_good_bots_percentage": { "type": "number", "description": "Top Good Bots Count / Total Good Bots Count.", "title": "Top Good Bots Percentage", "format": "double", "x-displayname": "Top Good Bot Percentage.", "x-ves-example": "50.2", "x-f5xc-example": "50.2", "x-f5xc-description-short": "Top Good Bots Count / Total Good Bots Count.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_good_bots": { "type": "string", "description": "Total Good Bots Traffic Count.", "title": "Total Good Bot Traffic Count", "format": "uint64", "x-displayname": "Total Good Bots Traffic Count.", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopGoodBotsResponseV2", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopHumanBrowserResponse": { "type": "object", "description": "Top Human Browser Response.", "title": "TopHumanBrowserResponse", "x-displayname": "Top Human Browser Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopHumanBrowserResponse", "properties": { "human_browser_data": { "type": "array", "description": "Top Human Browser Response.", "title": "Top Human Browser Response", "items": { "$ref": "#/components/schemas/reportingHumanBrowserData" }, "x-displayname": "Top Human Browser Response.", "x-ves-example": "Chrome", "x-f5xc-example": "chrome", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopHumanBrowserResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopHumanDeviceResponse": { "type": "object", "description": "Top Human Device Response.", "title": "TopHumanDeviceResponse", "x-displayname": "Top Human Device Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopHumanDeviceResponse", "properties": { "human_device_data": { "type": "array", "description": "Top Human Device Response.", "title": "Top Human Device Response", "items": { "$ref": "#/components/schemas/reportingHumanDeviceData" }, "x-displayname": "Top Human Device Response.", "x-ves-example": "IPhone", "x-f5xc-example": "iPhone", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopHumanDeviceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopHumanGeolocationResponse": { "type": "object", "description": "Top Human Geolocation Response.", "title": "TopHumanGeolocationResponse", "x-displayname": "Top Human Geolocation Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopHumanGeolocationResponse", "properties": { "human_geolocation_data": { "type": "array", "description": "Top Human Geolocation Response.", "title": "Top Human Geolocation Response", "items": { "$ref": "#/components/schemas/reportingHumanGeolocationData" }, "x-displayname": "Top Human Geolocation Response.", "x-ves-example": "US", "x-f5xc-example": "US", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopHumanGeolocationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopHumanPlatformResponse": { "type": "object", "description": "Top Human Platform Response.", "title": "TopHumanPlatformResponse", "x-displayname": "Top Human Platform Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopHumanPlatformResponse", "properties": { "human_platform_data": { "type": "array", "description": "Top Human Platform Response.", "title": "Top Human Platform Response", "items": { "$ref": "#/components/schemas/reportingHumanPlatformData" }, "x-displayname": "Top Human Platform Response.", "x-ves-example": "IOS", "x-f5xc-example": "iOS", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopHumanPlatformResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopLatencyOverviewAppsData": { "type": "object", "description": "Top Latency Applications.", "title": "Top Latency Apps Data", "x-displayname": "Top Latency Apps Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewAppsData", "properties": { "application": { "type": "string", "description": "Application.", "title": "x-displayName: \"Application\"\nx-example: \"AppA\"\nApplication", "x-displayname": "Application.", "x-ves-example": "AppA", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "counts": { "type": "string", "description": "Counts", "title": "x-displayName: \"Counts\"", "format": "uint64", "x-displayname": "Counts", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "latency": { "type": "string", "description": "Latency", "title": "x-displayName: \"Latency\"", "format": "uint64", "x-displayname": "Latency", "x-ves-example": "123", "x-f5xc-example": "123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "type": "string", "description": "Sentiment", "title": "x-displayName: \"Sentiment\"", "x-displayname": "Sentiment", "x-ves-example": "False", "x-f5xc-example": "false", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status", "title": "x-displayName: \"Status\"", "x-displayname": "Status", "x-ves-example": "Critical", "x-f5xc-example": "critical", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "x-displayName: \"Trend\"", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "\"0.34\" or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopLatencyOverviewAppsData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopLatencyOverviewAppsResponse": { "type": "object", "description": "Bot API Latency Across Top Protected Apps Overview Apps Response.", "title": "Top Latency Overview Apps Response", "x-displayname": "Top Latency Overview Apps Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewAppsResponse", "properties": { "applications": { "type": "array", "description": "Top Latency Overview Apps.", "title": "x-displayName: \"Top Latency Overview Apps\"\nx-example: \"\"\nTop Latency Overview Apps", "items": { "$ref": "#/components/schemas/reportingTopLatencyOverviewAppsData" }, "x-displayname": "Top Latency Overview Apps.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot API Latency Across Top Protected Apps Overview Apps Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopLatencyOverviewAppsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopLatencyOverviewResponse": { "type": "object", "description": "Bot API Latency Across Top Protected Apps Overview Response.", "title": "Top Latency Overview Response", "x-displayname": "Top Latency Overview Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopLatencyOverviewResponse", "properties": { "average_latency": { "type": "string", "description": "Average latency.", "title": "x-displayName: \"Average Time\"", "format": "uint64", "x-displayname": "Average Time.", "x-ves-example": "60", "x-f5xc-example": "60", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "critical": { "type": "string", "description": "Critical", "title": "x-displayName: \"Critical\"", "format": "uint64", "x-displayname": "Critical", "x-ves-example": "123000", "x-f5xc-example": "123000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "high": { "type": "string", "description": "Configuration parameter for high", "title": "x-displayName: \"High\"", "format": "uint64", "x-displayname": "High", "x-ves-example": "234", "x-f5xc-example": "234", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "low": { "type": "string", "description": "Configuration parameter for low", "title": "x-displayName: \"Low\"", "format": "uint64", "x-displayname": "Low", "x-ves-example": "235", "x-f5xc-example": "235", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "previous_latency": { "type": "string", "description": "Previous latency.", "title": "x-displayName: \"Previous\"", "format": "uint64", "x-displayname": "Previous", "x-ves-example": "20", "x-f5xc-example": "20", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "type": "string", "description": "Sentiment", "title": "x-displayName: \"Sentiment\"", "x-displayname": "Sentiment", "x-ves-example": "False", "x-f5xc-example": "false", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "x-displayName: \"Trend\"", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "\"0.34\" or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Bot API Latency Across Top Protected Apps Overview Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopLatencyOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsAttackIntentByASOrgResponse": { "type": "object", "description": "Response for top bad bot events by ASN of Attack Intent Types.", "title": "TopMaliciousBotsAttackIntentByASOrgResponse", "x-displayname": "Response for Top ASN of Attack Intent under bad bot traffic.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByASOrgResponse", "properties": { "bad_bot_asn_data": { "type": "array", "description": "The list of top source by ASN.", "title": "Top ASN event of Attack Intent under bad bot traffic", "items": { "$ref": "#/components/schemas/reportingMaliciousBotAttackIntentASOrgData" }, "x-displayname": "Top Event by ASN of Attack Intent.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top bad bot events by ASN of Attack Intent Types.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsAttackIntentByASOrgResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsAttackIntentByIPResponse": { "type": "object", "description": "Response for top bad bot events by source IPs of Attack Intent Types.", "title": "TopMaliciousBotsAttackIntentByIPResponse", "x-displayname": "Response for Top Source IP of Attack Intent under bad bot traffic.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByIPResponse", "properties": { "bad_bot_ip_data": { "type": "array", "description": "The list of top source by source IP.", "title": "Top IP source event of Attack Intent under bad bot traffic", "items": { "$ref": "#/components/schemas/reportingMaliciousBotAttackIntentIPData" }, "x-displayname": "Top Event by Source IP of Attack Intent.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top bad bot events by source IPs of Attack Intent Types.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsAttackIntentByIPResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsAttackIntentByUAResponse": { "type": "object", "description": "Response for top bad bot events by User Agent of Attack Intent Types.", "title": "TopMaliciousBotsAttackIntentByUAResponse", "x-displayname": "Response for Top User Agent of Attack Intent under bad bot traffic.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsAttackIntentByUAResponse", "properties": { "bad_bot_ua_data": { "type": "array", "description": "The list of top source by UA.", "title": "Top UA event of Attack Intent under bad bot traffic", "items": { "$ref": "#/components/schemas/reportingMaliciousBotAttackIntentUAData" }, "x-displayname": "Top Event by User Agent of Attack Intent.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top bad bot events by User Agent of Attack Intent Types.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsAttackIntentByUAResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByASOrgResponse": { "type": "object", "description": "Response for top malicious bots by AS Organizations.", "title": "TopMaliciousBotsByASOrgResponse", "x-displayname": "Response for Top Malicious Bots by AS Organization.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByASOrgResponse", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by AS Organizations.", "title": "Top Malicious Bot ASOrganizations", "items": { "$ref": "#/components/schemas/reportingMaliciousBotASOrgData" }, "x-displayname": "Top Malicious Bots by AS Organizations.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by AS Organizations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by AS Organizations.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByASOrgResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByASOrgResponseV3": { "type": "object", "description": "Response for top malicious bots by AS Organizations with action distribution.", "title": "TopMaliciousBotsByASOrgResponseV3", "x-displayname": "Response for Top Malicious Bots by AS Organization.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByASOrgResponseV3", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by AS Organizations.", "title": "Top Malicious Bot ASOrganizations", "items": { "$ref": "#/components/schemas/reportingMaliciousBotASOrgDataV3" }, "x-displayname": "Top Malicious Bots by AS Organizations.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by AS Organizations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by AS Organizations with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByASOrgResponseV3", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByAppResponse": { "type": "object", "description": "Response for top malicious bots by applications.", "title": "TopMaliciousBotsByAppResponse", "x-displayname": "Response for Top Malicious Bots by Applications.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByAppResponse", "properties": { "application_data": { "type": "array", "description": "The list of top malicious bots by application.", "title": "Top Malicious Bot App", "items": { "$ref": "#/components/schemas/reportingMaliciousBotAppData" }, "x-displayname": "Top Malicious Bots by Application Data.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_applications": { "type": "string", "description": "Configuration parameter for total applications", "title": "Total number of Applications", "format": "uint64", "x-displayname": "The Total Number of Applications.", "x-f5xc-example": "8", "x-f5xc-description-short": "Configuration parameter for total applications.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by applications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByAppResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByIPResponse": { "type": "object", "description": "Response for top malicious bots by source IPs.", "title": "TopMaliciousBotsByIPResponse", "x-displayname": "Response for Top Malicious Bots by IP.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByIPResponse", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by source IP.", "title": "Top Malicious Bot IPs", "items": { "$ref": "#/components/schemas/reportingMaliciousBotIPData" }, "x-displayname": "Top Malicious Bots by IP.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by source IP.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by source IPs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByIPResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByIPResponseV3": { "type": "object", "description": "Response for top malicious bots by source IPs with action distribution.", "title": "TopMaliciousBotsByIPResponseV3", "x-displayname": "Response for Top Malicious Bots by IP.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByIPResponseV3", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by source IP.", "title": "Top Malicious Bot IPs", "items": { "$ref": "#/components/schemas/reportingMaliciousBotIPDataV3" }, "x-displayname": "Top Malicious Bots by IP.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by source IP.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by source IPs with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByIPResponseV3", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByUAResponse": { "type": "object", "description": "Response for top malicious bots by user agent string.", "title": "TopMaliciousBotsByUAResponse", "x-displayname": "Response for Top Malicious Bots by User Agent String.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByUAResponse", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by User Agent String.", "title": "Top Malicious Bots by User Agent", "items": { "$ref": "#/components/schemas/reportingMaliciousBotUAData" }, "x-displayname": "Top Malicious Bots by User Agent String.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by User Agent String.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by user agent string.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByUAResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopMaliciousBotsByUAResponseV4": { "type": "object", "description": "Response for top malicious bots by user agent string with action distribution.", "title": "TopMaliciousBotsByUAResponseV4", "x-displayname": "Response for Top Malicious Bots by User Agent String.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopMaliciousBotsByUAResponseV4", "properties": { "malicious_bots": { "type": "array", "description": "The list of top malicious bots by User Agent String.", "title": "Top Malicious Bots by User Agent", "items": { "$ref": "#/components/schemas/reportingMaliciousBotUADataV4" }, "x-displayname": "Top Malicious Bots by User Agent String.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top malicious bots by User Agent String.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top malicious bots by user agent string with action distribution.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopMaliciousBotsByUAResponseV4", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopRequest": { "type": "object", "description": "Request for top malicious bots.", "title": "TopRequest", "x-displayname": "Request for Top Malicious Bots.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequest", "properties": { "attack_type": { "type": "string", "description": "Optional: this is the query parameter for top source of attack types\nUsed in TopTafficEventsByIP.", "title": "Attack Intent Type", "x-displayname": "Attack Intent Type.", "x-ves-example": "Accountcreation.", "x-f5xc-example": "accountcreation", "x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopTafficEventsByIP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.", "x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 500, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...", "x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_host": { "type": "string", "description": "Name of Virtual Host to scope traffic overview query.", "title": "Virtual Host Name", "x-displayname": "Virtual Host Name.", "x-ves-example": "Example-app-vh-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-app-vh-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopRequest", "required_fields": [ "namespace", "virtual_host" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\",\n \"virtual_host\": \"example-app-vh-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1\nvirtual_host: example-app-vh-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopRequestAttackIntent": { "type": "object", "description": "Request for top malicious bots by attack intent.", "title": "Request for Top Malicious Bot Events of Sources by Attack Intent", "x-displayname": "Request for Top Malicious Bot Events of Sources by Attack Intent Type.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopRequestAttackIntent", "properties": { "attack_type": { "type": "string", "description": "Optional: this is the query parameter for top source of attack types\nUsed in TopMaliciousBotsByIPV3.", "title": "Attack Intent Type", "x-displayname": "Attack Intent Type.", "x-ves-example": "AccountCreation.", "x-f5xc-example": "AccountCreation", "x-f5xc-description-short": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.", "x-f5xc-description-medium": "Optional: this is the query parameter for top source of attack types Used in TopMaliciousBotsByIPV3.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "End time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Number of top malicious bots to query\nOptional: if not specified, the query will include top 10 malicious bots.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gt": "0", "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-description-short": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.", "x-f5xc-description-medium": "Number of top malicious bots to query Optional: if not specified, the query will include top 10 malicious bots.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 500, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "x-f5xc-description-medium": "Namespace is used to scope traffic overview query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of traffic overview query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...", "x-f5xc-description-medium": "Start time of traffic overview query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_host": { "type": "string", "description": "Name of Virtual Host to scope traffic overview query.", "title": "Virtual Host Name", "x-displayname": "Virtual Host Name.", "x-ves-example": "Example-app-vh-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-app-vh-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of Virtual Host to scope traffic overview query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for top malicious bots by attack intent.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopRequestAttackIntent", "required_fields": [ "namespace", "virtual_host" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\",\n \"virtual_host\": \"example-app-vh-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1\nvirtual_host: example-app-vh-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopTransactionsByAppData": { "type": "object", "description": "Top Transactions per Application Data.", "title": "Top Transactions per Application Data", "x-displayname": "Top Transactions per Application Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopTransactionsByAppData", "properties": { "all_traffic_request_count": { "type": "string", "description": "Number of HTTP requests for all traffic per application.", "title": "Request Count", "format": "uint64", "x-displayname": "Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of HTTP requests for all traffic per application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "all_traffic_request_percentage": { "type": "number", "description": "The percentage of all traffic requests per application in total request.", "title": "Request Percentage", "format": "double", "x-displayname": "Request Percentage.", "x-ves-example": "0.9", "x-f5xc-example": "0.9", "x-f5xc-description-short": "The percentage of all traffic requests per application in total request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "all_traffic_request_trend": { "type": "number", "description": "The trend of all traffic requests per application.", "title": "Request Trend", "format": "double", "x-displayname": "Request Trend.", "x-f5xc-example": "-23.5 or null", "x-f5xc-description-short": "The trend of all traffic requests per application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "app_sentiment": { "type": "string", "description": "The sentiment for the trend of all traffic per application.", "title": "Trend Sentiment", "x-displayname": "Trend Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of all traffic per application.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "application": { "type": "string", "description": "Application Name.", "title": "Application Name", "x-displayname": "Application Name.", "x-ves-example": "App A", "x-f5xc-example": "app A", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopTransactionsByAppData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTopTransactionsByAppResponse": { "type": "object", "description": "Response for top transactions by applications.", "title": "TopTransactionsByAppResponse", "x-displayname": "Response for Top Transactions by Applications.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TopTransactionsByAppResponse", "properties": { "application_data": { "type": "array", "description": "The list of top transactions by application.", "title": "Top Transactions By App", "items": { "$ref": "#/components/schemas/reportingTopTransactionsByAppData" }, "x-displayname": "Top Transactions by Application Data.", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "The list of top transactions by application.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_applications": { "type": "string", "description": "Configuration parameter for total applications", "title": "Total number of Applications", "format": "uint64", "x-displayname": "The Total Number of Applications.", "x-f5xc-example": "8", "x-f5xc-description-short": "Configuration parameter for total applications.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for top transactions by applications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTopTransactionsByAppResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTotalAutomationResponse": { "type": "object", "description": "Response for Total Automation Insight Event.", "title": "InsightEvent: TotalAutomationResponse", "x-displayname": "Total Automation Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TotalAutomationResponse", "properties": { "automated": { "type": "string", "description": "Number of HTTP requests identified as automated traffic.", "title": "Automated", "format": "uint64", "x-displayname": "Automated", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as automated traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automated_percentage": { "type": "number", "description": "The percentage of the number of automated traffic / the total number.", "title": "automated Percentage", "format": "double", "x-displayname": "Automated Percentage.", "x-ves-example": "24.7", "x-f5xc-example": "24.7", "x-f5xc-description-short": "The percentage of the number of automated traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "create_date": { "type": "number", "description": "UTC Create Date in seconds.", "title": "Create_Date", "format": "double", "x-displayname": "Create Date.", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint": { "type": "string", "description": "The number of Endpoint.", "title": "Endpoint", "format": "uint64", "x-displayname": "The number of Endpoint.", "x-ves-example": "123", "x-f5xc-example": "123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uint64", "minLength": 1, "pattern": "^https?://[^\\s/$.?#].[^\\s]*$", "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endpoint_label": { "type": "string", "description": "Endpoint or connection point", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot": { "type": "string", "description": "Number of HTTP requests identified as good bot traffic within specified time interval.", "title": "Good Bot", "format": "uint64", "x-displayname": "Good Bot", "x-ves-example": "23", "x-f5xc-example": "23", "x-f5xc-description-short": "Number of HTTP requests identified as good bot traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot_percentage": { "type": "number", "description": "The percentage of the number of good bot traffic / the total number.", "title": "Good Bot Percentage", "format": "double", "x-displayname": "Good Bot Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-description-short": "The percentage of the number of good bot traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human": { "type": "string", "description": "Number of HTTP requests identified as human traffic.", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_percentage": { "type": "number", "description": "The percentage of the number of human traffic / the total number.", "title": "Human Percentage", "format": "double", "x-displayname": "Human Percentage.", "x-ves-example": "24.3", "x-f5xc-example": "24.3", "x-f5xc-description-short": "The percentage of the number of human traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic.", "title": "Malicious Bot", "format": "uint64", "x-displayname": "Malicious Bot.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic / the total number.", "title": "Malicious Bot Percentage", "format": "double", "x-displayname": "Malicious Bot Percentage.", "x-ves-example": "24.7", "x-f5xc-example": "24.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mobile": { "type": "string", "description": "Number of HTTP requests identified as traffic channel is mobile.", "title": "Mobile", "format": "uint64", "x-displayname": "Mobile", "x-ves-example": "23", "x-f5xc-example": "23", "x-f5xc-description-short": "Number of HTTP requests identified as traffic channel is mobile.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mobile_percentage": { "type": "number", "description": "The percentage of the number of traffic channel:mobile / the total number.", "title": "Mobile Percentage", "format": "double", "x-displayname": "Mobile Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-description-short": "The percentage of the number of traffic channel:mobile / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others": { "type": "string", "description": "Number of HTTP requests identified as other traffic within specified time interval.", "title": "Others", "format": "uint64", "x-displayname": "Others", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Number of HTTP requests identified as other traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others_percentage": { "type": "number", "description": "The percentage of the number of others traffic / the total number.", "title": "Others Percentage", "format": "double", "x-displayname": "Others Percentage.", "x-ves-example": "25.7", "x-f5xc-example": "25.7", "x-f5xc-description-short": "The percentage of the number of others traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_channel": { "type": "string", "description": "The majority of automated traffic channel.", "title": "Traffic Channel", "x-displayname": "The majority of automated traffic channel.", "x-ves-example": "Web", "x-f5xc-example": "Web", "x-f5xc-description-short": "The majority of automated traffic channel.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web": { "type": "string", "description": "Number of HTTP requests identified as traffic channel is web.", "title": "Web", "format": "uint64", "x-displayname": "Web", "x-ves-example": "23", "x-f5xc-example": "23", "x-f5xc-description-short": "Number of HTTP requests identified as traffic channel is web.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web_percentage": { "type": "number", "description": "The percentage of the number of traffic channel:web / the total number.", "title": "Web Percentage", "format": "double", "x-displayname": "Mobile Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-description-short": "The percentage of the number of traffic channel:web / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Total Automation Insight Event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTotalAutomationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewData": { "type": "object", "description": "Data for different traffic type.", "title": "Traffic Overview Data", "x-displayname": "Traffic Overview Data.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewData", "properties": { "previous_request_count": { "type": "string", "description": "Previous Request Count.", "title": "Previous Request Count", "format": "uint64", "x-displayname": "Previous Request Count.", "x-ves-example": "2000", "x-f5xc-wire-name": "previous_reqeust_count", "x-f5xc-example": "2000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_count": { "type": "string", "description": "Number of requests with the specified traffic type.", "title": "Request Count", "format": "uint64", "x-displayname": "Request Count.", "x-ves-example": "2000", "x-f5xc-example": "2000", "x-f5xc-description-short": "Number of requests with the specified traffic type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_sentiment": { "type": "string", "description": "Request Sentiment.", "title": "Request Sentiment", "x-displayname": "Request Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type": { "type": "string", "description": "Traffic Type.", "title": "Traffic Type", "x-displayname": "Traffic Type.", "x-ves-example": "Human, good bot, bad bot, trusted, untrusted, interstitual, others.", "x-f5xc-example": "human, good bot, bad bot, trusted, untrusted, interstitual, others", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "number", "description": "Configuration parameter for trend", "title": "Trend", "format": "double", "x-displayname": "Trend", "x-f5xc-example": "0.3 or null", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewExpandedRequest": { "type": "object", "description": "Request for Shape Bot Defense expanded traffic overview.", "title": "TrafficOverviewExpandedRequest", "x-displayname": "Traffic Overview Expanded Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedRequest", "properties": { "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "limit": { "type": "integer", "description": "Limits the number of transactions returned in the response\nOptional: If not specified, the first 500 transactions that matches the query will be returned in the response.\nThe maximum value for limit is 500.", "title": "Limit", "format": "int64", "x-displayname": "Limit", "x-ves-example": "100", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-example": "100", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "500" }, "x-f5xc-description-short": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be...", "x-f5xc-description-medium": "Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 500, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_host": { "type": "string", "description": "Name of Virtual Host to scope the query.", "title": "Virtual Host Name", "x-displayname": "Virtual Host Name.", "x-ves-example": "Example-app-vh-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-app-vh-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of Virtual Host to scope the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense expanded traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewExpandedRequest", "required_fields": [ "namespace", "virtual_host" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\",\n \"virtual_host\": \"example-app-vh-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1\nvirtual_host: example-app-vh-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewExpandedResponse": { "type": "object", "description": "Response for Shape Bot Defense expanded traffic overview.", "title": "TrafficOverviewExpandedResponse", "x-displayname": "Traffic Overview Expanded Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedResponse", "properties": { "total_transactions": { "type": "string", "description": "Total number of traffic transactions.", "title": "Total transactions\nx-displayName: \"Total transactions\"\nx-example: 1000\nTotal number of traffic transactions", "format": "uint64", "x-displayname": "Total transactions.", "x-f5xc-example": "1000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transactions": { "type": "array", "description": "A list of traffic transactions.", "title": "Transactions", "items": { "$ref": "#/components/schemas/reportingTransaction" }, "x-displayname": "Transactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Shape Bot Defense expanded traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewExpandedResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewExpandedV5Request": { "type": "object", "description": "Request for Shape Bot Defense expanded traffic overview V5.", "title": "TrafficOverviewExpandedV5Request", "x-displayname": "Traffic Overview Expanded V5 Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedV5Request", "properties": { "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingGlobalFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Namespace1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "namespace1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/reportingPagination" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort": { "allOf": [ { "$ref": "#/components/schemas/reportingSortOption" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense expanded traffic overview V5.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewExpandedV5Request", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"namespace1\"\n}", "example_yaml": "namespace: namespace1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewExpandedV5Response": { "type": "object", "description": "Response for Shape Bot Defense expanded traffic overview V5.", "title": "TrafficOverviewExpandedV5Response", "x-displayname": "Traffic Overview Expanded V5 Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewExpandedV5Response", "properties": { "total_transactions": { "type": "string", "description": "Total number of traffic transactions.", "title": "Total transactions\nx-displayName: \"Total transactions\"\nx-example: 108\nTotal number of traffic transactions", "format": "uint64", "x-displayname": "Total transactions.", "x-f5xc-example": "108", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transactions": { "type": "array", "description": "A list of traffic transactions.", "title": "Transactions", "items": { "$ref": "#/components/schemas/reportingTransactionRecord" }, "x-displayname": "Transactions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Shape Bot Defense expanded traffic overview V5.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewExpandedV5Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewRequest": { "type": "object", "description": "Request for Shape Bot Defense traffic overview.", "title": "TrafficOverviewRequest", "x-displayname": "Traffic Overview Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewRequest", "properties": { "category": { "type": "string", "description": "Endpoint category label.", "title": "Category", "x-displayname": "Category", "x-ves-example": "Login", "x-f5xc-example": "Login", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_raw_data": { "type": "boolean", "description": "Optional: by default is false. If use_raw_data = True and referer filter is set,\nthen backend will query raw data.", "title": "Use raw data", "format": "boolean", "x-displayname": "Use raw data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.", "x-f5xc-description-medium": "Optional: by default is false. If use_raw_data = True and referer filter is set, then backend will query raw data.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_host": { "type": "string", "description": "Name of Virtual Host to scope the query.", "title": "Virtual Host Name", "x-displayname": "Virtual Host Name.", "x-ves-example": "Example-app-vh-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-app-vh-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of Virtual Host to scope the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewRequest", "required_fields": [ "namespace", "virtual_host" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\",\n \"virtual_host\": \"example-app-vh-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1\nvirtual_host: example-app-vh-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewResponse": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview.", "title": "TrafficOverviewResponse", "x-displayname": "Traffic Overview Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewResponse", "properties": { "human": { "type": "string", "description": "Number of HTTP requests identified as human traffic within specified time interval.", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic within specified time interval.", "title": "Malicious Bot", "format": "uint64", "x-displayname": "Malicious Bot.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "type": "string", "description": "Total number of HTTP requests within specified time interval.", "title": "Total", "format": "uint64", "x-displayname": "Total", "x-ves-example": "158", "x-f5xc-example": "158", "x-f5xc-description-short": "Total number of HTTP requests within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewTimeseriesResponse": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview timeseries.", "title": "TrafficOverviewTimeseriesResponse", "x-displayname": "Traffic Overview Timeseries Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesResponse", "properties": { "values": { "type": "array", "description": "Traffic overview timeseries.", "title": "Timeseries Values", "items": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesValue" }, "x-displayname": "Timeseries values.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview timeseries.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewTimeseriesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewTimeseriesV2Response": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview timeseries.", "title": "TrafficOverviewTimeseriesV2Response", "x-displayname": "Traffic Overview Timeseries V2 Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV2Response", "properties": { "values": { "type": "array", "description": "Traffic overview timeseries.", "title": "Timeseries Values", "items": { "$ref": "#/components/schemas/reportingTrafficOverviewTimeseriesV2Value" }, "x-displayname": "Timeseries values.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview timeseries.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewTimeseriesV2Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewTimeseriesV2Value": { "type": "object", "description": "Shape Bot Defense traffic overview timeseries V2 value.", "title": "TrafficOverviewTimeseriesV2Data", "x-displayname": "Traffic Overview Timeseries V2 Value.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV2Value", "properties": { "good_bot": { "type": "string", "description": "Number of HTTP requests identified as good bot traffic.", "title": "Good Bot", "format": "uint64", "x-displayname": "Good Bot", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as good bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human": { "type": "string", "description": "Number of HTTP requests identified as human traffic.", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic.", "title": "Malicious Bot", "format": "uint64", "x-displayname": "Malicious Bot.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others": { "type": "string", "description": "Number of HTTP requests identified as others traffic.", "title": "Others", "format": "uint64", "x-displayname": "Others", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as others traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape Bot Defense traffic overview timeseries V2 value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewTimeseriesV2Value", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewTimeseriesV3Response": { "type": "object", "description": "Response that contains Shape Bot Defense traffic type timeseries.", "title": "TrafficOverviewTimeseriesV2Response", "x-displayname": "Traffic Overview Timeseries V3 Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesV3Response", "properties": { "traffic_type_data": { "type": "array", "description": "Traffic type timeseries.", "title": "Traffic Type Data", "items": { "$ref": "#/components/schemas/reportingTimeSeriesGraphMinimalData" }, "x-displayname": "Traffic Type Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic type timeseries.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewTimeseriesV3Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewTimeseriesValue": { "type": "object", "description": "Shape Bot Defense traffic overview timeseries value.", "title": "TrafficOverviewTimeseriesData", "x-displayname": "Traffic Overview Timeseries Value.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewTimeseriesValue", "properties": { "human": { "type": "string", "description": "Number of HTTP requests identified as human traffic.", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic.", "title": "Malicious Bot", "format": "uint64", "x-displayname": "Malicious Bot.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape Bot Defense traffic overview timeseries value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewTimeseriesValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewV2Request": { "type": "object", "description": "Request for Shape Bot Defense traffic overview with global filters.", "title": "TrafficOverviewV2Request", "x-displayname": "Traffic Overview V2 Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV2Request", "properties": { "category": { "type": "string", "description": "Endpoint category label\nOptional: empty by default.", "title": "Category", "maxLength": 128, "x-displayname": "Category", "x-ves-example": "Login", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-example": "Login", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "128" }, "x-f5xc-description-short": "Endpoint category label Optional: empty by default.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to ", "title": "End time", "x-displayname": "End Time", "x-ves-example": "1570197600.", "x-f5xc-example": "1570197600", "x-f5xc-description-short": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "filters": { "allOf": [ { "$ref": "#/components/schemas/reportingGlobalFilters" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace is used to scope the query. Only virtual_host in given namespace will be considered.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of the query period\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "Start time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-f5xc-example": "1570194000", "x-f5xc-description-short": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m...", "x-f5xc-description-medium": "Start time of the query period Format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_raw_data": { "type": "boolean", "description": "Optional: by default is false.", "title": "Use raw data", "format": "boolean", "x-displayname": "Use raw data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request for Shape Bot Defense traffic overview with global filters.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewV2Request", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewV2Response": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview.", "title": "TrafficOverviewV2Response", "x-displayname": "Traffic Overview Response V2.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV2Response", "properties": { "bot_trend": { "type": "number", "description": "Trend of the number of HTTP requests identified as bot traffic.", "title": "Bot Trend", "format": "double", "x-displayname": "Bot Trend", "x-f5xc-example": "0.1 or null", "x-f5xc-description-short": "Trend of the number of HTTP requests identified as bot traffic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot": { "type": "string", "description": "Number of HTTP requests identified as good bot traffic within specified time interval.", "title": "Good Bot", "format": "uint64", "x-displayname": "Good Bot", "x-ves-example": "23", "x-f5xc-example": "23", "x-f5xc-description-short": "Number of HTTP requests identified as good bot traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot_percentage": { "type": "number", "description": "The percentage of the number of good bot traffic / the total number.", "title": "Good Bot Percentage", "format": "double", "x-displayname": "Good Bot Percentage.", "x-ves-example": "25.3", "x-f5xc-example": "25.3", "x-f5xc-description-short": "The percentage of the number of good bot traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot_previous": { "type": "string", "description": "Number of HTTP requests identified as good bot traffic within the previous specified time interval.", "title": "Good Bot in the previous time interval", "format": "uint64", "x-displayname": "Good Bot in last X days.", "x-ves-example": "23", "x-f5xc-example": "23", "x-f5xc-description-short": "Number of HTTP requests identified as good bot traffic within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot_sentiment": { "type": "string", "description": "The sentiment for the trend of good bot traffic.", "title": "Good Bot Sentiment", "x-displayname": "Good Bot Sentiment.", "x-ves-example": "Null", "x-f5xc-example": "null", "x-f5xc-description-short": "The sentiment for the trend of good bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "good_bot_trend": { "type": "number", "description": "Trend of the number of HTTP requests identified as good bot traffic.", "title": "Good Bot Trend", "format": "double", "x-displayname": "Good Bot Trend.", "x-f5xc-example": "0.4 or null", "x-f5xc-description-short": "Trend of the number of HTTP requests identified as good bot traffic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human": { "type": "string", "description": "Number of HTTP requests identified as human traffic within specified time interval.", "title": "Human", "format": "uint64", "x-displayname": "Human", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_percentage": { "type": "number", "description": "The percentage of the number of human traffic / the total number.", "title": "Human Percentage", "format": "double", "x-displayname": "Human Percentage.", "x-ves-example": "24.3", "x-f5xc-example": "24.3", "x-f5xc-description-short": "The percentage of the number of human traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_previous": { "type": "string", "description": "Number of HTTP requests identified as human traffic within the previous specified time interval.", "title": "Human in the previous time interval", "format": "uint64", "x-displayname": "Human in last X days.", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of HTTP requests identified as human traffic within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_sentiment": { "type": "string", "description": "The sentiment for the trend of human traffic.", "title": "Human Sentiment", "x-displayname": "Human Sentiment.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "The sentiment for the trend of human traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "human_trend": { "type": "number", "description": "Trend of the number of HTTP requests identified as human traffic.", "title": "Human Trend", "format": "double", "x-displayname": "Human Trend.", "x-f5xc-example": "0.5 or null", "x-f5xc-description-short": "Trend of the number of HTTP requests identified as human traffic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic within specified time interval.", "title": "Malicious Bot", "format": "uint64", "x-displayname": "Malicious Bot.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_percentage": { "type": "number", "description": "The percentage of the number of malicious bot traffic / the total number.", "title": "Malicious Bot Percentage", "format": "double", "x-displayname": "Malicious Bot Percentage.", "x-ves-example": "24.7", "x-f5xc-example": "24.7", "x-f5xc-description-short": "The percentage of the number of malicious bot traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_previous": { "type": "string", "description": "Number of HTTP requests identified as malicious bot traffic within the previous specified time interval.", "title": "Malicious Bot in the previous time interval", "format": "uint64", "x-displayname": "Malicious Bot in last X days.", "x-ves-example": "25", "x-f5xc-example": "25", "x-f5xc-description-short": "Number of HTTP requests identified as malicious bot traffic within the previous specified time interval.", "x-f5xc-description-medium": "Number of HTTP requests identified as malicious bot traffic within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "malicious_bot_sentiment": { "type": "string", "description": "The sentiment for the trend of malicious bot traffic.", "title": "Malicious Bot Sentiment", "x-displayname": "Malicious Bot Sentiment.", "x-ves-example": "False", "x-f5xc-example": "false", "x-f5xc-description-short": "The sentiment for the trend of malicious bot traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others": { "type": "string", "description": "Number of HTTP requests identified as other traffic within specified time interval.", "title": "Others", "format": "uint64", "x-displayname": "Others", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Number of HTTP requests identified as other traffic within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others_percentage": { "type": "number", "description": "The percentage of the number of others traffic / the total number.", "title": "Others Percentage", "format": "double", "x-displayname": "Others Percentage.", "x-ves-example": "25.7", "x-f5xc-example": "25.7", "x-f5xc-description-short": "The percentage of the number of others traffic / the total number.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others_previous": { "type": "string", "description": "Number of HTTP requests identified as other traffic within the previous specified time interval.", "title": "Others in the previous time interval", "format": "uint64", "x-displayname": "Others in last X days.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Number of HTTP requests identified as other traffic within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "others_trend": { "type": "number", "description": "Trend of the number of HTTP requests identified as other traffic.", "title": "Others Trend", "format": "double", "x-displayname": "Others Trend.", "x-f5xc-example": "0.3 or null", "x-f5xc-description-short": "Trend of the number of HTTP requests identified as other traffic.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "type": "string", "description": "Total number of HTTP requests within specified time interval.", "title": "Total", "format": "uint64", "x-displayname": "Total", "x-ves-example": "158", "x-f5xc-example": "158", "x-f5xc-description-short": "Total number of HTTP requests within specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_previous": { "type": "string", "description": "Total number of HTTP requests within the previous specified time interval.", "title": "total in the previous time interval", "format": "uint64", "x-displayname": "Total in last X days.", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-description-short": "Total number of HTTP requests within the previous specified time interval.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_sentiment": { "type": "string", "description": "The sentiment for the trend of total traffic.", "title": "Total Sentiment", "x-displayname": "Total Sentiment.", "x-f5xc-example": "null", "x-f5xc-description-short": "The sentiment for the trend of total traffic.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_trend": { "type": "number", "description": "Trend of the total number of HTTP requests.", "title": "Total Trend", "format": "double", "x-displayname": "Total Trend.", "x-f5xc-example": "0.3 or null", "x-f5xc-description-short": "Trend of the total number of HTTP requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewV2Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficOverviewV3Response": { "type": "object", "description": "Response that contains Shape Bot Defense traffic overview.", "title": "TrafficOverviewV3Response", "x-displayname": "Traffic Overview Response V3.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficOverviewV3Response", "properties": { "traffic_type_data": { "type": "array", "description": "Traffic Overview.", "title": "Traffic Type Data", "items": { "$ref": "#/components/schemas/reportingTrafficOverviewData" }, "x-displayname": "Traffic Type Data.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that contains Shape Bot Defense traffic overview.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficOverviewV3Response", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTrafficTypeFilter": { "type": "object", "description": "Query Filter by traffic type filter strings.", "title": "Traffic Type Filter", "x-displayname": "Traffic Type Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TrafficTypeFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "traffic_type_strings": { "type": "array", "description": "An list of strings.", "title": "Traffic Type Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "Traffic Type Strings.", "x-ves-example": "['web']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['web']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by traffic type filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTrafficTypeFilter", "required_fields": [ "traffic_type_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"traffic_type_strings\": [\n \"value\"\n ]\n}", "example_yaml": "traffic_type_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTransaction": { "type": "object", "description": "Traffic transaction.", "title": "Transaction", "x-displayname": "Transaction.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.Transaction", "properties": { "action_taken": { "type": "string", "description": "Action Taken Values: Flagged, Blocked, Allow Request, etc.", "title": "x-displayName: \"Action Taken\"\nx-example: \"Flagged\"\nAction Taken Values: Flagged, Blocked, Allow Request, etc", "x-displayname": "Action Taken.", "x-ves-example": "Flagged", "x-f5xc-description-short": "Action Taken Values: Flagged, Blocked, Allow Request, etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "app_type": { "type": "string", "description": "Traffic Channel.", "title": "Traffic Channel", "x-displayname": "Traffic Channel.", "x-ves-example": "Web", "x-f5xc-example": "web", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "as_org": { "type": "string", "description": "Organization name.", "title": "AS Organization", "x-displayname": "AS Organization.", "x-ves-example": "Google LLC.", "x-f5xc-example": "Google LLC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "asn": { "type": "integer", "description": "AS Number", "title": "AS Number", "format": "int64", "x-displayname": "AS Number", "x-ves-example": "713", "x-f5xc-example": "713", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "attack_intent": { "type": "string", "description": "Attack Intent.", "title": "Attack Intent", "x-displayname": "Attack Intent.", "x-ves-example": "Credential Stuffing.", "x-f5xc-example": "Credential Stuffing", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automation_type": { "type": "string", "description": "Malicious Bot Automation Type.", "title": "x-displayName: \"Malicious Bot Automation Type\"\nx-example: \"Token Missing\"\nMalicious Bot Automation Type", "x-displayname": "Malicious Bot Automation Type.", "x-ves-example": "Token Missing.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "country": { "type": "string", "description": "Country name.", "title": "Country", "x-displayname": "Country", "x-ves-example": "US", "x-f5xc-example": "US", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hostname": { "type": "string", "description": "Hostname of attacked app endpoint.", "title": "Hostname", "x-displayname": "Hostname", "x-ves-example": "xyz.example.com.", "x-f5xc-example": "xyz.example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "inference": { "type": "string", "description": "Bot Defense Inference: Human, Automated, Allowlisted, Other.", "title": "x-displayName: \"Main Type\"\nx-example: \"Bot\"\nBot Defense Inference: Human, Automated, Allowlisted, Other", "x-displayname": "Main Type", "x-ves-example": "Bot", "x-f5xc-description-short": "Bot Defense Inference: Human, Automated, Allowlisted, Other.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "inference_sub_type": { "type": "string", "description": "Bot Defense Inference Sub Type: Bad Bot, Trusted Allow, Good Bot.", "title": "x-displayName: \"Sub Type\"\nx-example: \"Bot\"\nBot Defense Inference Sub Type: Bad Bot, Trusted Allow, Good Bot", "x-displayname": "Sub Type", "x-ves-example": "Bot", "x-f5xc-description-short": "Bot Defense Inference Sub Type: Bad Bot, Trusted Allow, Good Bot.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IP Address.", "title": "IP Address", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.103.", "x-f5xc-example": "192.0.2.103", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method": { "type": "string", "description": "HTTP method of attacked app endpoint.", "title": "HTTP Method", "x-displayname": "HTTP Method.", "x-ves-example": "POST", "x-f5xc-example": "POST", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referer": { "type": "string", "description": "Header reference.", "title": "header reference", "x-displayname": "Header reference.", "x-ves-example": "HTTP://192.0.2.101/index.php?", "x-f5xc-example": "http://192.0.2.101/index.php?", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "timestamp": { "type": "string", "description": "Time/Date of the transaction in RFC 3339 format\nFormat: RFC 3339.", "title": "Timestamp", "x-displayname": "Timestamp", "x-ves-example": "2021-09-13T17:27:35.549Z.", "x-f5xc-example": "2021-09-13T17:27:35.549Z", "x-f5xc-description-short": "Time/Date of the transaction in RFC 3339 format Format: RFC 3339.", "format": "date-time", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 20, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d{3})?Z?$", "formatDescription": "ISO 8601 date-time (e.g., 2026-01-19T12:00:00Z)", "validation": { "standard": "ISO 8601" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua": { "type": "string", "description": "User Agent String.", "title": "User Agent String", "x-displayname": "User Agent String.", "x-ves-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0.", "x-f5xc-example": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri": { "type": "string", "description": "URI of attacked app endpoint.", "title": "URI", "x-displayname": "URI", "x-ves-example": "/index.php.", "x-f5xc-example": "/index.php", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTransaction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTransactionField": { "type": "object", "description": "Traffic transaction fields.", "title": "TransactionField", "x-displayname": "TransactionField.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TransactionField", "properties": { "group": { "type": "string", "description": "Group name the field belongs to.", "title": "Group", "x-displayname": "Group", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Field name.", "title": "Name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "type": "string", "description": "Field value.", "title": "Value", "x-displayname": "Value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTransactionField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTransactionRecord": { "type": "object", "description": "Traffic transaction.", "title": "TransactionRecord", "x-displayname": "TransactionRecord.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TransactionRecord", "properties": { "fields": { "type": "array", "description": "Traffic Fields - for example: AS Number, Timestamp, host, etc.", "title": "Transaction Fields", "items": { "$ref": "#/components/schemas/reportingTransactionField" }, "x-displayname": "Transaction Fields.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTransactionRecord", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingTransactionUsageSummaryResponse": { "type": "object", "description": "Response for Transaction Usage Summary.", "title": "TransactionUsageSummaryResponse", "x-displayname": "Response for Transaction Usage Summary.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.TransactionUsageSummaryResponse", "properties": { "records": { "type": "array", "description": "Per month usage summary data.", "title": "Monthly Usage Summary Records", "items": { "$ref": "#/components/schemas/reportingMonthlyUsageSummaryData" }, "x-displayname": "Monthly Usage Summary Records.", "x-f5xc-example": "\"\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingTransactionUsageSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingURIFilter": { "type": "object", "description": "Query Filter by URI filter strings.", "title": "URI Filter", "x-displayname": "URI Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.URIFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "uri_strings": { "type": "array", "description": "An list of strings.", "title": "URI Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "URI Strings.", "x-ves-example": "['/test']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['/test']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingURIFilter", "required_fields": [ "uri_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"uri_strings\": [\n \"value\"\n ]\n}", "example_yaml": "uri_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "reportingUserAgentFilter": { "type": "object", "description": "Query Filter by user agent filter strings.", "title": "User Agent Filter", "x-displayname": "User Agent Filter.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.reporting.UserAgentFilter", "properties": { "op": { "allOf": [ { "$ref": "#/components/schemas/reportingFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ua_strings": { "type": "array", "description": "An unordered list of user agent strings.", "title": "User Agent Strings", "maxItems": 64, "items": { "type": "string" }, "x-displayname": "User Agent Strings.", "x-ves-example": "['Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0']", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "['Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0']", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Query Filter by user agent filter strings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for reportingUserAgentFilter", "required_fields": [ "ua_strings" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ua_strings\": [\n \"value\"\n ]\n}", "example_yaml": "ua_strings:\n- value" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "subscriptionSubscribeRequest__ves_io_schema_shape_bot_defense_subscription": { "type": "object", "description": "Request to subscribe to Shape Bot Defense.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-oneof-field-tier": "[\"standard\"]", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.SubscribeRequest", "properties": { "standard": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to subscribe to Shape Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_shape_bot_defense_subscription": { "type": "object", "description": "Response of subscribe to Shape Bot Defense.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.SubscribeResponse", "x-f5xc-description-short": "Response of subscribe to Shape Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_shape_bot_defense_subscription": { "type": "object", "description": "Request to unsubscribe to Shape Bot Defense.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.UnsubscribeRequest", "x-f5xc-description-short": "Request to unsubscribe to Shape Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_shape_bot_defense_subscription": { "type": "object", "description": "Response of unsubscribe to Shape Bot Defense.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.bot_defense.subscription.UnsubscribeResponse", "x-f5xc-description-short": "Response of unsubscribe to Shape Bot Defense.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "recognizeChannelData": { "type": "object", "description": "Channel Data that represent the data to chart.", "title": "Channel Data", "x-displayname": "Channel Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelData", "properties": { "itemUnit": { "type": "string", "description": "Item Unit", "title": "itemUnit", "x-displayname": "ItemUnit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items in a collection or array", "title": "items", "items": { "$ref": "#/components/schemas/recognizeChannelItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "integer", "description": "Total Items.", "title": "totalItems", "format": "int32", "x-displayname": "TotalItems.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Channel Data that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeChannelData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeChannelItem": { "type": "object", "description": "Channel Item that represent the data to chart.", "title": "Channel Item", "x-displayname": "Channel Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelItem", "properties": { "OBSOLETE2_date": { "type": "integer", "description": "Configuration parameter for OBSOLETE2 date", "title": "OBSOLETE2_date", "format": "int32", "x-displayname": "OBSOLETE2_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE2 date.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_date": { "type": "string", "description": "Configuration parameter for OBSOLETE date", "title": "OBSOLETE_date", "format": "int64", "x-displayname": "OBSOLETE_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "date": { "type": "number", "description": "Configuration parameter for date", "title": "date", "format": "double", "x-displayname": "Date", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firstTime": { "allOf": [ { "$ref": "#/components/schemas/recognizeChannelMWItem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "allOf": [ { "$ref": "#/components/schemas/recognizeChannelMWItem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Channel Item that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeChannelItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeChannelMWItem": { "type": "object", "description": "Enjoy Login Item prevFailedLogin or total.", "title": "Enjoy Login Item", "x-displayname": "Enjoy Login Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelMWItem", "properties": { "mobile": { "type": "number", "description": "Mobile data.", "title": "mobile", "format": "double", "x-displayname": "Mobile", "x-ves-example": "0.0", "x-f5xc-example": "0.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "web": { "type": "number", "description": "Web data", "title": "web", "format": "double", "x-displayname": "Web", "x-ves-example": "0.0", "x-f5xc-example": "0.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Enjoy Login Item prevFailedLogin or total.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeChannelMWItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeChannelRequest": { "type": "object", "description": "Since and to times to generate the Channel Request.", "title": "Channel Request", "x-displayname": "Channel Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the channel data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the channel data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The time since we want the channel data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Channel Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeChannelRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeChannelResponse": { "type": "object", "description": "The data of Channel Response Chart.", "title": "ChannelResponse", "x-displayname": "Channel Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ChannelResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeChannelData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Lift Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeChannelResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeConversionData": { "type": "object", "description": "Conversion Data that represent all the data to fill the chart.", "title": "Conversion Data", "x-displayname": "Conversion Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ConversionData", "properties": { "avgDailyConversion": { "type": "number", "description": "Average Daily Conversion.", "title": "avgDailyConversion", "format": "double", "x-displayname": "AvgDailyConversion.", "x-f5xc-example": "0.016445446197512315", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "avgMonthlyConversion": { "type": "number", "description": "Average Monthly Conversion.", "title": "avgMonthlyConversion", "format": "double", "x-displayname": "AvgMonthlyConversion.", "x-f5xc-example": "0.49336338592536944", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The system unit to represent the data.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "The collection of data to be filled into the chart.", "title": "items", "items": { "$ref": "#/components/schemas/recognizeConversionItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "The collection of data to be filled into the chart.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "description": "See if the chart is after or before extension.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "After", "x-f5xc-example": "after", "x-f5xc-description-short": "See if the chart is after or before extension.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "projectionAnnualConversion": { "type": "number", "description": "Projection Annual Conversion.", "title": "projectionAnnualConversion", "format": "double", "x-displayname": "ProjectionAnnualConversion.", "x-f5xc-example": "6.002587862091994", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "projectionStartTime": { "type": "number", "description": "Projection Start Time.", "title": "projectionStartTime", "format": "double", "x-displayname": "ProjectionStartTime.", "x-f5xc-example": "1642462142000.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "integer", "description": "Total items to be filled into the chart.", "title": "totalItems", "format": "int32", "x-displayname": "TotalItems.", "x-f5xc-example": "363", "x-f5xc-description-short": "Total items to be filled into the chart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "yearToDateConversion": { "type": "number", "description": "Year to date conversion.", "title": "yearToDateConversion", "format": "double", "x-displayname": "YearToDateConversion.", "x-f5xc-example": "5.969696969696971", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conversion Data that represent all the data to fill the chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeConversionData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeConversionItem": { "type": "object", "description": "Conversion Item that represent the data to chart.", "title": "Conversion Item", "x-displayname": "Conversion Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ConversionItem", "properties": { "OBSOLETE2_date": { "type": "integer", "description": "The date of the data to display in chart.", "title": "OBSOLETE2_date", "format": "int32", "x-displayname": "OBSOLETE2_date.", "x-f5xc-example": "1638921600000", "x-f5xc-description-short": "The date of the data to display in chart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_date": { "type": "string", "description": "The date of the data to display in chart.", "title": "OBSOLETE_date", "format": "int64", "x-displayname": "Date", "x-f5xc-example": "OBSOLETE_date", "x-f5xc-description-short": "The date of the data to display in chart.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "count": { "type": "number", "description": "The quantity data to display.", "title": "count", "format": "double", "x-displayname": "Count", "x-ves-example": "0.2727272727272728.", "x-f5xc-example": "0.2727272727272728", "x-f5xc-constraints": { "constraintType": "number", "category": "general", "minimum": 0, "maximum": 10000, "multipleOf": 1, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "date": { "type": "number", "description": "The date of the data to display in chart.", "title": "date", "format": "double", "x-displayname": "Date", "x-f5xc-example": "1638921600000", "x-f5xc-description-short": "The date of the data to display in chart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conversion Item that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeConversionItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeConversionRequest": { "type": "object", "description": "Since and to times to generate the Conversion request.", "title": "ConversionRequest", "x-displayname": "Conversion Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ConversionRequest", "properties": { "agent": { "type": "string", "description": "Agent data.", "title": "agent", "x-displayname": "Agent", "x-ves-example": "F5cs", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "f5cs", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "endTime": { "type": "string", "description": "The time to we want the conversion data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The time to we want the conversion data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the conversion data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The time since we want the conversion data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "tenant": { "type": "string", "description": "Tenant data.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Miguel", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "miguel", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Since and to times to generate the Conversion request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeConversionRequest", "required_fields": [ "agent", "endTime", "startTime", "tenant" ], "mutually_exclusive_groups": [], "example_json": "{\n \"agent\": \"f5cs\",\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\",\n \"tenant\": \"miguel\"\n}", "example_yaml": "agent: f5cs\nendTime: '1639008000000'\nstartTime: '1607558400000'\ntenant: miguel" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeConversionResponse": { "type": "object", "description": "The data of Conversion Response Chart.", "title": "ConversionResponse", "x-displayname": "Conversion Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ConversionResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "apiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeConversionData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Conversion Response.", "title": "id", "x-displayname": "ID", "x-ves-example": "C85b106cef1043c486651aa072c7b593.", "x-f5xc-example": "c85b106cef1043c486651aa072c7b593", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeConversionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeEnjoyData": { "type": "object", "description": "Enjoy Data that represent the data to chart.", "title": "Enjoy Data", "x-displayname": "Enjoy Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyData", "properties": { "itemUnit": { "type": "string", "description": "Item Unit", "title": "itemUnit", "x-displayname": "ItemUnit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items in a collection or array", "title": "items", "items": { "$ref": "#/components/schemas/recognizeEnjoyItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "integer", "description": "Total Items.", "title": "totalItems", "format": "int32", "x-displayname": "TotalItems.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Enjoy Data that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeEnjoyData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeEnjoyItem": { "type": "object", "description": "Enjoy Item that represent the data to chart.", "title": "Enjoy Item", "x-displayname": "Enjoy Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyItem", "properties": { "OBSOLETE2_date": { "type": "integer", "description": "Configuration parameter for OBSOLETE2 date", "title": "OBSOLETE2_date", "format": "int32", "x-displayname": "OBSOLETE2_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE2 date.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_date": { "type": "string", "description": "Configuration parameter for OBSOLETE date", "title": "OBSOLETE_date", "format": "int64", "x-displayname": "OBSOLETE_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "date": { "type": "number", "description": "Configuration parameter for date", "title": "date", "format": "double", "x-displayname": "Date", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prevFailedLogin": { "allOf": [ { "$ref": "#/components/schemas/recognizeEnjoyLoginItem" } ], "x-f5xc-description-short": "Configuration parameter for prevFailedLogin.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total": { "allOf": [ { "$ref": "#/components/schemas/recognizeEnjoyLoginItem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Enjoy Item that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeEnjoyItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeEnjoyLoginItem": { "type": "object", "description": "Enjoy Login Item prevFailedLogin or total.", "title": "Enjoy Login Item", "x-displayname": "Enjoy Login Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyLoginItem", "properties": { "converted": { "type": "number", "description": "Converted data.", "title": "converted", "format": "double", "x-displayname": "Converted", "x-ves-example": "110.0", "x-f5xc-example": "110.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "notConverted": { "type": "number", "description": "No converted data.", "title": "notConverted", "format": "double", "x-displayname": "NotConverted.", "x-ves-example": "101.0", "x-f5xc-example": "101.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Enjoy Login Item prevFailedLogin or total.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeEnjoyLoginItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeEnjoyRequest": { "type": "object", "description": "Since and to times to generate the Enjoy Request.", "title": "Enjoy Request", "x-displayname": "Enjoy Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the enjoy data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the enjoy data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Enjoy Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeEnjoyRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeEnjoyResponse": { "type": "object", "description": "The data of Enjoy Response Chart.", "title": "EnjoyResponse", "x-displayname": "Enjoy Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.EnjoyResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeEnjoyData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Lift Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeEnjoyResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionAggregationData": { "type": "object", "description": "Friction Aggregation Data that represent the data to chart.", "title": "Friction Aggregation Data", "x-displayname": "Channel Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionAggregationData", "properties": { "finalSuccessTotal": { "type": "number", "description": "FinalSuccessTotal.", "title": "finalSuccessTotal", "format": "double", "x-displayname": "FinalSuccessTotal.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firstSuccessTotal": { "type": "number", "description": "FirstSuccessTotal.", "title": "firstSuccessTotal", "format": "double", "x-displayname": "FirstSuccessTotal.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "Item Unit", "title": "itemUnit", "x-displayname": "ItemUnit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "noSuccessTotal": { "type": "number", "description": "NoSuccessTotal.", "title": "noSuccessTotal", "format": "double", "x-displayname": "NoSuccessTotal.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spareables": { "type": "array", "description": "Spareables.", "title": "spareables", "items": { "$ref": "#/components/schemas/recognizeFrictionAggregationItem" }, "x-displayname": "Spareables.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "number", "description": "TotalItems.", "title": "totalItems", "format": "double", "x-displayname": "TotalItems.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Friction Aggregation Data that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionAggregationData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionAggregationItem": { "type": "object", "description": "Friction Aggregation Spareable Item data to fill the chart.", "title": "Friction Aggregation Item", "x-displayname": "Friction Aggregation Spareable Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionAggregationItem", "properties": { "finalSuccess": { "type": "number", "description": "FinalSuccess.", "title": "finalSuccess", "format": "double", "x-displayname": "FinalSuccess.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firstSuccess": { "type": "number", "description": "FirstSuccess.", "title": "firstSuccess", "format": "double", "x-displayname": "FirstSuccess.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "noSuccess": { "type": "number", "description": "NoSuccess", "title": "noSuccess", "format": "double", "x-displayname": "NoSuccess", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upperBound": { "type": "number", "description": "UpperBound.", "title": "upperBound", "format": "double", "x-displayname": "UpperBound.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Friction Aggregation Spareable Item data to fill the chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionAggregationItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionAggregationRequest": { "type": "object", "description": "Since and to times to generate the Friction Aggregation Request.", "title": "Friction Aggregation Request", "x-displayname": "Friction Aggregation Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionAggregationRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the channel data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the channel data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The time since we want the channel data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Friction Aggregation Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionAggregationRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionAggregationResponse": { "type": "object", "description": "The data of Friction Aggregation Response Chart.", "title": "Fricction Aggregation Response", "x-displayname": "Friction Aggregation Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionAggregationResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeFrictionAggregationData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Lift Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The data of Friction Aggregation Response Chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionAggregationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionHistogramData": { "type": "object", "description": "Friction Histogram Data that represent the data to chart.", "title": "Friction Histogram Data", "x-displayname": "Friction Histogram Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionHistogramData", "properties": { "itemUnit": { "type": "string", "description": "Item Unit", "title": "itemUnit", "x-displayname": "ItemUnit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items in a collection or array", "title": "items", "items": { "$ref": "#/components/schemas/recognizeFrictionHistogramItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "number", "description": "TotalItems.", "title": "totalItems", "format": "double", "x-displayname": "TotalItems.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Friction Histogram Data that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionHistogramData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionHistogramItem": { "type": "object", "description": "Friction Histogram Spareable Item data to fill the chart.", "title": "Friction Histogram Item", "x-displayname": "Friction Histogram Spareable Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionHistogramItem", "properties": { "OBSOLETE2_date": { "type": "integer", "description": "Configuration parameter for OBSOLETE2 date", "title": "OBSOLETE2_date", "format": "int32", "x-displayname": "OBSOLETE2_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE2 date.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_date": { "type": "string", "description": "Configuration parameter for OBSOLETE date", "title": "OBSOLETE_date", "format": "int64", "x-displayname": "OBSOLETE_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "date": { "type": "number", "description": "Configuration parameter for date", "title": "date", "format": "double", "x-displayname": "Date", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "directResetPw": { "type": "number", "description": "DirectResetPw.", "title": "directResetPw", "format": "double", "x-displayname": "DirectResetPw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalSuccess": { "type": "number", "description": "FinalSuccess.", "title": "finalSuccess", "format": "double", "x-displayname": "FinalSuccess.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "firstSuccess": { "type": "number", "description": "FirstSuccess.", "title": "firstSuccess", "format": "double", "x-displayname": "FirstSuccess.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "loginFailResetPw": { "type": "number", "description": "LoginFailResetPw.", "title": "loginFailResetPw", "format": "double", "x-displayname": "LoginFailResetPw.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "noSuccess": { "type": "number", "description": "NoSuccess", "title": "noSuccess", "format": "double", "x-displayname": "NoSuccess", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nonRecogUser": { "type": "number", "description": "NonRecogUser.", "title": "nonRecogUser", "format": "double", "x-displayname": "NonRecogUser.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "recogUser": { "type": "number", "description": "RecogUser", "title": "recogUser", "format": "double", "x-displayname": "RecogUser", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Friction Histogram Spareable Item data to fill the chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionHistogramItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionHistogramRequest": { "type": "object", "description": "Since and to times to generate the Friction Histogram Request.", "title": "Friction Histogram Request", "x-displayname": "Friction Histogram Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionHistogramRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the channel data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000001.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000001", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the channel data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400001.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400001", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The time since we want the channel data.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Friction Histogram Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionHistogramRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000001\",\n \"startTime\": \"1607558400001\"\n}", "example_yaml": "endTime: '1639008000001'\nstartTime: '1607558400001'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeFrictionHistogramResponse": { "type": "object", "description": "The data of Friction Histogram Response.", "title": "Friction Histogram Response", "x-displayname": "Friction Histogram Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.FrictionHistogramResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeFrictionHistogramData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Lift Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "The data of Friction Histogram Response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeFrictionHistogramResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeGetStatusProvisionResponse": { "type": "object", "description": "Provision struct response\nGetStatusProvisionResponse.", "title": "GetStatusProvisionResponse", "x-displayname": "Struct of the Provision Status.", "x-ves-proto-message": "ves.io.schema.shape.recognize.GetStatusProvisionResponse", "properties": { "code": { "type": "number", "description": "Configuration parameter for code", "title": "Code", "format": "double", "x-displayname": "202", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status", "title": "Status", "x-displayname": "Fail", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Provision struct response GetStatusProvisionResponse.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeGetStatusProvisionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeGetStatusResponse": { "type": "object", "description": "Any payload to be return by GET Provision API.", "title": "GetStatusResponse", "x-displayname": "Recognize Provision Status Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.GetStatusResponse", "properties": { "apiVersion": { "type": "string", "description": "Provision API Version.", "title": "ApiVersion", "x-ves-example": "V1", "x-f5xc-example": "v1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bid": { "type": "string", "description": "Backend identifier.", "title": "Bid", "x-displayname": "Bid", "x-ves-example": "Test-N307-b9b88d00.", "x-f5xc-example": "test-N307-b9b88d00", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeGetStatusProvisionResponse" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID response.", "title": "Id", "x-ves-example": "Fa959ceb5e4745ada89e1d919bde7fd9.", "x-f5xc-example": "fa959ceb5e4745ada89e1d919bde7fd9", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src": { "type": "string", "description": "Javascript tag src attribute.", "title": "Src", "x-ves-example": "https://us.dev.zeronaught.com/__imp_apg__/js/abc.js.", "x-f5xc-example": "https://us.dev.zeronaught.com/__imp_apg__/js/abc.js", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tag": { "type": "string", "description": "Javascript tag injected to URL paths that user configures.", "title": "Tag", "x-displayname": "Tag", "x-ves-example": "<script async defer src=\\\"https://us.dev.zeronaught.com/__imp_apg__/js/abc.js\\\"></script>", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "Javascript tag injected to URL paths that user configures.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by GET Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeGetStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeHealthResponse": { "type": "object", "description": "HealthResponse.", "title": "Health Response", "x-displayname": "HealthResponse.", "x-ves-proto-message": "ves.io.schema.shape.recognize.HealthResponse", "properties": { "message": { "type": "string", "description": "Message", "title": "Message", "x-displayname": "Message", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeHealthResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeLiftControlItem": { "type": "object", "description": "Lift Control Item absolute or relative.", "title": "Lift Control Item", "x-displayname": "Lift Control Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.LiftControlItem", "properties": { "control": { "type": "number", "description": "Control data.", "title": "control", "format": "double", "x-displayname": "Control", "x-ves-example": "0.14545454545454545.", "x-f5xc-example": "0.14545454545454545", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "extended": { "type": "number", "description": "Extended data.", "title": "extended", "format": "double", "x-displayname": "Extended", "x-ves-example": "0.16", "x-f5xc-example": "0.16", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeLiftControlItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeLiftData": { "type": "object", "description": "Lift Data that represent the data to chart.", "title": "Lift Data", "x-displayname": "Lift Data", "x-ves-proto-message": "ves.io.schema.shape.recognize.LiftData", "properties": { "avgAbsoluteLift": { "type": "number", "description": "Average Absolute Lift.", "title": "avgAbsoluteLift", "format": "double", "x-displayname": "AvgAbsoluteLift.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "avgRelativeLift": { "type": "number", "description": "Average Relative Lift.", "title": "avgRelativeLift", "format": "double", "x-displayname": "AvgRelativeLift.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "Item Unit", "title": "itemUnit", "x-displayname": "ItemUnit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items in a collection or array", "title": "items", "items": { "$ref": "#/components/schemas/recognizeLiftItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "integer", "description": "Total Items.", "title": "totalItems", "format": "int32", "x-displayname": "TotalItems.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Lift Data that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeLiftData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeLiftItem": { "type": "object", "description": "Lift Item that represent the data to chart.", "title": "Lift Item", "x-displayname": "Lift Item", "x-ves-proto-message": "ves.io.schema.shape.recognize.LiftItem", "properties": { "OBSOLETE2_date": { "type": "integer", "description": "Configuration parameter for OBSOLETE2 date", "title": "OBSOLETE2_date", "format": "int32", "x-displayname": "OBSOLETE2_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE2 date.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_date": { "type": "string", "description": "Configuration parameter for OBSOLETE date", "title": "OBSOLETE_date", "format": "int64", "x-displayname": "OBSOLETE_date.", "x-f5xc-description-short": "Configuration parameter for OBSOLETE date.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "absolute": { "allOf": [ { "$ref": "#/components/schemas/recognizeLiftControlItem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "date": { "type": "number", "description": "Configuration parameter for date", "title": "date", "format": "double", "x-displayname": "Date", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "relative": { "allOf": [ { "$ref": "#/components/schemas/recognizeLiftControlItem" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Lift Item that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeLiftItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeLiftRequest": { "type": "object", "description": "Since and to times to generate the Lift Request.", "title": "Lift Request", "x-displayname": "Lift Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.LiftRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the lift data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the lift data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Lift Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeLiftRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeLiftResponse": { "type": "object", "description": "The data of Lift Response Chart.", "title": "LiftResponse", "x-displayname": "Lift Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.LiftResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeLiftData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Lift Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeLiftResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeRescueData": { "type": "object", "description": "Rescue Data that represent all the data to fill the chart.", "title": "Rescue Data", "x-displayname": "Rescue Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.RescueData", "properties": { "OBSOLETE2_endTime": { "type": "integer", "description": "End Time", "title": "endTime", "format": "int32", "x-displayname": "EndTime", "x-f5xc-example": "1639008000000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE2_startTime": { "type": "integer", "description": "Start Time.", "title": "OBSOLETE2_startTime", "format": "int32", "x-displayname": "OBSOLETE2_startTime.", "x-f5xc-example": "1607558400000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_endTime": { "type": "string", "description": "End Time", "title": "OBSOLETE_endTime", "format": "int64", "x-displayname": "OBSOLETE_endTime.", "x-ves-example": "1639008000000.", "x-f5xc-example": "1639008000000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_startTime": { "type": "string", "description": "Start Time.", "title": "OBSOLETE_startTime", "format": "int64", "x-displayname": "OBSOLETE_startTime.", "x-ves-example": "1607558400000.", "x-f5xc-example": "1607558400000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "abandonLoginCount": { "type": "number", "description": "Abandon Login Count.", "title": "abandonLoginCount", "format": "double", "x-displayname": "AbandonLoginCount.", "x-ves-example": "0.0", "x-f5xc-example": "0.0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "endTime": { "type": "number", "description": "End Time", "title": "endTime", "format": "double", "x-displayname": "EndTime", "x-f5xc-example": "1639008000000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The system unit to represent the data.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "The collection of data to be filled into the chart.", "title": "items", "items": { "$ref": "#/components/schemas/recognizeRescueItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "The collection of data to be filled into the chart.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "kind": { "type": "string", "description": "See if the chart is after or before extension.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "After", "x-f5xc-example": "after", "x-f5xc-description-short": "See if the chart is after or before extension.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "noBenefit": { "type": "number", "description": "No Benefit.", "title": "noBenefit", "format": "double", "x-displayname": "NoBenefit", "x-ves-example": "0.10648148148148148.", "x-f5xc-example": "0.10648148148148148", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "number", "description": "Start Time.", "title": "startTime", "format": "double", "x-displayname": "StartTime", "x-f5xc-example": "1607558400000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "totalItems": { "type": "integer", "description": "Total items to be filled into the chart.", "title": "totalItems", "format": "int32", "x-displayname": "TotalItems.", "x-ves-example": "18", "x-f5xc-example": "18", "x-f5xc-description-short": "Total items to be filled into the chart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Rescue Data that represent all the data to fill the chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeRescueData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeRescueItem": { "type": "object", "description": "Conversion Item that represent the data to chart.", "title": "Rescue Item", "x-displayname": "Rescue Item.", "x-ves-proto-message": "ves.io.schema.shape.recognize.RescueItem", "properties": { "OBSOLETE2_upperBound": { "type": "integer", "description": "The upperBound data.", "title": "OBSOLETE2_upperBound", "format": "int32", "x-displayname": "OBSOLETE2_upperBound.", "x-f5xc-example": "0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_upperBound": { "type": "string", "description": "The upperBound data.", "title": "OBSOLETE_upperBound", "format": "int64", "x-displayname": "OBSOLETE_upperBound.", "x-f5xc-wire-name": "OBSOLOTE_upperBound", "x-f5xc-example": "0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upperBound": { "type": "number", "description": "The upperBound data.", "title": "upperBound", "format": "double", "x-displayname": "UpperBound.", "x-f5xc-example": "0", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "number", "description": "The value of the data to display in chart.", "title": "value", "format": "double", "x-displayname": "Value", "x-f5xc-example": "110.0", "x-f5xc-description-short": "The value of the data to display in chart.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Conversion Item that represent the data to chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeRescueItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeRescueRequest": { "type": "object", "description": "Since and to times to generate the Rescue Request.", "title": "Rescue Request", "x-displayname": "Rescue Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.RescueRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the rescue data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "itemUnit": { "type": "string", "description": "The unit where the data is represented.", "title": "itemUnit", "x-displayname": "ItemUnit", "x-ves-example": "D", "x-f5xc-example": "d", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the rescue data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Since and to times to generate the Rescue Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeRescueRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeRescueResponse": { "type": "object", "description": "The data of Rescue Response Chart.", "title": "RescueResponse", "x-displayname": "Rescue Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.RescueResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeRescueData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Rescue Response.", "title": "Id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeRescueResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeStateData": { "type": "object", "description": "The data of State Data.", "title": "StateData", "x-displayname": "State Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.StateData", "properties": { "OBSOLETE2_jsDetectedTime": { "type": "string", "description": "The detected time.", "title": "OBSOLETE2_jsDetectedTime", "format": "int64", "x-displayname": "JsDetectedTime.", "x-f5xc-example": "1639008000000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE2_recommendationConsumptionTime": { "type": "string", "description": "The recommendation consumption time.", "title": "OBSOLETE2_recommendationConsumptionTime", "format": "int64", "x-displayname": "RecommendationConsumptionTime.", "x-f5xc-example": "1639008000000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_jsDetectedTime": { "type": "string", "description": "The detected time.", "title": "OBSOLETE_jsDetectedTime", "x-displayname": "OBSOLETE_jsDetectedTime.", "x-ves-example": "1639008000000.", "x-f5xc-example": "1639008000000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "OBSOLETE_recommendationConsumptionTime": { "type": "string", "description": "The recommendation consumption time.", "title": "OBSOLETE_recommendationConsumptionTime", "x-displayname": "OBSOLETE_recommendationConsumptionTime.", "x-ves-example": "1639008000000.", "x-f5xc-example": "1639008000000", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "code": { "type": "integer", "description": "The code response.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "200", "x-f5xc-example": "200", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dashboardState": { "type": "string", "description": "The conversion data to fill the chart.", "title": "dashboardState", "x-displayname": "DashboardState.", "x-ves-example": "After", "x-f5xc-example": "after", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "jsDetectedTime": { "type": "number", "description": "The detected time.", "title": "jsDetectedTime", "format": "double", "x-displayname": "JsDetectedTime.", "x-f5xc-example": "1639008000000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "recommendationConsumptionTime": { "type": "number", "description": "The recommendation consumption time.", "title": "recommendationConsumptionTime", "format": "double", "x-displayname": "RecommendationConsumptionTime.", "x-f5xc-example": "1639008000000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeStateData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeStateResponse": { "type": "object", "description": "The data of State Response.", "title": "StateResponse", "x-displayname": "State Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.StateResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "apiVersion", "x-displayname": "ApiVersion.", "x-f5xc-description-short": "The actual version of the shape recognize API.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeStateData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the State Response.", "title": "id", "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeStateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeSubscribeRequest": { "type": "object", "description": "Any payload to be passed on the Subscribe API.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.SubscribeRequest", "x-f5xc-description-short": "Any payload to be passed on the Subscribe API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeSubscribeResponse": { "type": "object", "description": "Any payload to be returned by Subscribe API.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.SubscribeResponse", "x-f5xc-description-short": "Any payload to be returned by Subscribe API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeTopReasonCodesData": { "type": "object", "description": "Top Reason Codes Data that represent all the data to fill the chart.", "title": "Top Reason Codes Data", "x-displayname": "Top Reason Codes Data.", "x-ves-proto-message": "ves.io.schema.shape.recognize.TopReasonCodesData", "properties": { "LOE": { "type": "number", "description": "Lack of Evidence.", "title": "LOE", "format": "double", "x-displayname": "LOE", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "LSBH": { "type": "number", "description": "Lack of safe browsing history.", "title": "LSBH", "format": "double", "x-displayname": "LSBH", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "MUD": { "type": "number", "description": "Multi User Device.", "title": "MUD", "format": "double", "x-displayname": "MUD", "x-ves-example": "250", "x-f5xc-example": "250", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "SH": { "type": "number", "description": "Short History.", "title": "SH", "format": "double", "x-displayname": "SH", "x-ves-example": "50", "x-f5xc-example": "50", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prevTotal": { "type": "number", "description": "Previews Total.", "title": "prevTotal", "format": "double", "x-displayname": "PrevTotal", "x-ves-example": "5000", "x-f5xc-example": "5000", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Top Reason Codes Data that represent all the data to fill the chart.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeTopReasonCodesData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeTopReasonCodesRequest": { "type": "object", "description": "Top Reason Codes Request.", "title": "TopReasonCodesRequest", "x-displayname": "TopReasonCodesRequest.", "x-ves-proto-message": "ves.io.schema.shape.recognize.TopReasonCodesRequest", "properties": { "endTime": { "type": "string", "description": "The time to we want the rescue data.", "title": "endTime", "format": "int64", "x-displayname": "EndTime", "x-ves-example": "1639008000000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1639008000000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "startTime": { "type": "string", "description": "The time since we want the rescue data.", "title": "startTime", "format": "int64", "x-displayname": "StartTime", "x-ves-example": "1607558400000.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "1607558400000", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "int64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeTopReasonCodesRequest", "required_fields": [ "endTime", "startTime" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endTime\": \"1639008000000\",\n \"startTime\": \"1607558400000\"\n}", "example_yaml": "endTime: '1639008000000'\nstartTime: '1607558400000'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeTopReasonCodesResponse": { "type": "object", "description": "The data of Top Reason Codes Response.", "title": "TopReasonCodesResponse", "x-displayname": "Top Reason Codes Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.TopReasonCodesResponse", "properties": { "apiVersion": { "type": "string", "description": "The actual version of the shape recognize API.", "title": "ApiVersion", "maxLength": 16, "x-displayname": "ApiVersion.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-description-short": "The actual version of the shape recognize API.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "data": { "allOf": [ { "$ref": "#/components/schemas/recognizeTopReasonCodesData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "The ID from the Rescue Response.", "title": "Id", "maxLength": 256, "x-displayname": "ID", "x-ves-example": "B841c67034d248e7906a81ecccc90218.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "b841c67034d248e7906a81ecccc90218", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeTopReasonCodesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeUnsubscribeRequest": { "type": "object", "description": "Any payload to be passed on the Unsubscribe API.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.UnsubscribeRequest", "x-f5xc-description-short": "Any payload to be passed on the Unsubscribe API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeUnsubscribeResponse": { "type": "object", "description": "Any payload to be returned by Unsubscribe API.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.shape.recognize.UnsubscribeResponse", "x-f5xc-description-short": "Any payload to be returned by Unsubscribe API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeValidateSrcTagInjectionRequest": { "type": "object", "description": "Request to verify shape recognize src tag injection.", "title": "ValidateSrcTagInjectionRequest", "x-displayname": "Validate SrcTagInjection Request.", "x-ves-proto-message": "ves.io.schema.shape.recognize.ValidateSrcTagInjectionRequest", "properties": { "src": { "type": "string", "description": "Content to be present in customer webpage's source.", "title": "Src", "x-displayname": "Src", "x-ves-example": "``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Content to be present in customer webpage's source.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "url": { "type": "string", "description": "Target webpage to check src tag injection.", "title": "Url", "x-displayname": "URL", "x-ves-example": "``https://www.example.com``", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri": "true" }, "x-f5xc-example": "``https://www.example.com``", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri": "true" }, "x-f5xc-description-short": "Target webpage to check src tag injection.", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to verify shape recognize src tag injection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeValidateSrcTagInjectionRequest", "required_fields": [ "src", "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"src\": \"``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``\",\n \"url\": \"``https://www.example.com``\"\n}", "example_yaml": "src: '``https://us.dev.zeronaught.com/__imp_apg__/js/abc.js``'\nurl: '``https://www.example.com``'" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "recognizeValidateSrcTagInjectionResponse": { "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.recognize.ValidateSrcTagInjectionResponse", "properties": { "isInjected": { "type": "boolean", "description": "Status about src script tag injected in customer's webpage.", "title": "IsInjected", "format": "boolean", "x-displayname": "IsInjected.", "x-f5xc-example": "true", "x-f5xc-description-short": "Status about src script tag injected in customer's webpage.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "The error string if not injected.", "title": "Message", "x-displayname": "Message", "x-ves-example": "Unreachable.", "x-f5xc-example": "unreachable", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to indicate whether customer webpage has custom script tag to track devices been injected or not.", "x-f5xc-description-medium": "Response to indicate whether customer webpage has custom script tag to track devices been injected or not.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for recognizeValidateSrcTagInjectionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeBlockAuditCsvResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Block Audit CSV API.", "title": "GetSafeBlockAuditCsvResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeBlockAuditCsvResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Block Audit CSV API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeBlockAuditCsvResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeBlockAuditResponse": { "type": "object", "description": "Any payload to be return by Safe Block audit API.", "title": "GetSafeBlockAuditResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeBlockAuditResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe Block audit API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeBlockAuditResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeBlockDetailsResponse": { "type": "object", "description": "Any payload to be return by Safe SAS block details API.", "title": "GetSafeBlockDetailsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeBlockDetailsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS block details API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeBlockDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeBlockTableCsvResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Block Table CSV API.", "title": "GetSafeBlockTableCsvResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeBlockTableCsvResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Block Table CSV API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeBlockTableCsvResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeBlockTableResponse": { "type": "object", "description": "Any payload to be return by Safe Block list table API.", "title": "GetSafeBlockTableResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeBlockTableResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe Block list table API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeBlockTableResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeGeneralResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "GetSafeGeneralResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeGeneralResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeGeneralResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeSummaryResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Summary API.", "title": "GetSafeSummaryResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeSummaryResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Summary API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safeGetSafeTransactionDetailsResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Transaction Details API.", "title": "GetSafeTransactionDetailsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.GetSafeTransactionDetailsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Transaction Details API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safeGetSafeTransactionDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostFeedbackRequest": { "type": "object", "title": "PostFeedbackRequest", "x-displayname": "Safe SAS feedback request.", "x-ves-proto-message": "ves.io.schema.shape.safe.PostFeedbackRequest", "properties": { "comment": { "type": "string", "description": "Transaction Comment.", "title": "Transaction Comment", "maxLength": 2048, "x-displayname": "Transaction Comment.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "feedback": { "type": "string", "description": "Transaction Feedback.", "title": "Transaction Feedback", "maxLength": 64, "x-displayname": "Transaction Feedback.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "transaction_id": { "type": "string", "description": "Transaction identifier.", "title": "Transaction Id", "maxLength": 256, "x-displayname": "Transaction ID.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostFeedbackRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostFeedbackResponse": { "type": "object", "title": "PostFeedback", "x-displayname": "Safe SAS feedback response.", "x-ves-proto-message": "ves.io.schema.shape.safe.PostFeedbackResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostFeedbackResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostGeneralFeedbackRequest": { "type": "object", "description": "Any payload to be passed on the Safe SAS Transactions CSV API.", "title": "PostGeneralFeedbackRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostGeneralFeedbackRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "maximum": 512, "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-example": "cGF5bG9hZAo=", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512" }, "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512, "format": "byte", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions CSV API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostGeneralFeedbackRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostGeneralFeedbackResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Transaction Details API.", "title": "PostGeneralFeedbackResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostGeneralFeedbackResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Transaction Details API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostGeneralFeedbackResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeBlockFeedbackRequest": { "type": "object", "description": "Any payload to be passed on the Safe Block Feedback POST API.", "title": "PostSafeBlockFeedbackRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockFeedbackRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Block Feedback POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeBlockFeedbackRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeBlockFeedbackResponse": { "type": "object", "description": "Any payload to be return by POST API.", "title": "PostSafeBlockFeedbackResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockFeedbackResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeBlockFeedbackResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeBlockRuleRequest": { "type": "object", "description": "Any payload to be passed on the Safe Block Rule POST API.", "title": "PostSafeBlockRuleRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockRuleRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Block Rule POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeBlockRuleRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeBlockRuleResponse": { "type": "object", "description": "Any payload to be return by POST API.", "title": "PostSafeBlockRuleResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeBlockRuleResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeBlockRuleResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeEpRequest": { "type": "object", "description": "Any payload to be passed on the Safe Ep POST API.", "title": "PostSafeEpRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeEpRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The ep name.", "title": "Name", "maxLength": 256, "x-displayname": "Requested Ep name.", "x-ves-example": "Transactions.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "transactions", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Ep POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeEpRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeEpResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeEpResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeEpResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeEpResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeOverviewRequest": { "type": "object", "description": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.", "title": "PostSafeOverviewRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeOverviewRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeOverviewRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeOverviewResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeOverviewResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeOverviewResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeOverviewResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeProvisionRequest": { "type": "object", "description": "Any payload to be passed on the Safe Provision POST API.", "title": "PostSafeProvisionRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeProvisionRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Provision POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeProvisionRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeProvisionResponse": { "type": "object", "description": "Any payload to be return by POST API.", "title": "PostSafeProvisionResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeProvisionResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeProvisionResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeStatsRequest": { "type": "object", "description": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.", "title": "PostSafeStatsRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeStatsRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Breakdown POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeStatsRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionDetailsRequest": { "type": "object", "description": "Any payload to be passed on the Safe Transactions Details POST API.", "title": "PostSafeTransactionDetailsRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDetailsRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Details POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionDetailsRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionDetailsResponse": { "type": "object", "description": "Any payload to be return by POST API.", "title": "PostSafeTransactionDetailsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDetailsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionDeviceHistoryRequest": { "type": "object", "description": "Any payload to be passed on the Safe Transactions Device Hisotry POST API.", "title": "PostSafeTransactionDeviceHistoryRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDeviceHistoryRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Device Hisotry POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionDeviceHistoryRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionDeviceHistoryResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeTransactionDeviceHistoryResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionDeviceHistoryResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionDeviceHistoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionLocationsRequest": { "type": "object", "description": "Any payload to be passed on the Safe Transactions Location POST API.", "title": "PostSafeTransactionLocationsRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionLocationsRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Location POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionLocationsRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionLocationsResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeTransactionLocationsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionLocationsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionLocationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionRelatedSessionsRequest": { "type": "object", "description": "Any payload to be passed on the Safe Transactions Related Sessions POST API.", "title": "PostSafeTransactionRelatedSessionsRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionRelatedSessionsRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Related Sessions POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionRelatedSessionsRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionRelatedSessionsResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeTransactionRelatedSessionsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionRelatedSessionsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionRelatedSessionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionTimelineRequest": { "type": "object", "description": "Any payload to be passed on the Safe Transactions Timeline POST API.", "title": "PostSafeTransactionTimelineRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionTimelineRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Transactions Timeline POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionTimelineRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionTimelineResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeTransactionTimelineResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionTimelineResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionTimelineResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsCsvRequest": { "type": "object", "description": "Any payload to be passed on the Safe SAS Transactions CSV API.", "title": "PostSafeTransactionsCsvRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsCsvRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions CSV API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsCsvRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsCsvResponse": { "type": "object", "description": "Any payload to be return by Safe SAS Transactions CSV API.", "title": "PostSafeTransactionsCsvResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsCsvResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by Safe SAS Transactions CSV API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsCsvResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsOverTimeRequest": { "type": "object", "description": "Any payload to be passed on the Safe Dashboard Transaction Over Time POST API.", "title": "PostSafeTransactionsOverTimeRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsOverTimeRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe Dashboard Transaction Over Time POST API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsOverTimeRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsOverTimeResponse": { "type": "object", "description": "Any payload to be return by GET API.", "title": "PostSafeTransactionsOverTimeResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsOverTimeResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsOverTimeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsRequest": { "type": "object", "description": "Any payload to be passed on the Safe SAS Transactions API.", "title": "PostSafeTransactionsRequest", "x-displayname": "Input", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsRequest", "properties": { "body": { "type": "string", "description": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CGF5bG9hZAo=.", "x-f5xc-example": "cGF5bG9hZAo=", "x-f5xc-description-short": "Data to be send as the body of request. Note that multipart/formdata is not supported.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace is used to scope the query.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Payment-app-namespace-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "payment-app-namespace-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "version": { "type": "string", "description": "The API version to use.", "title": "Version", "maxLength": 16, "x-displayname": "Requested API version.", "x-ves-example": "V2", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-example": "v2", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "16" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Any payload to be passed on the Safe SAS Transactions API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"payment-app-namespace-1\"\n}", "example_yaml": "namespace: payment-app-namespace-1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "safePostSafeTransactionsResponse": { "type": "object", "description": "Any payload to be return by the Safe SAS Transactions API.", "title": "PostSafeTransactionsResponse", "x-displayname": "Output", "x-ves-proto-message": "ves.io.schema.shape.safe.PostSafeTransactionsResponse", "properties": { "body": { "type": "string", "description": "Data received from the downstream server.", "title": "Body", "format": "byte", "x-displayname": "Body", "x-ves-example": "CmVwbHkK", "x-f5xc-example": "cmVwbHkK", "x-f5xc-description-short": "Data received from the downstream server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Any payload to be return by the Safe SAS Transactions API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for safePostSafeTransactionsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } } }, "responses": {}, "parameters": {}, "requestBodies": {} } }