{ "openapi": "3.0.3", "info": { "title": "Ddos", "description": "Network perimeter hardening through deny list configurations, rule group hierarchies, and encrypted tunnel endpoints. Attack signature detection identifies flood patterns while throttling mechanisms block anomalous traffic bursts. Tunnel health checks verify coverage across distributed segments. Priority ordering governs policy application for multi-layered screening approaches.", "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": "Network perimeter hardening through deny list configurations, rule group hierarchies, and encrypted tunnel endpoints. Attack signature detection identifies flood patterns while throttling mechanisms block anomalous traffic bursts. Tunnel health checks verify coverage across distributed segments. Priority ordering governs policy application for multi-layered screening approaches.", "x-f5xc-summary": "Deny lists, firewall rule groups, and tunnel-based safeguards. Rate limiting and pattern analysis for network perimeter security.", "x-f5xc-cli-domain": "ddos", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/app-security/ddos-protection", "description": "F5 XC Documentation - DDoS Protection" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/", "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" }, { "name": "infraprotect" } ], "paths": { "/api/infraprotect/namespaces/system/infraprotect/access": { "get": { "summary": "Customer access.", "description": "RPC to GET customer access and availability info.", "operationId": "ves.io.schema.infraprotect.CustomGeneralAPI.CustomerAccess", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectCustomerAccessResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomGeneralAPI.CustomerAccess", "tags": [ "infraprotect" ], "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-discovered-response-time-ms": 159.08, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 159.08, "p95_ms": 318.16, "p99_ms": 477.24, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomGeneralAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}": { "get": { "summary": "DDoS Alert.", "description": "RPC to GET details of an alert.", "operationId": "ves.io.schema.infraprotect.CustomAlertAPI.GetAlert", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectGetAlertResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "alert_id", "description": "Alert ID\nID of the alert we want to GET details for.", "in": "path", "required": true, "x-displayname": "Alert ID", "schema": { "type": "string" }, "x-f5xc-example": "12345" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomAlertAPI.GetAlert", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.alert_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.alert_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomAlertAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}/to_event": { "put": { "summary": "Link Alert to Event.", "description": "Allows customers to link alerts with events. This helps with tracking of any mitigation activity and event investigation.", "operationId": "ves.io.schema.infraprotect.CustomAlertAPI.AddAlertToEvent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectAddAlertToEventResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "alert_id", "description": "Alert ID\nAlert to be link with an event.", "in": "path", "required": true, "x-displayname": "Alert ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectAddAlertToEventRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomAlertAPI.AddAlertToEvent", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.alert_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "to-event" ] }, "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.alert_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "to-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomAlertAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/alerts": { "post": { "summary": "DDoS Alerts.", "description": "RPC to GET a list of Alerts. Alerts are raised when an attack is detected by L3/L4 provider.\nAlerts help to start investigate and mitigate any malicious or suspicious activate.", "operationId": "ves.io.schema.infraprotect.CustomAlertAPI.ListAlerts", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListAlertsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListAlertsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomAlertAPI.ListAlerts", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Alert resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "alert" ] }, "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": [ "alert" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomAlertAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/infraprotect/bgp_peer_status": { "post": { "summary": "BGP Peer Status.", "description": "API to GET routed DDoS BGP peer status information.", "operationId": "ves.io.schema.infraprotect.CustomDataAPI.BGPPeerStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectBGPPeerStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectBGPPeerStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomDataAPI.BGPPeerStatus", "tags": [ "data" ], "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": [ "Bgp-peer-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "bgp-peer-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.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "bgp-peer-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}": { "get": { "summary": "Event details.", "description": "Returns details of an event. This allows customers to review any activity related to a DDoS attack.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.GetEvent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectGetEventResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nID of the event we want to GET details for.", "in": "path", "required": true, "x-displayname": "Evemt ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.GetEvent", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.event_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.event_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" } }, "put": { "summary": "Edit event.", "description": "Allows editing of an event, setting its end date and upload any relevant pieces of information.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.EditEvent", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectEditEventResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Alert ID\nID of the event we want to edit.", "in": "path", "required": true, "x-displayname": "Alert ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectEditEventRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.EditEvent", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.event_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "event" ] }, "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.event_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/alerts": { "get": { "summary": "Event alerts.", "description": "Returns a list of alerts triggers while an event is active.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.ListEventAlerts", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventAlertsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nID of the event we want to GET alerts for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.ListEventAlerts", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [ "path.event_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.event_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/attachments": { "get": { "summary": "Event attachments.", "description": "Returns any attachments associated with an event. This could be Pcap files or any other document.\nObsolete - use `GetEvent` to list out attachments.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.ListEventAttachments", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventAttachmentsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nID of the event we want to GET attachments for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.ListEventAttachments", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.event_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.event_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/detail/{event_detail_id}": { "delete": { "summary": "DELETE event detail.", "description": "DELETE a single event detail, including all dependent objects (e.g. Attachments)", "operationId": "ves.io.schema.infraprotect.CustomEventDetailsAPI.DeleteEventDetail", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectDeleteEventDetailResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nEvent ID we want to DELETE the event detail for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" }, { "name": "event_detail_id", "description": "Event Detail ID\nEvent detail ID we want to DELETE.", "in": "path", "required": true, "x-displayname": "Event Detail ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventDetailsAPI.DeleteEventDetail", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.event_detail_id", "path.event_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "detail", "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.event_detail_id", "path.event_id", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "detail", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Edit event detail.", "description": "Allows editing of an event detail, setting its title, description and date.", "operationId": "ves.io.schema.infraprotect.CustomEventDetailsAPI.EditEventDetail", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectEditEventDetailResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nEvent ID we want to edit the event detail for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" }, { "name": "event_detail_id", "description": "Event Detail ID\nEvent detail ID we want to update.", "in": "path", "required": true, "x-displayname": "Event Detail ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectEditEventDetailRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventDetailsAPI.EditEventDetail", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.event_detail_id", "path.event_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "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": [ "path.event_detail_id", "path.event_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "detail" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventDetailsAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/details": { "get": { "summary": "List of event details.", "description": "Returns a list of event details. The list contains event details entered by customer and the SOC team members, mitigation annotations and any attachments.", "operationId": "ves.io.schema.infraprotect.CustomEventDetailsAPI.ListEventDetails", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventDetailsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nEvent ID we want to list the event details for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventDetailsAPI.ListEventDetails", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.event_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.event_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" } }, "post": { "summary": "Add Event Detail.", "description": "Adds a single event detail to an event.", "operationId": "ves.io.schema.infraprotect.CustomEventDetailsAPI.AddEventDetail", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectAddEventDetailResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nEvent ID we want to list the event details for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectAddEventDetailRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventDetailsAPI.AddEventDetail", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.event_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Detail resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "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.event_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "detail" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventDetailsAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/mitigation_annotations": { "get": { "summary": "Event mitigation annotation.", "description": "Return mitigation annotations that occur while an event is active.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.ListEventMitigations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventMitigationsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "event_id", "description": "Event ID\nID of the event we want to GET mitigations for.", "in": "path", "required": true, "x-displayname": "Event ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.ListEventMitigations", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.event_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.event_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/events": { "post": { "summary": "List of events.", "description": "Returns a list of events. Events are created when a high priority mitigation is started. Events then serve as a\none stop shop to review activities to mitigate a DDoS attack.", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.ListEvents", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.ListEvents", "tags": [ "infraprotect" ], "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": [ "Event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "event" ] }, "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": [ "event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/events_summary": { "get": { "summary": "Simple events view.", "description": "Return a list of available event (suitable for an alert)", "operationId": "ves.io.schema.infraprotect.CustomEventAPI.ListEventsSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListEventsSummaryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "alert_id", "description": "Optional - allows to filter events by alert so only relevant events are returned. If not provided, all user events are returned.", "in": "query", "required": false, "x-displayname": "Alert ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomEventAPI.ListEventsSummary", "tags": [ "infraprotect" ], "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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomEventAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}": { "get": { "summary": "Mitigation details.", "description": "Returns details of a single mitigation.", "operationId": "ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigation", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectGetMitigationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "mitigation_id", "description": "Mitigation ID\nID of the mitigation we want to GET the details for.", "in": "path", "required": true, "x-displayname": "Mitigation ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigation", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.mitigation_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.mitigation_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomMitigationAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/annotations": { "get": { "summary": "Mitigation annotations.", "description": "Returns annotations of a single mitigation.", "operationId": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationAnnotations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListMitigationAnnotationsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "mitigation_id", "description": "Mitigation ID\nID of the mitigation we want to GET the annotations for.", "in": "path", "required": true, "x-displayname": "Mitigation ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-fa2ad3369a06" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationAnnotations", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.mitigation_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.mitigation_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomMitigationAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/countermeasures": { "get": { "summary": "Mitigation Countermeasures.", "description": "Returns list of Mitigation Countermeasures and their status for mitigation (and allows for searching through it)", "operationId": "ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigationCountermeasures", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectGetMitigationCountermeasuresResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "mitigation_id", "description": "Mitigation ID\nID of the mitigation we want to GET the countermeasures for.", "in": "path", "required": true, "x-displayname": "Mitigation ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigationCountermeasures", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.mitigation_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.mitigation_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomMitigationAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/ips": { "get": { "summary": "Mitigation IPs.", "description": "Returns list of IPs involved in a mitigation (and allows for searching through it)", "operationId": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationIPs", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListMitigationIPsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "mitigation_id", "description": "Mitigation ID\nID of the mitigation we want to GET the IPs for.", "in": "path", "required": true, "x-displayname": "Mitigation ID.", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationIPs", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.mitigation_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.mitigation_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomMitigationAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/mitigations": { "post": { "summary": "List of mitigations.", "description": "Returns a list of mitigations.", "operationId": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigations", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListMitigationsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListMitigationsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigations", "tags": [ "infraprotect" ], "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": [ "Mitigation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "mitigation" ] }, "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": [ "mitigation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomMitigationAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/networks": { "get": { "summary": "List networks.", "description": "Returns a list available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.", "operationId": "ves.io.schema.infraprotect.CustomNetworkAPI.ListNetworks", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListNetworksResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomNetworkAPI.ListNetworks", "tags": [ "infraprotect" ], "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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomNetworkAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/report/{report_id}": { "get": { "summary": "Report details.", "description": "Returns details of a report, most importantly the PDF document itself.", "operationId": "ves.io.schema.infraprotect.CustomReportAPI.GetReport", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectGetReportResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "report_id", "description": "Report ID\nID of the document we want to GET the contents for.", "in": "path", "required": true, "x-displayname": "Report ID", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomReportAPI.GetReport", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace", "path.report_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": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.namespace", "path.report_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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomReportAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect/reports": { "post": { "summary": "List reports.", "description": "Returns a list of available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.", "operationId": "ves.io.schema.infraprotect.CustomReportAPI.ListReports", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListReportsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nThis request is supported only in system namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectListReportsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomReportAPI.ListReports", "tags": [ "infraprotect" ], "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": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomReportAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/infraprotect/transit_usage": { "post": { "summary": "Transit Usage.", "description": "API to GET transit usage data.", "operationId": "ves.io.schema.infraprotect.CustomDataAPI.TransitUsage", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectTransitUsageResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectTransitUsageRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomDataAPI.TransitUsage", "tags": [ "data" ], "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": [ "Transit-usage resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "transit-usage" ] }, "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": [ "transit-usage" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/suggest-values": { "post": { "summary": "Suggest Values.", "description": "SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.", "operationId": "ves.io.schema.infraprotect.CustomGeneralAPI.SuggestValues", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemainfraprotectSuggestValuesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 suggestions are scoped.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "foobar" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotectSuggestValuesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect.CustomGeneralAPI.SuggestValues", "tags": [ "infraprotect" ], "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": [ "Suggest-value resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "suggest-value" ] }, "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": [ "suggest-value" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect.", "x-ves-proto-service": "ves.io.schema.infraprotect.CustomGeneralAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_asns": { "post": { "summary": "Create DDoS transit ASN.", "description": "Creates a DDoS transit ASN.", "operationId": "ves.io.schema.infraprotect_asn.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_asnCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.API.Create", "tags": [ "infraprotect" ], "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": [ "Infraprotect-asn resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-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.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "infraprotect-asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_asns/{metadata.name}": { "put": { "summary": "Replace DDoS transit ASN.", "description": "Amends a DDoS transit ASN.", "operationId": "ves.io.schema.infraprotect_asn.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_asnReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.API.Replace", "tags": [ "infraprotect" ], "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": [ "infraprotect-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": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "infraprotect-asn" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asns": { "get": { "summary": "List Infraprotect ASN.", "description": "List the set of infraprotect_asn in a namespace.", "operationId": "ves.io.schema.infraprotect_asn.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_asn.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.API.List", "tags": [ "infraprotect" ], "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": "Infraprotect ASN.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asns/update-asn-review-status": { "post": { "summary": "Update ASN Review Status.", "description": "Update Infraprotect ASN Review Status.", "operationId": "ves.io.schema.infraprotect_asn.CustomAPI.UpdateASNReviewStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnUpdateASNReviewStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which the infraprotect ASN review status is to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnUpdateASNReviewStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.CustomAPI.UpdateASNReviewStatus", "tags": [ "infraprotect" ], "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-asn-review-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-asn-review-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.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-asn-review-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asns/{name}": { "get": { "summary": "GET Infraprotect ASN.", "description": "GET DDoS transit ASN.", "operationId": "ves.io.schema.infraprotect_asn.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asnGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.API.Get", "tags": [ "infraprotect" ], "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 Infraprotect ASN.", "description": "DELETE the specified infraprotect_asn.", "operationId": "ves.io.schema.infraprotect_asn.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/infraprotect_asnDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn.API.Delete", "tags": [ "infraprotect" ], "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": [ "infraprotect-asn", "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": [ "infraprotect-asn", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_asn_prefixs": { "post": { "summary": "Create DDoS transit Prefix.", "description": "Creates a DDoS transit Prefix.", "operationId": "ves.io.schema.infraprotect_asn_prefix.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_asn_prefixCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.API.Create", "tags": [ "infraprotect" ], "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": [ "Infraprotect-asn-prefix resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-asn-prefix" ] }, "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": [ "infraprotect-asn-prefix" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_asn_prefixs/{metadata.name}": { "put": { "summary": "Replace DDoS transit Prefix.", "description": "Amends a DDoS transit Prefix.", "operationId": "ves.io.schema.infraprotect_asn_prefix.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_asn_prefixReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.API.Replace", "tags": [ "infraprotect" ], "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": [ "infraprotect-asn-prefix" ] }, "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": [ "infraprotect-asn-prefix" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixes/update-asn-prefix-irr-override": { "post": { "summary": "Update ASN Prefix IRR Override.", "description": "Update Infraprotect ASN Prefix IRR Override.", "operationId": "ves.io.schema.infraprotect_asn_prefix.CustomAPI.UpdateASNPrefixIRROverride", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixUpdateASNPrefixIRROverrideResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which the infraprotect ASN prefix irr override is to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixUpdateASNPrefixIRROverrideRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.CustomAPI.UpdateASNPrefixIRROverride", "tags": [ "infraprotect" ], "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-asn-prefix-irr-override resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-asn-prefix-irr-override" ] }, "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-asn-prefix-irr-override" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixes/update-asn-prefix-review-status": { "post": { "summary": "Update ASN Prefix Review Status.", "description": "Update Infraprotect ASN Prefix Review Status.", "operationId": "ves.io.schema.infraprotect_asn_prefix.CustomAPI.UpdateASNPrefixReviewStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixUpdateASNPrefixReviewStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which the infraprotect ASN prefix review status is to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixUpdateASNPrefixReviewStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.CustomAPI.UpdateASNPrefixReviewStatus", "tags": [ "infraprotect" ], "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-asn-prefix-review-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-asn-prefix-review-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.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-asn-prefix-review-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs": { "get": { "summary": "List Infraprotect ASN Prefix.", "description": "List the set of infraprotect_asn_prefix in a namespace.", "operationId": "ves.io.schema.infraprotect_asn_prefix.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_asn_prefix.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.API.List", "tags": [ "infraprotect" ], "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": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_asn_prefixs/{name}": { "get": { "summary": "GET Infraprotect ASN Prefix.", "description": "GET DDoS transit Prefix.", "operationId": "ves.io.schema.infraprotect_asn_prefix.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_asn_prefixGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.API.Get", "tags": [ "infraprotect" ], "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 Infraprotect ASN Prefix.", "description": "DELETE the specified infraprotect_asn_prefix.", "operationId": "ves.io.schema.infraprotect_asn_prefix.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/infraprotect_asn_prefixDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_asn_prefix.API.Delete", "tags": [ "infraprotect" ], "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": [ "infraprotect-asn-prefix", "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": [ "infraprotect-asn-prefix", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect ASN Prefix.", "x-ves-proto-service": "ves.io.schema.infraprotect_asn_prefix.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_deny_list_rules": { "post": { "summary": "Create DDoS transit Deny List Rule.", "description": "Creates a DDoS transit Deny List Rule.", "operationId": "ves.io.schema.infraprotect_deny_list_rule.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_deny_list_ruleCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_deny_list_ruleCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_deny_list_rule.API.Create", "tags": [ "infraprotect" ], "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", "Policy parameters defined" ], "postconditions": [ "Infraprotect-deny-list-rule resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-deny-list-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.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "infraprotect-deny-list-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Deny List Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_deny_list_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_deny_list_rules/{metadata.name}": { "put": { "summary": "Replace DDoS transit Deny List Rule.", "description": "Amends a DDoS transit Deny List Rule.", "operationId": "ves.io.schema.infraprotect_deny_list_rule.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_deny_list_ruleReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_deny_list_ruleReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_deny_list_rule.API.Replace", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "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": [ "infraprotect-deny-list-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": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "infraprotect-deny-list-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Deny List Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_deny_list_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_deny_list_rules": { "get": { "summary": "List Infraprotect Deny List Rule.", "description": "List the set of infraprotect_deny_list_rule in a namespace.", "operationId": "ves.io.schema.infraprotect_deny_list_rule.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_deny_list_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 infraprotect_deny_list_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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_deny_list_rule.API.List", "tags": [ "infraprotect" ], "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": "Infraprotect Deny List Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_deny_list_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_deny_list_rules/{name}": { "get": { "summary": "GET Infraprotect Deny List Rule.", "description": "GET DDoS transit Deny List Rule.", "operationId": "ves.io.schema.infraprotect_deny_list_rule.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_deny_list_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 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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_deny_list_rule.API.Get", "tags": [ "infraprotect" ], "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": "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 Infraprotect Deny List Rule.", "description": "DELETE the specified infraprotect_deny_list_rule.", "operationId": "ves.io.schema.infraprotect_deny_list_rule.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/infraprotect_deny_list_ruleDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_deny_list_rule.API.Delete", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "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": [ "infraprotect-deny-list-rule", "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": [ "infraprotect-deny-list-rule", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Deny List Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_deny_list_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_firewall_rules": { "post": { "summary": "Create DDoS transit Firewall Rule.", "description": "Creates a DDoS transit Firewall Rule.", "operationId": "ves.io.schema.infraprotect_firewall_rule.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_ruleCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_firewall_ruleCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule.API.Create", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Infraprotect-firewall-rule resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-firewall-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.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "infraprotect-firewall-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_firewall_rules/{metadata.name}": { "put": { "summary": "Replace DDoS transit Firewall Rule.", "description": "Amends a DDoS transit Firewall Rule.", "operationId": "ves.io.schema.infraprotect_firewall_rule.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_ruleReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_firewall_ruleReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule.API.Replace", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": [ "infraprotect-firewall-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": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "infraprotect-firewall-rule" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rules": { "get": { "summary": "List Infraprotect Firewall Rule.", "description": "List the set of infraprotect_firewall_rule in a namespace.", "operationId": "ves.io.schema.infraprotect_firewall_rule.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_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 infraprotect_firewall_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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule.API.List", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": "Infraprotect Firewall Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rules/{name}": { "get": { "summary": "GET Infraprotect Firewall Rule.", "description": "GET DDoS transit Firewall Rule.", "operationId": "ves.io.schema.infraprotect_firewall_rule.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_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 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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule.API.Get", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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 Infraprotect Firewall Rule.", "description": "DELETE the specified infraprotect_firewall_rule.", "operationId": "ves.io.schema.infraprotect_firewall_rule.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/infraprotect_firewall_ruleDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule.API.Delete", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": [ "infraprotect-firewall-rule", "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": [ "infraprotect-firewall-rule", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_firewall_rule_groups": { "post": { "summary": "Replace DDoS transit Firewall Rule Group.", "description": "Amends a DDoS transit Firewall Rule Group.", "operationId": "ves.io.schema.infraprotect_firewall_rule_group.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rule_groupCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_firewall_rule_groupCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule_group.API.Create", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Infraprotect-firewall-rule-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-firewall-rule-group" ] }, "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": [ "infraprotect-firewall-rule-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule Group.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_firewall_rule_groups/{metadata.name}": { "put": { "summary": "Replace DDoS transit Firewall Rule Group.", "description": "Amends a DDoS transit Firewall Rule Group.", "operationId": "ves.io.schema.infraprotect_firewall_rule_group.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rule_groupReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_firewall_rule_groupReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule_group.API.Replace", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": [ "infraprotect-firewall-rule-group" ] }, "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": [ "infraprotect-firewall-rule-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule Group.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rule_groups": { "get": { "summary": "List Infraprotect Firewall Rule Group.", "description": "List the set of infraprotect_firewall_rule_group in a namespace.", "operationId": "ves.io.schema.infraprotect_firewall_rule_group.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rule_groupListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_firewall_rule_group.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule_group.API.List", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": "Infraprotect Firewall Rule Group.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rule_groups/{name}": { "get": { "summary": "GET Infraprotect Firewall Rule Group.", "description": "GET DDoS transit Firewall Rule Group.", "operationId": "ves.io.schema.infraprotect_firewall_rule_group.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rule_groupGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule_group.API.Get", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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 Infraprotect Firewall Rule Group.", "description": "DELETE the specified infraprotect_firewall_rule_group.", "operationId": "ves.io.schema.infraprotect_firewall_rule_group.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/infraprotect_firewall_rule_groupDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_rule_group.API.Delete", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": [ "infraprotect-firewall-rule-group", "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": [ "infraprotect-firewall-rule-group", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Rule Group.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_rule_group.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_firewall_rulesets/{metadata.name}": { "put": { "summary": "Replace DDoS transit Firewall Ruleset.", "description": "Amends a DDoS transit Firewall Ruleset.", "operationId": "ves.io.schema.infraprotect_firewall_ruleset.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rulesetReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_firewall_rulesetReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_ruleset.API.Replace", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": [ "infraprotect-firewall-ruleset" ] }, "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": [ "infraprotect-firewall-ruleset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Firewall Ruleset.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_ruleset.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rulesets": { "get": { "summary": "List Infraprotect Firewall Ruleset.", "description": "List the set of infraprotect_firewall_ruleset in a namespace.", "operationId": "ves.io.schema.infraprotect_firewall_ruleset.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rulesetListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_firewall_ruleset.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_ruleset.API.List", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": "Infraprotect Firewall Ruleset.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_ruleset.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_firewall_rulesets/{name}": { "get": { "summary": "GET Infraprotect Firewall Ruleset.", "description": "GET DDoS transit Firewall Ruleset.", "operationId": "ves.io.schema.infraprotect_firewall_ruleset.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_firewall_rulesetGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_firewall_ruleset.API.Get", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "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": "Infraprotect Firewall Ruleset.", "x-ves-proto-service": "ves.io.schema.infraprotect_firewall_ruleset.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_informations/{name}": { "get": { "summary": "GET Infraprotect Information.", "description": "GET organisation information.", "operationId": "ves.io.schema.infraprotect_information.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_informationGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 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_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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_information.API.Get", "tags": [ "infraprotect" ], "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": "Infraprotect Information.", "x-ves-proto-service": "ves.io.schema.infraprotect_information.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_internet_prefix_advertisements": { "post": { "summary": "Create DDoS transit Internet Prefix.", "description": "Creates a DDoS transit Internet Prefix.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_internet_prefix_advertisementCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Create", "tags": [ "infraprotect" ], "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": [ "Infraprotect-internet-prefix-advertisement resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-internet-prefix-advertisement" ] }, "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": [ "infraprotect-internet-prefix-advertisement" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Internet Prefix Advertisement.", "x-ves-proto-service": "ves.io.schema.infraprotect_internet_prefix_advertisement.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_internet_prefix_advertisements/{metadata.name}": { "put": { "summary": "Replace DDoS transit Internet Prefix.", "description": "Amends a DDoS transit Internet Prefix.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_internet_prefix_advertisementReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Replace", "tags": [ "infraprotect" ], "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": [ "infraprotect-internet-prefix-advertisement" ] }, "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": [ "infraprotect-internet-prefix-advertisement" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Internet Prefix Advertisement.", "x-ves-proto-service": "ves.io.schema.infraprotect_internet_prefix_advertisement.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_internet_prefix_advertisements": { "get": { "summary": "List Infraprotect Internet Prefix Advertisement.", "description": "List the set of infraprotect_internet_prefix_advertisement in a namespace.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_internet_prefix_advertisement.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.List", "tags": [ "infraprotect" ], "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": "Infraprotect Internet Prefix Advertisement.", "x-ves-proto-service": "ves.io.schema.infraprotect_internet_prefix_advertisement.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_internet_prefix_advertisements/update-advertisement-status": { "post": { "summary": "Update Infraprotect Internet prefix advertisement.", "description": "Update Infraprotect Internet prefix advertisement.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.CustomAPI.UpdateInternetPrefixAdvertisementStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which internet prefix advertisement status has to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementUpdateInternetPrefixAdvertisementRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.CustomAPI.UpdateInternetPrefixAdvertisementStatus", "tags": [ "infraprotect" ], "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-advertisement-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-advertisement-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.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-advertisement-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Internet Prefix Advertisement.", "x-ves-proto-service": "ves.io.schema.infraprotect_internet_prefix_advertisement.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_internet_prefix_advertisements/{name}": { "get": { "summary": "GET Infraprotect Internet Prefix.", "description": "GET DDoS transit Internet Prefix.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_internet_prefix_advertisementGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Get", "tags": [ "infraprotect" ], "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 Infraprotect Internet Prefix Advertisement.", "description": "DELETE the specified infraprotect_internet_prefix_advertisement.", "operationId": "ves.io.schema.infraprotect_internet_prefix_advertisement.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/infraprotect_internet_prefix_advertisementDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_internet_prefix_advertisement.API.Delete", "tags": [ "infraprotect" ], "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": [ "infraprotect-internet-prefix-advertisement", "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": [ "infraprotect-internet-prefix-advertisement", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Internet Prefix Advertisement.", "x-ves-proto-service": "ves.io.schema.infraprotect_internet_prefix_advertisement.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_packet_captures": { "post": { "summary": "Create DDoS transit Packet Capture.", "description": "Creates a DDoS transit Packet Capture.", "operationId": "ves.io.schema.infraprotect_packet_capture.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_packet_captureCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_packet_captureCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_packet_capture.API.Create", "tags": [ "infraprotect" ], "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": [ "Infraprotect-packet-capture resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-packet-capture" ] }, "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": [ "infraprotect-packet-capture" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Packet Capture.", "x-ves-proto-service": "ves.io.schema.infraprotect_packet_capture.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_packet_captures/{metadata.name}": { "put": { "summary": "Replace DDoS transit Packet Capture.", "description": "Amends a DDoS transit Packet Capture.", "operationId": "ves.io.schema.infraprotect_packet_capture.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_packet_captureReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_packet_captureReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_packet_capture.API.Replace", "tags": [ "infraprotect" ], "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": [ "infraprotect-packet-capture" ] }, "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": [ "infraprotect-packet-capture" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Packet Capture.", "x-ves-proto-service": "ves.io.schema.infraprotect_packet_capture.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_packet_captures": { "get": { "summary": "List Infraprotect Packet Capture.", "description": "List the set of infraprotect_packet_capture in a namespace.", "operationId": "ves.io.schema.infraprotect_packet_capture.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_packet_captureListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_packet_capture.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_packet_capture.API.List", "tags": [ "infraprotect" ], "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": "Infraprotect Packet Capture.", "x-ves-proto-service": "ves.io.schema.infraprotect_packet_capture.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_packet_captures/{name}": { "get": { "summary": "GET Infraprotect Packet Capture.", "description": "GET DDoS transit Packet Capture.", "operationId": "ves.io.schema.infraprotect_packet_capture.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_packet_captureGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_packet_capture.API.Get", "tags": [ "infraprotect" ], "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 Infraprotect Packet Capture.", "description": "DELETE the specified infraprotect_packet_capture.", "operationId": "ves.io.schema.infraprotect_packet_capture.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/infraprotect_packet_captureDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_packet_capture.API.Delete", "tags": [ "infraprotect" ], "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": [ "infraprotect-packet-capture", "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": [ "infraprotect-packet-capture", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Infraprotect Packet Capture.", "x-ves-proto-service": "ves.io.schema.infraprotect_packet_capture.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_tunnels": { "post": { "summary": "Create DDoS Transit Tunnel.", "description": "Creates a DDoS transit tunnel.", "operationId": "ves.io.schema.infraprotect_tunnel.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_tunnelCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.API.Create", "tags": [ "infraprotect" ], "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": [ "Infraprotect-tunnel resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "infraprotect-tunnel" ] }, "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": [ "infraprotect-tunnel" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{metadata.namespace}/infraprotect_tunnels/{metadata.name}": { "put": { "summary": "Replace DDoS Transit Tunnel.", "description": "Amends a DDoS transit tunnel.", "operationId": "ves.io.schema.infraprotect_tunnel.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/infraprotect_tunnelReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.API.Replace", "tags": [ "infraprotect" ], "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": [ "infraprotect-tunnel" ] }, "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": [ "infraprotect-tunnel" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels": { "get": { "summary": "List Tunnel.", "description": "List the set of infraprotect_tunnel in a namespace.", "operationId": "ves.io.schema.infraprotect_tunnel.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 infraprotect_tunnel.", "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.API.List", "tags": [ "infraprotect" ], "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": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/update-tunnel-clear-df-bit": { "post": { "summary": "Update Tunnel Clear DF Bit.", "description": "Update Tunnel Clear DF Bit.", "operationId": "ves.io.schema.infraprotect_tunnel.CustomAPI.UpdateTunnelClearDFBit", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelUpdateTunnelClearDFBitResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which the tunnel clear df bit is to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelUpdateTunnelClearDFBitRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.CustomAPI.UpdateTunnelClearDFBit", "tags": [ "infraprotect" ], "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-tunnel-clear-df-bit resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-tunnel-clear-df-bit" ] }, "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-tunnel-clear-df-bit" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/update-tunnel-status": { "post": { "summary": "Update Tunnel Status.", "description": "Update Tunnel Status.", "operationId": "ves.io.schema.infraprotect_tunnel.CustomAPI.UpdateTunnelStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelUpdateTunnelStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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 which the tunnel status is to be updated.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelUpdateTunnelStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.CustomAPI.UpdateTunnelStatus", "tags": [ "infraprotect" ], "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-tunnel-statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "update-tunnel-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.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "update-tunnel-statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/infraprotect_tunnels/{name}": { "get": { "summary": "GET Tunnel.", "description": "GET DDoS transit tunnel.", "operationId": "ves.io.schema.infraprotect_tunnel.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/infraprotect_tunnelGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.API.Get", "tags": [ "infraprotect" ], "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 Tunnel.", "description": "DELETE the specified infraprotect_tunnel.", "operationId": "ves.io.schema.infraprotect_tunnel.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/infraprotect_tunnelDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ddos/" }, "x-ves-proto-rpc": "ves.io.schema.infraprotect_tunnel.API.Delete", "tags": [ "infraprotect" ], "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": [ "infraprotect-tunnel", "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": [ "infraprotect-tunnel", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Tunnel", "x-ves-proto-service": "ves.io.schema.infraprotect_tunnel.API", "x-ves-proto-service-type": "AUTO_CRUD_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": { "infraprotectAccessFlag": { "type": "object", "description": "Single access flag instance.", "title": "Single access flag instance", "x-displayname": "Access flag.", "x-ves-proto-message": "ves.io.schema.infraprotect.AccessFlag", "properties": { "data_expected_ts": { "type": "string", "description": "If set then it indicates the date when we expect the customer to have data present.", "title": "Data expected", "format": "date-time", "x-displayname": "Data expected.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "If set then it indicates the date when we expect the customer to have data present.", "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 } }, "data_present": { "type": "boolean", "description": "If true then the customer has some data available, otherwise no data available.", "title": "Data present", "format": "boolean", "x-displayname": "Data present.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "If true then the customer has some data available, otherwise no data available.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enabled": { "type": "boolean", "description": "If true then the customer has this feature enabled.", "title": "Enabled", "format": "boolean", "x-displayname": "Enabled", "x-f5xc-example": "True", "x-f5xc-description-short": "If true then the customer has this feature enabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAccessFlag", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAddAlertToEventRequest": { "type": "object", "description": "Request to add an alert to event (link them together)", "title": "Add Alert to Event", "x-displayname": "Add Alert to Event.", "x-ves-proto-message": "ves.io.schema.infraprotect.AddAlertToEventRequest", "properties": { "alert_id": { "type": "string", "description": "Alert to be link with an event.", "title": "Alert ID", "x-displayname": "Alert ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "event_id": { "type": "string", "description": "Event to be link with an alert.", "title": "Event ID", "x-displayname": "Event ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" } }, "x-f5xc-description-short": "Request to add an alert to event (link them together).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAddAlertToEventRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAddAlertToEventResponse": { "type": "object", "description": "Response to adding an alert to event.", "title": "Add Alert to Event", "x-displayname": "Add Alert to Event.", "x-ves-proto-message": "ves.io.schema.infraprotect.AddAlertToEventResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAddAlertToEventResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAddEventDetailRequest": { "type": "object", "description": "Request to add a single event detail to an event.", "title": "Request to add event detail", "x-displayname": "Add event detail request.", "x-ves-proto-message": "ves.io.schema.infraprotect.AddEventDetailRequest", "properties": { "attachments": { "type": "array", "description": "All attachments on an event details.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Description of the event detail.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "Actions taken: ...", "x-f5xc-example": "Actions taken...", "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" }, "event_id": { "type": "string", "description": "Event ID we want to list the event details for.", "title": "Event ID", "x-displayname": "Event ID", "x-ves-example": "00000000-0000-4000-8000-7248e7cee302.", "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302", "x-f5xc-description-short": "Event ID we want to list the event details for.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "time": { "type": "string", "description": "Time of the event detail\nFormat: RFC3339.", "title": "Time", "format": "date-time", "x-displayname": "Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Time of the event detail Format: RFC3339.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "formatDescription": "Time format (e.g., 14:30:00)", "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 } }, "title": { "type": "string", "description": "Title of the event of the event detail.", "title": "Title", "x-displayname": "Title", "x-ves-example": "Actions taken so far.", "x-f5xc-example": "Actions taken so far", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" } }, "x-f5xc-description-short": "Request to add a single event detail to an event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAddEventDetailRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAddEventDetailResponse": { "type": "object", "description": "Event detail as stored in the backend.", "title": "Event detail as stored", "x-displayname": "Event detail as stored.", "x-ves-proto-message": "ves.io.schema.infraprotect.AddEventDetailResponse", "properties": { "detail": { "allOf": [ { "$ref": "#/components/schemas/infraprotectEventDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAddEventDetailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlert": { "type": "object", "description": "Detail of an alert.", "title": "Alert detail", "x-displayname": "Alert detail.", "x-ves-proto-message": "ves.io.schema.infraprotect.Alert", "properties": { "arbor_id": { "type": "string", "description": "L3/L4 provider alert identifier.", "title": "L3/L4 ID", "x-displayname": "L3/L4 ID", "x-ves-example": "1323975", "x-f5xc-example": "1323975", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "bandwidth": { "type": "string", "description": "Bandwidth that triggered the alert in BPS.", "title": "Bandwidth", "format": "int64", "x-displayname": "Bandwidth", "x-ves-example": "10000000", "x-f5xc-example": "10000000", "x-f5xc-description-short": "Bandwidth that triggered the alert in BPS.", "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 } }, "creator": { "type": "string", "description": "Creator of the alert (or SOC if created manually)", "title": "Creator", "x-displayname": "Creator", "x-f5xc-description-short": "Creator of the alert (or SOC if created manually).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "end_time": { "type": "string", "description": "End time of the alert. This is when the threshold was restored.", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "End time of the alert. This is when the threshold was restored.", "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 } }, "events": { "type": "array", "description": "List of associated alerts. These alerts are normally manually associated.", "title": "Events", "items": { "$ref": "#/components/schemas/infraprotectEvent" }, "x-displayname": "Events", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of associated alerts. These alerts are normally manually associated.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the alert used to uniquely identify it.", "title": "Id", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "ID of the alert used to uniquely identify it.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 the alert is triggered for. This is the \"protected\" IP.", "title": "IP address", "x-displayname": "IP address.", "x-ves-example": "192.0.2.19.", "x-f5xc-example": "192.0.2.19", "x-f5xc-description-short": "IP the alert is triggered for. This is the \"protected\" IP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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_id": { "type": "string", "description": "Network the alert is related to.", "title": "Network ID", "x-displayname": "Network 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" }, "source_type": { "allOf": [ { "$ref": "#/components/schemas/infraprotectAlertSourceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of the alert. This is when a threshold was exceeded.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Start time of the alert. This is when a threshold was exceeded.", "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 } }, "type": { "type": "string", "description": "Type of the alert, e.g. DoS host alert.", "title": "Alert type", "x-displayname": "Alert type.", "x-ves-example": "DoS host alert.", "x-f5xc-example": "DoS host alert", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 infraprotectAlert", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertDetailMisuseType": { "type": "object", "description": "Single occurrence of a misuse type in an alert.", "title": "Alert detail misuse type", "x-displayname": "Alert detail misuse type.", "x-ves-proto-message": "ves.io.schema.infraprotect.AlertDetailMisuseType", "properties": { "bytes": { "type": "string", "description": "Bytes per second for this misuse type.", "title": "Bytes", "format": "int64", "x-displayname": "Bytes", "x-ves-example": "12345", "x-f5xc-example": "12345", "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 } }, "packets": { "type": "string", "description": "Packets per second for this misuse type.", "title": "Packets", "format": "int64", "x-displayname": "Packets", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "Packets per second for this misuse type.", "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 } }, "type": { "type": "string", "description": "Type name of the misuse type.", "title": "Type", "x-displayname": "Type", "x-ves-example": "UDP Flood", "x-f5xc-example": "UDP Flood", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Single occurrence of a misuse type in an alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertDetailMisuseType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertPort": { "type": "object", "description": "Single occurrence of a port in an alert.", "title": "Alert port", "x-displayname": "Alert port.", "x-ves-proto-message": "ves.io.schema.infraprotect.AlertPort", "properties": { "bytes": { "type": "string", "description": "Bytes received on the port.", "title": "Bytes", "format": "int64", "x-displayname": "Bytes", "x-ves-example": "12345", "x-f5xc-example": "12345", "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 } }, "destination": { "type": "boolean", "description": "Destination flag - if rue then the port field is the destination of the alert.", "title": "Destination", "format": "boolean", "x-displayname": "Destination.", "x-f5xc-description-short": "Destination flag - if rue then the port field is the destination of the alert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Logical name of the port.", "title": "Name", "x-displayname": "Name", "x-ves-example": "HTTPS", "x-f5xc-example": "HTTPS", "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])?$" }, "number": { "type": "integer", "description": "Port number involved in the alert.", "title": "Port number", "format": "int32", "x-displayname": "Port number.", "x-ves-example": "8080", "x-f5xc-example": "8080", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "packets": { "type": "string", "description": "Packets received on the port.", "title": "packets", "format": "int64", "x-displayname": "Packets", "x-ves-example": "12345", "x-f5xc-example": "12345", "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 } }, "protocol": { "type": "string", "description": "Protocol used on the port.", "title": "Protocol", "x-displayname": "Protocol", "x-ves-example": "UDP", "x-f5xc-example": "UDP", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Single occurrence of a port in an alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertPort", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertPrefix": { "type": "object", "description": "Single occurrence of a prefix in an alert.", "title": "Alert prefix", "x-displayname": "Alert prefix.", "x-ves-proto-message": "ves.io.schema.infraprotect.AlertPrefix", "properties": { "cidr": { "type": "string", "description": "CIDR of the alert source.", "title": "Cidr", "x-displayname": "CIDR", "x-ves-example": "192.0.2.0/24.", "x-f5xc-example": "192.0.2.0/24", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 9, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}/(3[0-2]|[12]?[0-9])$", "format": "cidr", "formatDescription": "CIDR notation (e.g., 10.0.0.0/24)", "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 } }, "destination": { "type": "boolean", "description": "Destination flag - if rue then the CIDR field is the destination of the alert.", "title": "Destination", "format": "boolean", "x-displayname": "Destination.", "x-f5xc-description-short": "Destination flag - if rue then the CIDR field is the destination of the alert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "num_bytes": { "type": "string", "description": "Bytes received on the CIDR.", "title": "Bytes", "format": "int64", "x-displayname": "Bytes", "x-ves-example": "12345", "x-f5xc-example": "12345", "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 } }, "num_packets": { "type": "string", "description": "Packets received on the CIDR.", "title": "Packets", "format": "int64", "x-displayname": "Packets", "x-ves-example": "12345", "x-f5xc-example": "12345", "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": "Single occurrence of a prefix in an alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertPrefix", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertSourceType": { "type": "string", "description": "Alert source type - helps the UI distinguish alerts coming from different sources\n\n- ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type\n- ALERT_SOURCE_TYPE_MITIGATED: Alert is sourced from a mitigated-type system\n- ALERT_SOURCE_TYPE_AUTOMITIGATED: Alert is sourced from an automitigated-type system.", "title": "Alert source type", "enum": [ "ALERT_SOURCE_TYPE_UNKNOWN", "ALERT_SOURCE_TYPE_MITIGATED", "ALERT_SOURCE_TYPE_AUTOMITIGATED" ], "default": "ALERT_SOURCE_TYPE_UNKNOWN", "x-displayname": "Alert source type.", "x-ves-proto-enum": "ves.io.schema.infraprotect.AlertSourceType", "x-f5xc-description-short": "Alert source type - helps the UI distinguish alerts coming from different sources - ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type ...", "x-f5xc-description-medium": "Alert source type - helps the UI distinguish alerts coming from different sources - ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type - ALERT_SOURCE_TYPE_MITIGATED: Alert is sourced from a mitigated-type system - ALERT_SOURCE_TYPE_AUTOMITIGATED: Alert is sourced from an automitigated-type system.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertSourceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ALERT_SOURCE_TYPE_UNKNOWN\"", "example_yaml": "ALERT_SOURCE_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertTcpFlag": { "type": "object", "description": "Single TCP flag information for an alert.", "title": "TCP Flag", "x-displayname": "TCP Flag", "x-ves-proto-message": "ves.io.schema.infraprotect.AlertTcpFlag", "properties": { "bytes": { "type": "string", "description": "Bytes received for this TCP flag combination.", "title": "Bytes", "format": "int64", "x-displayname": "Bytes", "x-ves-example": "12345", "x-f5xc-example": "12345", "x-f5xc-description-short": "Bytes received for this TCP flag combination.", "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 } }, "flags": { "type": "array", "description": "TCP flags combination for this alert entry.", "title": "Flags", "items": { "$ref": "#/components/schemas/infraprotectAlertTcpFlagType" }, "x-displayname": "Flags", "x-f5xc-description-short": "TCP flags combination for this alert entry.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "packets": { "type": "string", "description": "Packets received for this TCP flag combination.", "title": "Packets", "format": "int64", "x-displayname": "Packets", "x-ves-example": "12345", "x-f5xc-example": "12345", "x-f5xc-description-short": "Packets received for this TCP flag combination.", "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": "Single TCP flag information for an alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertTcpFlag", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAlertTcpFlagType": { "type": "string", "description": "TCP flags used in alert analysis and reporting\n\nFIN flag which indicates that there is no more data from the sender, used in the last packet sent from the sender\nSYN flag set in the first packet from sender and receiver while establishing three way handshake between two hosts\nRST flag that resets a connection when the host receives an unexpected packet\nPSH flag that tells the receiver to process packets as they are received, instead of buffering them\nACK flag that acknowledges successful receipt of a packet\nURG flag that notifies the receiver about urgent packets that need to processed before other packets\nECE flag indicating ECN-Echo for congestion notification\nCWR flag indicating sender reduced its congestion window.", "title": "TCP Flags for Alert Analysis", "enum": [ "ALERT_TCP_FLAG_FIN", "ALERT_TCP_FLAG_SYN", "ALERT_TCP_FLAG_RST", "ALERT_TCP_FLAG_PSH", "ALERT_TCP_FLAG_ACK", "ALERT_TCP_FLAG_URG", "ALERT_TCP_FLAG_ECE", "ALERT_TCP_FLAG_CWR" ], "default": "ALERT_TCP_FLAG_FIN", "x-displayname": "TCP Flags", "x-ves-proto-enum": "ves.io.schema.infraprotect.AlertTcpFlagType", "x-f5xc-description-short": "TCP flags used in alert analysis and reporting FIN flag which indicates that there is no more data from the sender, used in the last packet sent...", "x-f5xc-description-medium": "TCP flags used in alert analysis and reporting FIN flag which indicates that there is no more data from the sender, used in the last packet sent from the sender SYN flag set in the first packet from sender and receiver while establishing three way handshake between two hosts RST flag that resets...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAlertTcpFlagType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ALERT_TCP_FLAG_FIN\"", "example_yaml": "ALERT_TCP_FLAG_FIN\n..." }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAttachment": { "type": "object", "description": "Event attachment record (pcap, or any arbitrary file)", "title": "Event attachment", "x-displayname": "Event attachment.", "x-ves-proto-message": "ves.io.schema.infraprotect.Attachment", "properties": { "attachment_id": { "type": "string", "description": "ID of the attachment.", "title": "Attachment ID", "x-displayname": "Attachment ID.", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "attachment_type": { "allOf": [ { "$ref": "#/components/schemas/infraprotectAttachmentType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "End time as an RFC3339 string.", "title": "End time", "format": "date-time", "x-displayname": "End time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00: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 } }, "gos_name": { "type": "string", "description": "Generic object storage name of the attachment.", "title": "GOS name", "x-displayname": "GOS name", "x-ves-example": "Attachment_123.", "x-f5xc-example": "attachment_123", "x-f5xc-description-short": "Generic object storage name of the attachment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gos_version": { "type": "string", "description": "Generic object storage version of the attachment.", "title": "GOS version", "x-displayname": "GOS version.", "x-ves-example": "V01-00-00-00.", "x-f5xc-example": "v01-00-00-00", "x-f5xc-description-short": "Generic object storage version of the attachment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 attachment.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Last_pcap.file.", "x-f5xc-example": "last_pcap.file", "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])?$" }, "size_bytes": { "type": "string", "description": "Size of the attachment.", "title": "Size", "format": "int64", "x-displayname": "Size", "x-ves-example": "12345", "x-f5xc-example": "12345", "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 } }, "start_time": { "type": "string", "description": "Start time as an RFC3339 string.", "title": "Start time", "format": "date-time", "x-displayname": "Start time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00: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 } } }, "x-f5xc-description-short": "Event attachment record (pcap, or any arbitrary file).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAttachment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectAttachmentType": { "type": "string", "description": "Attachment type - helps the UI to properly handle attachments as not all attachment can be treated the same\n\n- ATTACHMENT_TYPE_UNKNOWN: Unspecified attachment\n- ATTACHMENT_TYPE_PCAP: Attachment is a PCAP file\n- ATTACHMENT_TYPE_BINARY: Attachment is a binary file\n- ATTACHMENT_TYPE_INVALID_PCAP: Attachment type indicated as, however the file format is different\n- ATTACHMENT_TYPE_OTHER: Attachment is other than above.", "title": "Attachment type", "enum": [ "ATTACHMENT_TYPE_UNKNOWN", "ATTACHMENT_TYPE_PCAP", "ATTACHMENT_TYPE_BINARY", "ATTACHMENT_TYPE_INVALID_PCAP", "ATTACHMENT_TYPE_OTHER" ], "default": "ATTACHMENT_TYPE_UNKNOWN", "x-displayname": "Attachment type.", "x-ves-proto-enum": "ves.io.schema.infraprotect.AttachmentType", "x-f5xc-description-short": "Attachment type - helps the UI to properly handle attachments as not all attachment can be treated the same - ATTACHMENT_TYPE_UNKNOWN: Unspecified...", "x-f5xc-description-medium": "Attachment type - helps the UI to properly handle attachments as not all attachment can be treated the same - ATTACHMENT_TYPE_UNKNOWN: Unspecified attachment - ATTACHMENT_TYPE_PCAP: Attachment is a PCAP file - ATTACHMENT_TYPE_BINARY: Attachment is a binary file - ATTACHMENT_TYPE_INVALID_PCAP...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectAttachmentType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ATTACHMENT_TYPE_UNKNOWN\"", "example_yaml": "ATTACHMENT_TYPE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectBGPPeerStatusItem": { "type": "object", "description": "Routed DDoS BGP peer status data specific to a given router/peer combination.", "title": "BGP Peer Status Item", "x-displayname": "BGP Peer Status Item.", "x-ves-proto-message": "ves.io.schema.infraprotect.BGPPeerStatusItem", "properties": { "asn": { "type": "integer", "description": "Autonomous System Number for BGP peer.", "title": "ASN", "format": "int64", "x-displayname": "ASN", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1" }, "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 } }, "bgp_peer_address": { "allOf": [ { "$ref": "#/components/schemas/schemaIpAddressType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "device_location": { "allOf": [ { "$ref": "#/components/schemas/infraprotectDeviceLocation" } ], "x-f5xc-description-short": "Configuration parameter for device location.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_established": { "type": "string", "format": "date-time", "description": "Configuration parameter for last established", "x-f5xc-description-short": "Configuration parameter for last established.", "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 } }, "session_state": { "allOf": [ { "$ref": "#/components/schemas/infraprotectBgpPeerSessionState" } ], "x-f5xc-description-short": "Configuration parameter for session state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Routed DDoS BGP peer status data specific to a given router/peer combination.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectBGPPeerStatusItem", "required_fields": [ "asn" ], "mutually_exclusive_groups": [], "example_json": "{\n \"asn\": 1\n}", "example_yaml": "asn: 1" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectBGPPeerStatusRequest": { "type": "object", "description": "Request to GET routed DDoS BGP peer status information.", "title": "BGP Peer Status Request", "x-displayname": "BGP Peer Status Request.", "x-ves-proto-message": "ves.io.schema.infraprotect.BGPPeerStatusRequest", "properties": { "namespace": { "type": "string", "description": "Human-readable name for the resource", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "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])?$" }, "time": { "type": "string", "description": "Timestamp at which the snapshot of the BGP peer status data should be fetched.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to ", "title": "Time", "x-displayname": "Time", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Timestamp at which the snapshot of the BGP peer status data should be fetched.", "x-f5xc-description-medium": "Timestamp at which the snapshot of the BGP peer status data should be fetched. Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "format": "time", "formatDescription": "Time format (e.g., 14:30:00)", "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 GET routed DDoS BGP peer status information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectBGPPeerStatusRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectBGPPeerStatusResponse": { "type": "object", "description": "Routed DDoS BGP peer status response data.", "title": "BGP Peer Status Response", "x-displayname": "BGP Peer Status Response.", "x-ves-proto-message": "ves.io.schema.infraprotect.BGPPeerStatusResponse", "properties": { "items": { "type": "array", "description": "BGP Peer Status Items contains routed DDoS BGP peer status data for each router/peer combination.", "title": "BGP Peer Status Items", "items": { "$ref": "#/components/schemas/infraprotectBGPPeerStatusItem" }, "x-displayname": "BGP Peer Status Items.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "BGP Peer Status Items contains routed DDoS BGP peer status data for each router/peer combination.", "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-description-short": "Routed DDoS BGP peer status response data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectBGPPeerStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectBgpPeerSessionState": { "type": "string", "description": "Status of BGP connection to this Peer\n\nConnection state is Idle\nConnection state is Connecting\nConnection state is Active\nConnection state is Open Sent\nConnection state is Open Confirm\nConnection state is Established.", "title": "BGP Peer Session State", "enum": [ "Idle", "Connect", "Active", "OpenSent", "OpenConfirm", "Established" ], "default": "Idle", "x-displayname": "BGP Peer Status.", "x-ves-proto-enum": "ves.io.schema.infraprotect.BgpPeerSessionState", "x-f5xc-description-short": "Status of BGP connection to this Peer Connection state is Idle Connection state is Connecting Connection state is Active Connection state is Open...", "x-f5xc-description-medium": "Status of BGP connection to this Peer Connection state is Idle Connection state is Connecting Connection state is Active Connection state is Open Sent Connection state is Open Confirm Connection state is Established.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectBgpPeerSessionState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"Idle\"", "example_yaml": "Idle\n..." }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureAIFAndHTTPURLRegularExpression": { "type": "object", "description": "X-displayName: AIF and HTTP/URL Regular Expression Countermeasure Specification\nAIF and HTTP/URL Regular Expression Countermeasure Specification.", "title": "AIF and HTTP/URL Regular Expression Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureAIFAndHTTPURLRegularExpression", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: AIF and HTTP/URL Regular Expression Countermeasure Specification AIF and HTTP/URL Regular Expression Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: AIF and HTTP/URL Regular Expression Countermeasure Specification AIF and HTTP/URL Regular Expression Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureAIFAndHTTPURLRegularExpression", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSAuth": { "type": "object", "description": "X-displayName: DNS Authentication Countermeasure Specification\nDNS Authentication Countermeasure Specification.", "title": "DNS Authentication Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSAuth", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Authentication Countermeasure Specification DNS Authentication Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS Authentication Countermeasure Specification DNS Authentication Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSAuth", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSMalformed": { "type": "object", "description": "X-displayName: DNS Malformed Countermeasure Specification\nDNS Malformed Countermeasure Specification.", "title": "DNS Malformed Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSMalformed", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Malformed Countermeasure Specification DNS Malformed Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS Malformed Countermeasure Specification DNS Malformed Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSMalformed", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSNXDomainRateLimiting": { "type": "object", "description": "X-displayName: DNS NX Domain Rate Limiting Countermeasure Specification\nDNS NX Domain Rate Limiting Countermeasure Specification.", "title": "DNS NX Domain Rate Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSNXDomainRateLimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS NX Domain Rate Limiting Countermeasure Specification DNS NX Domain Rate Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS NX Domain Rate Limiting Countermeasure Specification DNS NX Domain Rate Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSNXDomainRateLimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSQueryObjectRateLimiting": { "type": "object", "description": "X-displayName: DNS Query Object Rate Limiting Countermeasure Specification\nDNS Query Object Rate Limiting Countermeasure Specification.", "title": "DNS Query Object Rate Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSQueryObjectRateLimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Query Object Rate Limiting Countermeasure Specification DNS Query Object Rate Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS Query Object Rate Limiting Countermeasure Specification DNS Query Object Rate Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSQueryObjectRateLimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSRatelimiting": { "type": "object", "description": "X-displayName: DNS Rate Limiting Countermeasure Specification\nDNS Rate Limiting Countermeasure Specification.", "title": "DNS Rate Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSRatelimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Rate Limiting Countermeasure Specification DNS Rate Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS Rate Limiting Countermeasure Specification DNS Rate Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSRatelimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSRegularExpression": { "type": "object", "description": "X-displayName: DNS Regular Expression Countermeasure Specification\nDNS Regular Expression Countermeasure Specification.", "title": "DNS Regular Expression Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSRegularExpression", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Regular Expression Countermeasure Specification DNS Regular Expression Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: DNS Regular Expression Countermeasure Specification DNS Regular Expression Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSRegularExpression", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureDNSScoping": { "type": "object", "description": "X-displayName: DNS Scoping Countermeasure Specification\nDNS Scoping Countermeasure Specification.", "title": "DNS Scoping Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureDNSScoping", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: DNS Scoping Countermeasure Specification DNS Scoping Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureDNSScoping", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureHTTPMalformed": { "type": "object", "description": "X-displayName: HTTP Malformed Countermeasure Specification\nHTTP Malformed Countermeasure Specification.", "title": "HTTP Malformed Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureHTTPMalformed", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: HTTP Malformed Countermeasure Specification HTTP Malformed Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: HTTP Malformed Countermeasure Specification HTTP Malformed Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureHTTPMalformed", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureHTTPRatelimiting": { "type": "object", "description": "X-displayName: HTTP Rate Limiting Countermeasure Specification\nHTTP Rate Limiting Countermeasure Specification.", "title": "HTTP Rate Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureHTTPRatelimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: HTTP Rate Limiting Countermeasure Specification HTTP Rate Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: HTTP Rate Limiting Countermeasure Specification HTTP Rate Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureHTTPRatelimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureHTTPScoping": { "type": "object", "description": "X-displayName: HTTP Scoping Countermeasure Specification\nHTTP Scoping Countermeasure Specification.", "title": "HTTP Scoping Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureHTTPScoping", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: HTTP Scoping Countermeasure Specification HTTP Scoping Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureHTTPScoping", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureIPAddressFilterlist": { "type": "object", "description": "X-displayName: IP Address Filterlist Countermeasure Specification\nIP Address Filterlist Countermeasure Specification.", "title": "IP Address Filterlist Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureIPAddressFilterlist", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: IP Address Filterlist Countermeasure Specification IP Address Filterlist Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: IP Address Filterlist Countermeasure Specification IP Address Filterlist Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureIPAddressFilterlist", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureIPLocationFilterlist": { "type": "object", "description": "X-displayName: IP Location Filterlist Countermeasure Specification\nIP Location Filterlist Countermeasure Specification.", "title": "IP Location Filterlist Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureIPLocationFilterlist", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: IP Location Filterlist Countermeasure Specification IP Location Filterlist Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: IP Location Filterlist Countermeasure Specification IP Location Filterlist Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureIPLocationFilterlist", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureIPLocationPolicing": { "type": "object", "description": "X-displayName: IP Location Policing Countermeasure Specification\nIP Location Policing Countermeasure Specification.", "title": "IP Location Policing Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureIPLocationPolicing", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: IP Location Policing Countermeasure Specification IP Location Policing Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: IP Location Policing Countermeasure Specification IP Location Policing Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureIPLocationPolicing", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureInvalidPackets": { "type": "object", "description": "X-displayName: Invalid Packets Countermeasure Specification\nInvalid Packets Countermeasure Specification.", "title": "Invalid Packets Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureInvalidPackets", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Invalid Packets Countermeasure Specification Invalid Packets Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Invalid Packets Countermeasure Specification Invalid Packets Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureInvalidPackets", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasurePacketHeaderFiltering": { "type": "object", "description": "X-displayName: Packet Header Filtering Countermeasure Specification\nPacket Header Filtering Countermeasure Specification.", "title": "Packet Header Filtering Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasurePacketHeaderFiltering", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Packet Header Filtering Countermeasure Specification Packet Header Filtering Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Packet Header Filtering Countermeasure Specification Packet Header Filtering Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasurePacketHeaderFiltering", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasurePayloadRegularExpression": { "type": "object", "description": "X-displayName: Payload Regular Expression Specification\nPayload Regular Expression Countermeasure Specification.", "title": "Payload Regular Expression Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasurePayloadRegularExpression", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Payload Regular Expression Specification Payload Regular Expression Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Payload Regular Expression Specification Payload Regular Expression Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasurePayloadRegularExpression", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasurePerConnectionFloodProtection": { "type": "object", "description": "X-displayName: Per Connection Flood Protection Countermeasure Specification\nPer Connection Flood Protection Countermeasure Specification.", "title": "Per Connection Flood Protection Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasurePerConnectionFloodProtection", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Per Connection Flood Protection Countermeasure Specification Per Connection Flood Protection Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Per Connection Flood Protection Countermeasure Specification Per Connection Flood Protection Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasurePerConnectionFloodProtection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureProtocolBaselines": { "type": "object", "description": "X-displayName: Protocol Baselines Countermeasure Specification\nProtocol Baselines Countermeasure Specification.", "title": "Protocol Baselines Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureProtocolBaselines", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Protocol Baselines Countermeasure Specification Protocol Baselines Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Protocol Baselines Countermeasure Specification Protocol Baselines Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureProtocolBaselines", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureProxyListThresholdExceptions": { "type": "object", "description": "X-displayName: Proxy List Threshold Exceptions Countermeasure Specification\nProxy List Threshold Exceptions Countermeasure Specification.", "title": "Proxy List Threshold Exceptions Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureProxyListThresholdExceptions", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Proxy List Threshold Exceptions Countermeasure Specification Proxy List Threshold Exceptions Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Proxy List Threshold Exceptions Countermeasure Specification Proxy List Threshold Exceptions Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureProxyListThresholdExceptions", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureSIPMalformed": { "type": "object", "description": "X-displayName: SIP Malformed Countermeasure Specification\nSIP(Session Initiation Protocol) Malformed Countermeasure Specification.", "title": "SIP Malformed Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureSIPMalformed", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: SIP Malformed Countermeasure Specification SIP(Session Initiation Protocol) Malformed Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: SIP Malformed Countermeasure Specification SIP(Session Initiation Protocol) Malformed Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureSIPMalformed", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureSIPRequestLimiting": { "type": "object", "description": "X-displayName: SIP Request Limiting Countermeasure Specification\nSIP(Session Initiation Protocol) Request Limiting Countermeasure Specification.", "title": "SIP Request Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureSIPRequestLimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: SIP Request Limiting Countermeasure Specification SIP(Session Initiation Protocol) Request Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: SIP Request Limiting Countermeasure Specification SIP(Session Initiation Protocol) Request Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureSIPRequestLimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureShaping": { "type": "object", "description": "X-displayName: Shaping Countermeasure Specification\nShaping Countermeasure Specification.", "title": "Shaping Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureShaping", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Shaping Countermeasure Specification Shaping Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureShaping", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureTCPConnectionLimiting": { "type": "object", "description": "X-displayName: TCP Connection Limiting Countermeasure Specification\nTCP Connection Limiting Countermeasure Specification.", "title": "TCP Connection Limiting Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureTCPConnectionLimiting", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: TCP Connection Limiting Countermeasure Specification TCP Connection Limiting Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: TCP Connection Limiting Countermeasure Specification TCP Connection Limiting Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureTCPConnectionLimiting", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureTCPConnectionReset": { "type": "object", "description": "X-displayName: TCP Connection Reset Countermeasure Specification\nTCP Connection Reset Countermeasure Specification.", "title": "TCP Connection Reset Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureTCPConnectionReset", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: TCP Connection Reset Countermeasure Specification TCP Connection Reset Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: TCP Connection Reset Countermeasure Specification TCP Connection Reset Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureTCPConnectionReset", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureTCPSYNAuthentication": { "type": "object", "description": "X-displayName: TCP SYN Authentication Countermeasure Specification\nTCP SYN Authentication Countermeasure Specification.", "title": "TCP SYN Authentication Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureTCPSYNAuthentication", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: TCP SYN Authentication Countermeasure Specification TCP SYN Authentication Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: TCP SYN Authentication Countermeasure Specification TCP SYN Authentication Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureTCPSYNAuthentication", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureTLSNegotiation": { "type": "object", "description": "X-displayName: TLS Negotiation Countermeasure Specification\nTLS Negotiation Countermeasure Specification.", "title": "TLS Negotiation Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureTLSNegotiation", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: TLS Negotiation Countermeasure Specification TLS Negotiation Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: TLS Negotiation Countermeasure Specification TLS Negotiation Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureTLSNegotiation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureUDPReflectionAmplificationProtection": { "type": "object", "description": "X-displayName: UDP Reflection/Amplification Protection Countermeasure Specification\nUDP Reflection/Amplification Protection Countermeasure Specification.", "title": "UDP Reflection/Amplification Protection Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureUDPReflectionAmplificationProtection", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: UDP Reflection/Amplification Protection Countermeasure Specification UDP Reflection/Amplification Protection Countermeasure...", "x-f5xc-description-medium": "X-displayName: UDP Reflection/Amplification Protection Countermeasure Specification UDP Reflection/Amplification Protection Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureUDPReflectionAmplificationProtection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureUDPSessionAuthentication": { "type": "object", "description": "X-displayName: UDP Session Authentication Countermeasure Specification\nUDP Session Authentication Countermeasure Specification.", "title": "UDP Session Authentication Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureUDPSessionAuthentication", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: UDP Session Authentication Countermeasure Specification UDP Session Authentication Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: UDP Session Authentication Countermeasure Specification UDP Session Authentication Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureUDPSessionAuthentication", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCountermeasureZombieDetection": { "type": "object", "description": "X-displayName: Zombie Detection Countermeasure Specification\nZombie Detection Countermeasure Specification.", "title": "Zombie Detection Countermeasure Specification", "x-ves-proto-message": "ves.io.schema.infraprotect.CountermeasureZombieDetection", "properties": { "applied": { "type": "string", "description": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "title": "Applied", "x-displayname": "Applied", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "\"true\" if the countermeasure is applied, \"false\" if not applied.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "X-displayName: Zombie Detection Countermeasure Specification Zombie Detection Countermeasure Specification.", "x-f5xc-description-medium": "X-displayName: Zombie Detection Countermeasure Specification Zombie Detection Countermeasure Specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCountermeasureZombieDetection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectCustomerAccessResponse": { "type": "object", "description": "Infraprotect and L3/L4 DDoS accessibility and availability flags response.", "title": "Response to get customer access flags", "x-displayname": "Customer access flags.", "x-ves-proto-message": "ves.io.schema.infraprotect.CustomerAccessResponse", "properties": { "l3l4": { "allOf": [ { "$ref": "#/components/schemas/infraprotectAccessFlag" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Infraprotect and L3/L4 DDoS accessibility and availability flags response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectCustomerAccessResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectDeleteEventDetailResponse": { "type": "object", "description": "Event detail deletion response message.", "title": "Event detail deletion response", "x-displayname": "Event detail deletion response.", "x-ves-proto-message": "ves.io.schema.infraprotect.DeleteEventDetailResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectDeleteEventDetailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectDeviceLocation": { "type": "object", "description": "Location of a network device (aka router) where DDoS transit tunnels are provisioned.", "title": "Device Location", "x-displayname": "Device Location.", "x-ves-oneof-field-zone": "[\"zone1\",\"zone2\"]", "x-ves-proto-message": "ves.io.schema.infraprotect.DeviceLocation", "properties": { "name": { "type": "string", "description": "Device location name.", "title": "Location Name", "maxLength": 256, "x-displayname": "Location Name.", "x-ves-example": "VES-I/O-seattle.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "ves-io-seattle", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "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": 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])?$" }, "zone1": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "zone2" ] }, "zone2": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "zone1" ] } }, "x-f5xc-description-short": "Location of a network device (aka router) where DDoS transit tunnels are provisioned.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectDeviceLocation", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"ves-io-seattle\"\n}", "example_yaml": "name: ves-io-seattle" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEditEventDetailRequest": { "type": "object", "description": "Request to update a single event detail.", "title": "Request to update event detail", "x-displayname": "Update event detail request.", "x-ves-proto-message": "ves.io.schema.infraprotect.EditEventDetailRequest", "properties": { "attachments": { "type": "array", "description": "All attachments on an event details, missing will be removed, extras will be added.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-description-short": "All attachments on an event details, missing will be removed, extras will be added.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Description of the event detail.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "Actions taken: ...", "x-f5xc-example": "Actions taken...", "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" }, "event_detail_id": { "type": "string", "description": "Event detail ID we want to update.", "title": "Event Detail ID", "x-displayname": "Event Detail ID.", "x-ves-example": "00000000-0000-4000-8000-7248e7cee302.", "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "event_id": { "type": "string", "description": "Event ID we want to edit the event detail for.", "title": "Event ID", "x-displayname": "Event ID", "x-ves-example": "00000000-0000-4000-8000-7248e7cee302.", "x-f5xc-example": "00000000-0000-4000-8000-7248e7cee302", "x-f5xc-description-short": "Event ID we want to edit the event detail for.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "time": { "type": "string", "description": "Time of the event detail\nFormat: RFC3339.", "title": "Time", "format": "date-time", "x-displayname": "Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Time of the event detail Format: RFC3339.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "formatDescription": "Time format (e.g., 14:30:00)", "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 } }, "title": { "type": "string", "description": "Title of the event of the event detail.", "title": "Title", "x-displayname": "Title", "x-ves-example": "Actions taken so far.", "x-f5xc-example": "Actions taken so far", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" } }, "x-f5xc-description-short": "Request to update a single event detail.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEditEventDetailRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEditEventDetailResponse": { "type": "object", "description": "Event detail as stored in the backend.", "title": "Event detail as stored", "x-displayname": "Event detail as stored.", "x-ves-proto-message": "ves.io.schema.infraprotect.EditEventDetailResponse", "properties": { "detail": { "allOf": [ { "$ref": "#/components/schemas/infraprotectEventDetail" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEditEventDetailResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEditEventRequest": { "type": "object", "description": "Request to GET a single event.", "title": "Event request", "x-displayname": "Event request.", "x-ves-proto-message": "ves.io.schema.infraprotect.EditEventRequest", "properties": { "description": { "type": "string", "description": "New description of the event.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "New description of the event.", "x-f5xc-example": "New description of the event", "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" }, "end_time": { "type": "string", "description": "New end time of the event (note that end time is always set manually)", "title": "End time", "format": "date-time", "x-displayname": "End time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "New end time of the event (note that end time is always set manually).", "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 } }, "event_attachments": { "type": "array", "description": "List of event's attachments.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "event_id": { "type": "string", "description": "ID of the event we want to edit.", "title": "Alert ID", "x-displayname": "Alert ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "name": { "type": "string", "description": "New name of the event.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Event_123", "x-f5xc-example": "event_123", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEditEventRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEditEventResponse": { "type": "object", "description": "Updated event as a response to an event editing.", "title": "Edit event response", "x-displayname": "Edit event response.", "x-ves-proto-message": "ves.io.schema.infraprotect.EditEventResponse", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/infraprotectEvent" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Updated event as a response to an event editing.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEditEventResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEvent": { "type": "object", "description": "Event (an attack record) that holds info an attack and its mitigation(s)", "title": "Single instance of an event", "x-displayname": "Event", "x-ves-proto-message": "ves.io.schema.infraprotect.Event", "properties": { "attachments": { "type": "array", "description": "Attachments on an event.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creator": { "type": "string", "description": "Creator of the event.", "title": "Creator", "x-displayname": "Creator", "x-ves-example": "SOC", "x-f5xc-example": "SOC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "description": { "type": "string", "description": "More detailed description of the event. Most of the time list of actions taken.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "[object_name1, object_name2]", "x-f5xc-example": "[object_name1, object_name2]", "x-f5xc-description-short": "More detailed description of the event. Most of the time list of actions taken.", "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" }, "end_time": { "type": "string", "description": "End time as an RFC3339 string.", "title": "End time", "format": "date-time", "x-displayname": "End time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00: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 } }, "has_attachment": { "type": "boolean", "description": "True if event has any attachment other than PCAP files.", "title": "Has attachment", "format": "boolean", "x-displayname": "Has attachment.", "x-f5xc-description-short": "True if event has any attachment other than PCAP files.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "has_details": { "type": "boolean", "description": "True if the event already has details assigned, otherwise false.", "title": "Has details", "format": "boolean", "x-displayname": "Has details.", "x-f5xc-description-short": "True if the event already has details assigned, otherwise false.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ID of the event used to uniquely identify it.", "title": "Id", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "ID of the event used to uniquely identify it.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Target IP", "title": "IP", "x-displayname": "IP", "x-ves-example": "192.0.2.0/24.", "x-f5xc-example": "192.0.2.0/24", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mitigation_id": { "type": "string", "description": "Mitigation the event is related to.", "title": "Mitigation ID", "x-displayname": "Mitigation ID.", "x-ves-example": "UUID-12345-56789.", "x-f5xc-example": "uuid-12345-56789", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "name": { "type": "string", "description": "Name of an event.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Mainnet_1234_2022.", "x-f5xc-example": "mainnet_1234_2022", "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])?$" }, "network_id": { "type": "string", "description": "Network the event is related to.", "title": "Network ID", "x-displayname": "Network ID.", "x-ves-example": "UUID-12345-56789.", "x-f5xc-example": "uuid-12345-56789", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Start time as an RFC3339 string.", "title": "Start time", "format": "date-time", "x-displayname": "Start time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00: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 } } }, "x-f5xc-description-short": "Event (an attack record) that holds info an attack and its mitigation(s).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEvent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEventDetail": { "type": "object", "description": "Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.", "title": "Event detail", "x-displayname": "Event detail.", "x-ves-proto-message": "ves.io.schema.infraprotect.EventDetail", "properties": { "attachments": { "type": "array", "description": "All attachments on an event details.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creator": { "type": "string", "description": "Creator of the event detail.", "title": "Creator", "x-displayname": "Creator", "x-ves-example": "SOC", "x-f5xc-example": "SOC", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "description": { "type": "string", "description": "Textual description of the event detail record.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "List of actions taken so far ...", "x-f5xc-example": "List of actions taken so far ...", "x-f5xc-description-short": "Textual description of the event detail record.", "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": "ID of the event detail used to uniquely identify it.", "title": "Id", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "ID of the event detail used to uniquely identify it.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": { "type": "string", "description": "Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time. The value must fall within the event time range.", "title": "Time", "format": "date-time", "x-displayname": "Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time.", "x-f5xc-description-medium": "Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time. The value must fall within the event time range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "formatDescription": "Time format (e.g., 14:30:00)", "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 } }, "title": { "type": "string", "description": "Title of the event detail.", "title": "Title", "x-displayname": "Title", "x-ves-example": "Additional details.", "x-f5xc-example": "Additional 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 }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.", "x-f5xc-description-medium": "Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectEventDetail", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectEventSummary": { "type": "object", "description": "Simplified view of an event.", "title": "Simplified event", "x-displayname": "Simplified event.", "x-ves-proto-message": "ves.io.schema.infraprotect.EventSummary", "properties": { "id": { "type": "string", "description": "Event ID", "title": "ID", "x-displayname": "ID", "x-ves-example": "12345", "x-f5xc-example": "12345", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 event (to be displayed to the customer)", "title": "Name", "x-displayname": "Name", "x-ves-example": "Event_12345_2022.", "x-f5xc-example": "event_12345_2022", "x-f5xc-description-short": "Name of the event (to be displayed to the customer).", "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 infraprotectEventSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectGetAlertResponse": { "type": "object", "description": "Response to the single alert request.", "title": "Alert response", "x-displayname": "Alert response.", "x-ves-proto-message": "ves.io.schema.infraprotect.GetAlertResponse", "properties": { "misuse_types": { "type": "array", "description": "List of misuse types involved in the alert.", "title": "Misuse Types", "items": { "$ref": "#/components/schemas/infraprotectAlertDetailMisuseType" }, "x-displayname": "Misuse Types.", "x-f5xc-description-short": "List of misuse types involved in the alert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ports": { "type": "array", "description": "List of ports involved in the alert.", "title": "Ports", "items": { "$ref": "#/components/schemas/infraprotectAlertPort" }, "x-displayname": "Ports", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefixes": { "type": "array", "description": "List of prefixes involved in the alert.", "title": "Prefixes", "items": { "$ref": "#/components/schemas/infraprotectAlertPrefix" }, "x-displayname": "Prefixes", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_flags": { "type": "array", "description": "TCP flags information for the alert.", "title": "TCP Flags", "items": { "$ref": "#/components/schemas/infraprotectAlertTcpFlag" }, "x-displayname": "TCP Flags", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectGetAlertResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectGetEventResponse": { "type": "object", "description": "Response to GET a single event.", "title": "Event response", "x-displayname": "Event response.", "x-ves-proto-message": "ves.io.schema.infraprotect.GetEventResponse", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/infraprotectEvent" } ], "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 infraprotectGetEventResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectGetMitigationCountermeasuresResponse": { "type": "object", "description": "List of Mitigation countermeasures.", "title": "Mitigation Countermeasures", "x-displayname": "Mitigation Countermeasures Response.", "x-ves-proto-message": "ves.io.schema.infraprotect.GetMitigationCountermeasuresResponse", "properties": { "aif_and_http_url_regular_expression": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureAIFAndHTTPURLRegularExpression" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_auth": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSAuth" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_malformed": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSMalformed" } ], "x-f5xc-description-short": "Configuration parameter for dns malformed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_nxdomain_ratelimiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSNXDomainRateLimiting" } ], "x-f5xc-description-short": "Configuration parameter for dns nxdomain ratelimiting.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_object_ratelimiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSQueryObjectRateLimiting" } ], "x-f5xc-description-short": "Configuration parameter for dns object ratelimiting.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_ratelimiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSRatelimiting" } ], "x-f5xc-description-short": "Configuration parameter for dns ratelimiting.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_regular_expression": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSRegularExpression" } ], "x-f5xc-description-short": "Configuration parameter for dns regular expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_scoping": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureDNSScoping" } ], "x-f5xc-description-short": "Configuration parameter for dns scoping.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_malformed": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureHTTPMalformed" } ], "x-f5xc-description-short": "Configuration parameter for http malformed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_rate_limiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureHTTPRatelimiting" } ], "x-f5xc-description-short": "Configuration parameter for http rate limiting.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_scoping": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureHTTPScoping" } ], "x-f5xc-description-short": "Configuration parameter for http scoping.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "invalid_packets": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureInvalidPackets" } ], "x-f5xc-description-short": "Configuration parameter for invalid packets.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_address_filter_list": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureIPAddressFilterlist" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_location_filter_list": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureIPLocationFilterlist" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_location_policing": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureIPLocationPolicing" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "packet_header_filtering": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasurePacketHeaderFiltering" } ], "x-f5xc-description-short": "Configuration parameter for packet header filtering.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "payload_regular_expression": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasurePayloadRegularExpression" } ], "x-f5xc-description-short": "Configuration parameter for payload regular expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "per_connection_flood_protection": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasurePerConnectionFloodProtection" } ], "x-f5xc-description-short": "Configuration parameter for per connection flood protection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol_baselines": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureProtocolBaselines" } ], "x-f5xc-description-short": "Configuration parameter for protocol baselines.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "proxy_list_threshold_exceptions": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureProxyListThresholdExceptions" } ], "x-f5xc-description-short": "Configuration parameter for proxy list threshold exceptions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "shaping": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureShaping" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sip_malformed": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureSIPMalformed" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sip_request_limiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureSIPRequestLimiting" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_connection_limiting": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureTCPConnectionLimiting" } ], "x-f5xc-description-short": "Configuration parameter for tcp connection limiting.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_connection_reset": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureTCPConnectionReset" } ], "x-f5xc-description-short": "Configuration parameter for tcp connection reset.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_syn_auth": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureTCPSYNAuthentication" } ], "x-f5xc-description-short": "Configuration parameter for tcp syn auth.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tls_negotiation": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureTLSNegotiation" } ], "x-f5xc-description-short": "Configuration parameter for tls negotiation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udp_reflection_amp": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureUDPReflectionAmplificationProtection" } ], "x-f5xc-description-short": "Configuration parameter for udp reflection amp.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "udp_session_authentication": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureUDPSessionAuthentication" } ], "x-f5xc-description-short": "Configuration parameter for udp session authentication.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "zombie_detection": { "allOf": [ { "$ref": "#/components/schemas/infraprotectCountermeasureZombieDetection" } ], "x-f5xc-description-short": "Configuration parameter for zombie detection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectGetMitigationCountermeasuresResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectGetMitigationResponse": { "type": "object", "description": "Details of a mitigation.", "title": "Mitigation response", "x-displayname": "Mitigation response.", "x-ves-proto-message": "ves.io.schema.infraprotect.GetMitigationResponse", "properties": { "details": { "type": "string", "description": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.", "title": "Details", "format": "byte", "x-displayname": "Details", "x-f5xc-example": "\"\"", "x-f5xc-description-short": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.", "x-f5xc-description-medium": "Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.", "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 } }, "prefixes": { "type": "array", "description": "Prefixes associated to mitigation.", "title": "Prefixes", "items": { "type": "string" }, "x-displayname": "Prefixes", "x-ves-example": "192.0.2.0/24 192.0.2.0/24.", "x-f5xc-example": "192.0.2.0/24 192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectGetMitigationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectGetReportResponse": { "type": "object", "description": "Single report document content.", "title": "Report response", "x-displayname": "Report response.", "x-ves-proto-message": "ves.io.schema.infraprotect.GetReportResponse", "properties": { "attachment": { "allOf": [ { "$ref": "#/components/schemas/infraprotectAttachment" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectGetReportResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListAlertsRequest": { "type": "object", "description": "Request to GET customer alerts with optional filtering.", "title": "Alerts request", "x-displayname": "Alerts request.", "x-ves-oneof-field-alert_type": "[\"alert_type_ddos\",\"alert_type_infrastructure\"]", "x-ves-proto-message": "ves.io.schema.infraprotect.ListAlertsRequest", "properties": { "alert_type_ddos": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for alert type ddos.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alert_type_infrastructure" ] }, "alert_type_infrastructure": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alert_type_ddos" ] }, "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to ", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to .", "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 } }, "event_id": { "type": "string", "description": "Event ID when we want to filter by an event start and end time.\n\nOptional: If not specified, then no events filtering occurs.", "title": "Event ID", "x-displayname": "Event ID", "x-ves-example": "12345", "x-f5xc-example": "12345", "x-f5xc-description-short": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.", "x-f5xc-description-medium": "Event ID when we want to filter by an event start and end time. Optional: If not specified, then no events filtering occurs.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "network_id": { "type": "string", "description": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.\n\nOptional: If not specified, then no network filtering occurs.", "title": "Network ID", "x-displayname": "Network ID.", "x-ves-example": "12345", "x-f5xc-example": "12345", "x-f5xc-description-short": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.", "x-f5xc-description-medium": "Network ID when we want to filter by a network. It is assured that the network belongs to the tenant. Optional: If not specified, then no network filtering occurs.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to -3d.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to -3d.", "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": "Request to GET customer alerts with optional filtering.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListAlertsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListAlertsResponse": { "type": "object", "description": "Response to the alerts request.", "title": "Alerts response", "x-displayname": "Alerts response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListAlertsResponse", "properties": { "alerts": { "type": "array", "description": "List if alerts.", "title": "Alerts", "items": { "$ref": "#/components/schemas/infraprotectAlert" }, "x-displayname": "Alerts", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListAlertsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventAlertsResponse": { "type": "object", "description": "Response, list of alerts associated with an event.", "title": "Event alerts response", "x-displayname": "Event alerts response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventAlertsResponse", "properties": { "alerts": { "type": "array", "description": "List of alerts related to the event.", "title": "Alerts", "items": { "$ref": "#/components/schemas/infraprotectAlert" }, "x-displayname": "Alerts", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response, list of alerts associated with an event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventAlertsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventAttachmentsResponse": { "type": "object", "description": "Response, list of attachments associated with an event.", "title": "Event attachments response", "x-displayname": "Event attachments response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventAttachmentsResponse", "properties": { "attachments": { "type": "array", "description": "List of Attachments related to the event.", "title": "Attachments", "items": { "$ref": "#/components/schemas/infraprotectAttachment" }, "x-displayname": "Attachments.", "x-f5xc-description-short": "List of Attachments related to the event.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response, list of attachments associated with an event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventAttachmentsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventDetailsResponse": { "type": "object", "description": "All details of the event.", "title": "List event details response", "x-displayname": "List event details response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventDetailsResponse", "properties": { "details": { "type": "array", "description": "List of event details the event may have.", "title": "Event details", "items": { "$ref": "#/components/schemas/infraprotectEventDetail" }, "x-displayname": "Event details.", "x-f5xc-description-short": "List of event details the event may have.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventDetailsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventMitigationsResponse": { "type": "object", "description": "Response, list of mitigations associated with an event.", "title": "Event mitigations response", "x-displayname": "Event mitigations response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventMitigationsResponse", "properties": { "mitigations": { "type": "array", "description": "List of mitigations related to the event.", "title": "Mitigations", "items": { "$ref": "#/components/schemas/infraprotectMitigationAnnotation" }, "x-displayname": "Mitigations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of mitigations related to the event.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response, list of mitigations associated with an event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventMitigationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventsRequest": { "type": "object", "description": "Request to GET a list of events.", "title": "List of events request", "x-displayname": "Events", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the end_time will be evaluated to ", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the end_time will be evaluated to .", "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 } }, "mitigation_id": { "type": "string", "description": "Filter events by mitigation\n\nOptional: If not specified, then events are returned regardless of mitigation.", "title": "Mitigation", "x-displayname": "Mitigation.", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.", "x-f5xc-description-medium": "Filter events by mitigation Optional: If not specified, then events are returned regardless of mitigation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "network_id": { "type": "string", "description": "Filter events by network\n\nOptional: If not specified, then all tenant's networks are considerate.", "title": "Network", "x-displayname": "Network", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "Filter events by network Optional: If not specified, then all tenant's networks are considerate.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339\n\nOptional: If not specified, then the start_time will be evaluated to -3d.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 Optional: If not specified, then the start_time will be evaluated to -3d.", "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 infraprotectListEventsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventsResponse": { "type": "object", "description": "Response to GET a list of events.", "title": "List of events response", "x-displayname": "Events", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventsResponse", "properties": { "events": { "type": "array", "description": "Recorder events filtered by events requests.", "title": "Events", "items": { "$ref": "#/components/schemas/infraprotectEvent" }, "x-displayname": "Events", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Recorder events filtered by events requests.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListEventsSummaryResponse": { "type": "object", "description": "Response to the simplified events view request.", "title": "Simplified events response", "x-displayname": "Simplified events response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListEventsSummaryResponse", "properties": { "events": { "type": "array", "description": "List of events.", "title": "Events", "items": { "$ref": "#/components/schemas/infraprotectEventSummary" }, "x-displayname": "Events", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response to the simplified events view request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListEventsSummaryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListMitigationAnnotationsResponse": { "type": "object", "description": "List of mitigation annotations (i.e. Mitigation notes sorted chronologically)", "title": "Mitigation annotations response", "x-displayname": "Mitigation annotations response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListMitigationAnnotationsResponse", "properties": { "annotations": { "type": "array", "description": "Mitigation annotations of a mitigation.", "title": "Annotations", "items": { "$ref": "#/components/schemas/infraprotectMitigationAnnotation" }, "x-displayname": "Annotations.", "x-ves-example": "['done this', 'done that']", "x-f5xc-example": "['done this', 'done that']", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of mitigation annotations (i.e. Mitigation notes sorted chronologically)", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListMitigationAnnotationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListMitigationIPsResponse": { "type": "object", "description": "List of mitigation Ips.", "title": "Mitigation IPs response", "x-displayname": "Mitigation IPs response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListMitigationIPsResponse", "properties": { "ips": { "type": "array", "description": "List of IP addresses along with log count.", "title": "IPs", "items": { "$ref": "#/components/schemas/infraprotectMitigationIP" }, "x-displayname": "IPs", "x-f5xc-description-short": "List of IP addresses along with log count.", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 100, "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 infraprotectListMitigationIPsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListMitigationsRequest": { "type": "object", "description": "Request to GET a list of mitigations.", "title": "Mitigations request", "x-displayname": "Mitigations request.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListMitigationsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to ", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to .", "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 } }, "event_id": { "type": "string", "description": "Filter mitigations by an event\n\nOptional: If not specified, then all tenant's events are considerate.", "title": "Event", "x-displayname": "Event", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.", "x-f5xc-description-medium": "Filter mitigations by an event Optional: If not specified, then all tenant's events are considerate.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "network_id": { "type": "string", "description": "Filter mitigations by network\n\nOptional: If not specified, then all tenant's networks are considerate.", "title": "Network", "x-displayname": "Network", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "x-f5xc-description-short": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.", "x-f5xc-description-medium": "Filter mitigations by network Optional: If not specified, then all tenant's networks are considerate.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to -3d.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to -3d.", "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 infraprotectListMitigationsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListMitigationsResponse": { "type": "object", "description": "Response giving a list of mitigations.", "title": "Mitigations response", "x-displayname": "Mitigations response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListMitigationsResponse", "properties": { "mitigations": { "type": "array", "description": "Filtered mitigations.", "title": "Mitigations", "items": { "$ref": "#/components/schemas/infraprotectMitigation" }, "x-displayname": "Mitigations.", "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 infraprotectListMitigationsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListNetworksResponse": { "type": "object", "description": "Response containing all networks available to the customer.", "title": "Networks response", "x-displayname": "Networks response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListNetworksResponse", "properties": { "networks": { "type": "array", "description": "List of networks the customer has.", "title": "Networks", "items": { "$ref": "#/components/schemas/infraprotectNetwork" }, "x-displayname": "Networks", "x-f5xc-constraints": { "constraintType": "array", "category": "networking", "minItems": 0, "maxItems": 32, "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-description-short": "Response containing all networks available to the customer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListNetworksResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListReportsRequest": { "type": "object", "description": "Request to GET a list of available reports.", "title": "Reports request", "x-displayname": "Reports request.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListReportsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the end_time will be evaluated to ", "title": "End time", "format": "date-time", "x-displayname": "End Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "End time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the end_time will be evaluated to .", "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 } }, "namespace": { "type": "string", "description": "This request is supported only in system namespace.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Request is supported only in system 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])?$" }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered to build graph.\nFormat: RFC3339 string\n\nOptional: If not specified, then the start_time will be evaluated to -3d.", "title": "Start time", "format": "date-time", "x-displayname": "Start Time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Start time of metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to build graph. Format: RFC3339 string Optional: If not specified, then the start_time will be evaluated to -3d.", "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": "Request to GET a list of available reports.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListReportsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectListReportsResponse": { "type": "object", "description": "List of available reports.", "title": "Reports response", "x-displayname": "Reports response.", "x-ves-proto-message": "ves.io.schema.infraprotect.ListReportsResponse", "properties": { "reports": { "type": "array", "description": "List of reports available to the tenant.", "title": "Reports", "items": { "$ref": "#/components/schemas/infraprotectReport" }, "x-displayname": "Reports", "x-f5xc-description-short": "List of reports available to the tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectListReportsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectMitigation": { "type": "object", "description": "Mitigation details.", "title": "Mitigation", "x-displayname": "Mitigation.", "x-ves-proto-message": "ves.io.schema.infraprotect.Mitigation", "properties": { "arbor_id": { "type": "string", "description": "L3/L4 provider identity string.", "title": "L3/L4 ID", "x-displayname": "L3/L4 ID", "x-ves-example": "Tms-123", "x-f5xc-example": "tms-123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": { "type": "string", "description": "Creator of the alert (or SOC if created manually)", "title": "Creator", "x-displayname": "Creator", "x-f5xc-description-short": "Creator of the alert (or SOC if created manually).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "end_time": { "type": "string", "description": "RFC3339 string of the mitigation end time.", "title": "End time", "format": "date-time", "x-displayname": "End time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "RFC3339 string of the mitigation 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 } }, "id": { "type": "string", "description": "Mitigation ID.", "title": "ID", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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_ongoing": { "type": "boolean", "description": "True if the mitigation is still ongoing.", "title": "Ongoing", "format": "boolean", "x-displayname": "Ongoing", "x-f5xc-description-short": "True if the mitigation is still ongoing.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Mitigation name.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Dosproof_123.", "x-f5xc-example": "dosproof_123", "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])?$" }, "network_id": { "type": "string", "description": "ID of the network involved in the mitigation.", "title": "NetworkID", "x-displayname": "Network ID.", "x-f5xc-description-short": "ID of the network involved in the mitigation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "network_name": { "type": "string", "description": "Name of the network involved in the mitigation.", "title": "Network", "x-displayname": "Network", "x-ves-example": "Dosproof_123.", "x-f5xc-example": "dosproof_123", "x-f5xc-description-short": "Name of the network involved in the mitigation.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "offramp": { "type": "string", "description": "Offramp related to the mitigation.", "title": "Offramp", "x-displayname": "Offramp", "x-ves-example": "192.0.2.0/24.", "x-f5xc-example": "192.0.2.0/24", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "RFC3339 string of the mitigation start time.", "title": "Start time", "format": "date-time", "x-displayname": "Start time.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "RFC3339 string of the mitigation 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-minimum-configuration": { "description": "Minimum configuration for infraprotectMitigation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectMitigationAnnotation": { "type": "object", "description": "Mitigation annotation.", "title": "MitigationAnnotation", "x-displayname": "MitigationAnnotation.", "x-ves-proto-message": "ves.io.schema.infraprotect.MitigationAnnotation", "properties": { "annotation": { "type": "string", "description": "Annotation text.", "title": "Annotation", "x-displayname": "Annotation.", "x-ves-example": "Annotation 1.", "x-f5xc-example": "Annotation 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 } }, "creator": { "type": "string", "description": "Annotation creator.", "title": "Creator", "x-displayname": "Creator", "x-ves-example": "User1", "x-f5xc-example": "user1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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" }, "id": { "type": "string", "description": "Mitigation ID.", "title": "ID", "x-displayname": "ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": { "type": "string", "description": "Annotation creation time as an RFC3339 string.", "title": "Time", "format": "date-time", "x-displayname": "Time", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-01-01T00:00:00Z", "x-f5xc-description-short": "Annotation creation time as an RFC3339 string.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "temporal", "maxLength": 1024, "format": "date-time", "minLength": 8, "pattern": "^\\d{2}:\\d{2}:\\d{2}$", "formatDescription": "Time format (e.g., 14:30:00)", "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 infraprotectMitigationAnnotation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectMitigationIP": { "type": "object", "description": "A single mitigation IP record including log record count.", "title": "Mitigation IP record", "x-displayname": "Mitigation IP record.", "x-ves-proto-message": "ves.io.schema.infraprotect.MitigationIP", "properties": { "ip": { "type": "string", "description": "Mitigation source IP.", "title": "IP", "x-displayname": "IP", "x-ves-example": "192.0.2.0/24.", "x-f5xc-example": "192.0.2.0/24", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "log_count": { "type": "string", "description": "Number of times the IP appears in the log.", "title": "Log count", "format": "int64", "x-displayname": "Log count", "x-ves-example": "123", "x-f5xc-example": "123", "x-f5xc-description-short": "Number of times the IP appears in the log.", "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": "Single mitigation IP record including log record count.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectMitigationIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectNetwork": { "type": "object", "description": "A single customer network record.", "title": "Network record", "x-displayname": "Network record.", "x-ves-proto-message": "ves.io.schema.infraprotect.Network", "properties": { "id": { "type": "string", "description": "ID of the network.", "title": "Network IDListNetworksResponse", "x-displayname": "Network ID.", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 network.", "title": "Network name", "x-displayname": "Network name.", "x-ves-example": "DDOS_proof_1.", "x-f5xc-example": "DDOS_proof_1", "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])?$" }, "prefixes": { "allOf": [ { "$ref": "#/components/schemas/schemaPrefixListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "primary": { "type": "boolean", "description": "If true then the network is the primary customer's network and should always be preferred.\nThe rules governing:\n* The network is flagged as such during onboarding via the signup object->infraprotect_information\n* Customer network called %customer_name%_local - e.g. Defensenet_local\n* The only customer's network (if customer has only one network)", "title": "Primary", "format": "boolean", "x-displayname": "Primary", "x-f5xc-description-short": "If true then the network is the primary customer's network and should always be preferred.", "x-f5xc-description-medium": "If true then the network is the primary customer's network and should always be preferred. The rules governing: * The network is flagged as such during onboarding via the signup object->infraprotect_information * Customer network called %customer_name%_local - e.g. Defensenet_local * The only...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectReport": { "type": "object", "description": "A single DDoS report record.", "title": "Report record", "x-displayname": "Report record.", "x-ves-proto-message": "ves.io.schema.infraprotect.Report", "properties": { "created_at": { "type": "string", "description": "RFC3339 string of the creation date.", "title": "Created date", "format": "date-time", "x-displayname": "Created date.", "x-ves-example": "2021-01-01T00:00:00Z.", "x-f5xc-example": "2021-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" }, "gos_name": { "type": "string", "description": "Name of the report.", "title": "Storage name", "x-displayname": "Storage name.", "x-ves-example": "Dos-proof-report.", "x-f5xc-example": "dos-proof-report", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 report.", "title": "Report ID", "x-displayname": "Report ID", "x-ves-example": "00000000-0000-4000-8000-8bd111298e1f.", "x-f5xc-example": "00000000-0000-4000-8000-8bd111298e1f", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 report.", "title": "Report name", "x-displayname": "Report name.", "x-ves-example": "DOS proof report 01/2022.", "x-f5xc-example": "DOS proof report 01/2022", "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])?$" }, "scheduled": { "type": "boolean", "description": "True if the report is scheduled.", "title": "Scheduled flag", "format": "boolean", "x-displayname": "Scheduled", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scheduled_name": { "type": "string", "description": "Full name, including the date part.\nOptional, only present if `scheduled` is set to true.", "title": "Scheduled name", "x-displayname": "Scheduled name.", "x-ves-example": "Dos-proof-report-01-01-2022.", "x-f5xc-example": "dos-proof-report-01-01-2022", "x-f5xc-description-short": "Full name, including the date part. Optional, only present if is set to 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 } }, "type": { "type": "string", "description": "Type of the report.", "title": "Report type", "x-displayname": "Report type.", "x-ves-example": "DoS proof daily report.", "x-f5xc-example": "DoS proof daily report", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Document version assigned by generic object store.", "title": "Storage version", "x-displayname": "Version", "x-ves-example": "V01-00-00-00.", "x-f5xc-example": "v01-00-00-00", "x-f5xc-description-short": "Document version assigned by generic object store.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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 infraprotectReport", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectSuggestValuesReq": { "type": "object", "description": "Request body of SuggestValues request.", "title": "SuggestValuesReq", "x-displayname": "Request for SuggestValues.", "x-ves-proto-message": "ves.io.schema.infraprotect.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 infraprotectSuggestValuesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectTransitUsageData": { "type": "object", "description": "Transit Usage data contains the transit usage type and the corresponding metric value.", "title": "Transit Usage Data", "x-displayname": "Transit Usage Data.", "x-ves-proto-message": "ves.io.schema.infraprotect.TransitUsageData", "properties": { "data": { "type": "array", "description": "List of metric data.", "title": "Data", "items": { "$ref": "#/components/schemas/infraprotectTransitUsageTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/infraprotectTransitUsageType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/schemaUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Transit Usage data contains the transit usage type and the corresponding metric value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectTransitUsageData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectTransitUsageLabel": { "type": "string", "description": "Labels in transit usage metrics.", "title": "Transit Usage Label", "enum": [ "POP", "DEVICE", "INTERFACE", "CIRCUIT_ID" ], "default": "POP", "x-displayname": "Transit Usage Label.", "x-ves-proto-enum": "ves.io.schema.infraprotect.TransitUsageLabel", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for infraprotectTransitUsageLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"POP\"", "example_yaml": "POP\n..." }, "x-f5xc-cli-domain": "ddos", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "infraprotectTransitUsageRequest": { "type": "object", "description": "Request to GET transit usage data.", "title": "Transit Usage Request", "x-displayname": "Transit Usage Request.", "x-ves-proto-message": "ves.io.schema.infraprotect.TransitUsageRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to build graph.\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 metric collection from which data will be considered to build graph.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to build graph. 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 } }, "field_selector": { "type": "array", "description": "Select fields to be returned in the response.\nOne or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.", "title": "Field Selector", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/infraprotectTransitUsageType" }, "x-displayname": "Field Selector.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "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": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select fields to be returned in the response.", "x-f5xc-description-medium": "Select fields to be returned in the response. One or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "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 } }, "filter": { "type": "string", "description": "Filter is used to specify the list of matchers\nsyntax for filter := {[]}\n :=