{ "openapi": "3.0.3", "info": { "title": "Statistics", "description": "Alert policies with custom matchers, label groupings, and notification parameters. Log receivers for centralized collection with confirmation and verification workflows. Flow analytics, historical trend data, and namespace-scoped dashboards. Topology discovery and site-level health indicators for operational visibility.", "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": "Alert policies with custom matchers, label groupings, and notification parameters. Log receivers for centralized collection with confirmation and verification workflows. Flow analytics, historical trend data, and namespace-scoped dashboards. Topology discovery and site-level health indicators for operational visibility.", "x-f5xc-summary": "Alerting policies with receiver integrations. Log aggregation, topology views, and site health tracking.", "x-f5xc-cli-domain": "statistics", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/observe/alerts-management", "description": "F5 XC Documentation - Alerts and Statistics" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/", "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": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "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": "alert" }, { "name": "config" }, { "name": "data" }, { "name": "discovery" }, { "name": "infraprotect" }, { "name": "log_receiver" }, { "name": "operate" }, { "name": "report" }, { "name": "web" } ], "paths": { "/api/config/namespaces/{metadata.namespace}/alert_policys": { "post": { "summary": "Create Alert Policy.", "description": "Creates a new Alert Policy Object.", "operationId": "ves.io.schema.alert_policy.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert policy for monitoring notifications", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Alert-policy resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "alert-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "alert-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Policy.", "x-ves-proto-service": "ves.io.schema.alert_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/alert_policys/{metadata.name}": { "put": { "summary": "Replace Alert Policy.", "description": "Replaces the content of the Alert Policy Object.", "operationId": "ves.io.schema.alert_policy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert policy for monitoring notifications", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "alert-policy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "alert-policy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Policy.", "x-ves-proto-service": "ves.io.schema.alert_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/alert/namespaces/{namespace}/alert_policy/match": { "post": { "summary": "GET Alert Policy Match.", "description": "GET Alert Policies that match to a set of alert labels for a namespace.", "operationId": "ves.io.schema.alert_policy.CustomAPI.GetAlertPolicyMatch", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyAlertPolicyMatchResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyAlertPolicyMatchRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.CustomAPI.GetAlertPolicyMatch", "tags": [ "alert" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Match resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "match" ] }, "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": [ "match" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Policy.", "x-ves-proto-service": "ves.io.schema.alert_policy.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/alert_policys": { "get": { "summary": "List Alert Policy.", "description": "List the set of alert_policy in a namespace.", "operationId": "ves.io.schema.alert_policy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of alert_policy.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert policy for monitoring notifications", "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": "Alert Policy.", "x-ves-proto-service": "ves.io.schema.alert_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/alert_policys/{name}": { "get": { "summary": "GET Alert Policy.", "description": "GET the Alert Policy Object.", "operationId": "ves.io.schema.alert_policy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_CREATE", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert policy for monitoring notifications", "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 Alert Policy.", "description": "DELETE the specified alert_policy.", "operationId": "ves.io.schema.alert_policy.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_policyDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_policy.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert policy for monitoring notifications", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Policy parameters defined" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "alert-policy", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "alert-policy", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Policy.", "x-ves-proto-service": "ves.io.schema.alert_policy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/alert_receivers": { "post": { "summary": "Create Alert Receiver.", "description": "Creates a new Alert Receiver object.", "operationId": "ves.io.schema.alert_receiver.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert receiver for notification delivery", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Alert-receiver resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "alert-receiver" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "alert-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/alert_receivers/{metadata.name}": { "put": { "summary": "Replace Alert Receiver.", "description": "Replaces the content of an Alert Receiver object.", "operationId": "ves.io.schema.alert_receiver.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert receiver for notification delivery", "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": [ "alert-receiver" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "alert-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/alert_receivers": { "get": { "summary": "List Alert Receiver.", "description": "List the set of alert_receiver in a namespace.", "operationId": "ves.io.schema.alert_receiver.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of alert_receiver.", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert receiver for notification delivery", "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": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/alert_receivers/{name}": { "get": { "summary": "GET Alert Receiver.", "description": "GET the Alert Receiver object.", "operationId": "ves.io.schema.alert_receiver.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert receiver for notification delivery", "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 Alert Receiver.", "description": "DELETE the specified alert_receiver.", "operationId": "ves.io.schema.alert_receiver.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Alert receiver for notification delivery", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "alert-receiver", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "alert-receiver", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/alert/namespaces/{namespace}/alert_receivers/{name}/confirm": { "post": { "summary": "Confirm Alert Receiver.", "description": "API to confirm the Alert Receiver - applicable only for email and sms.", "operationId": "ves.io.schema.alert_receiver.CustomAPI.ConfirmAlertReceiver", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverConfirmAlertReceiverResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 alert receiver is configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the alert receiver.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "email1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverConfirmAlertReceiverRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.CustomAPI.ConfirmAlertReceiver", "tags": [ "alert" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Confirm resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "confirm" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "confirm" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/alert/namespaces/{namespace}/alert_receivers/{name}/test": { "post": { "summary": "Test Alert Receiver.", "description": "API to send test alert.", "operationId": "ves.io.schema.alert_receiver.CustomAPI.TestAlertReceiver", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverTestAlertReceiverResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 alert receiver is configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the alert receiver.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "slack1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverTestAlertReceiverRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.CustomAPI.TestAlertReceiver", "tags": [ "alert" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Test resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "test" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "test" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/alert/namespaces/{namespace}/alert_receivers/{name}/verify": { "post": { "summary": "Verify Alert Receiver.", "description": "API to send request to verify Alert Receiver - applicable only for email and sms.", "operationId": "ves.io.schema.alert_receiver.CustomAPI.VerifyAlertReceiver", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverVerifyAlertReceiverResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 alert receiver is configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the alert receiver.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "email1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alert_receiverVerifyAlertReceiverRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.alert_receiver.CustomAPI.VerifyAlertReceiver", "tags": [ "alert" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Verify resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "verify" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "verify" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alert Receiver.", "x-ves-proto-service": "ves.io.schema.alert_receiver.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/all_ns_alerts": { "get": { "summary": "GET Alerts.", "description": "For system namespace, all the alerts for the tenant matching the filter specified in the request\nwill be returned in the response.", "operationId": "ves.io.schema.alert.CustomAPI.AlertsAllNamespaces", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alertResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace to scope the listing of alerts.\nWhen namespace = \"system\", all alerts for the tenant will be returned.", "in": "query", "required": false, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "inactive", "description": "If set to true, active alerts will not be returned in the response.", "in": "query", "required": false, "x-displayname": "Inactive", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "false" }, { "name": "silenced", "description": "Show silenced alerts - alerts that are muted based on the matchers configured in the alert manager.", "in": "query", "required": false, "x-displayname": "Silenced", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "true" }, { "name": "inhibited", "description": "Show inhibited alerts - alerts that are suppressed if certain other alerts are firing.", "in": "query", "required": false, "x-displayname": "Inhibited", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "false" }, { "name": "unprocessed", "description": "Show unprocessed alerts.", "in": "query", "required": false, "x-displayname": "Unprocessed.", "schema": { "type": "boolean", "format": "boolean" }, "x-f5xc-example": "false" }, { "name": "filter", "description": "HighDiskUsage\\\", severity=\\\"critical\\\"}\"\nList of matchers to filter alerts by.\nFiltering via label matchers follows the same syntax and semantics as Prometheus.\nSyntax for filter := {[]}\n := \"\"\n := string\nAll alerts have the following default labels:\n\"alertname\", \"identifier\", \"type\", \"severity\"\n := string\n := [ same as label match operators supported by prometheus - Please refer HTTPS://prometheus.I/O/docs/prometheus/latest/querying/basics ]\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.", "in": "query", "required": false, "x-displayname": "Filter", "schema": { "type": "string" }, "x-f5xc-example": "{alertname=\\" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.alert.CustomAPI.AlertsAllNamespaces", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Alert configuration for monitoring", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Alerts", "x-ves-proto-service": "ves.io.schema.alert.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/web/namespaces/system/catalogs": { "put": { "summary": "List", "description": "Retrieves service catalog tailor for the currently logged-in user.", "operationId": "ves.io.schema.pbac.catalog.CustomAPI.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalogListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/catalogListRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.pbac.catalog.CustomAPI.List", "tags": [ "web" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "catalog" ] }, "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-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "catalog" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Catalog Custom API.", "x-ves-proto-service": "ves.io.schema.pbac.catalog.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/custom/namespaces/{namespace}/discovered_services": { "get": { "summary": "List discovered services of specific type.", "description": "List the discovered services of specific type like virtual-servers, K8s, consul, NGINX server, etc.", "operationId": "ves.io.schema.discovered_service.CustomAPI.ListDiscoveredServices", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceListServicesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the discovered service for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" }, { "name": "service_type", "description": "Identifies the discovered service type. Omit for all types.", "in": "query", "required": false, "x-displayname": "Service Type.", "schema": { "type": "string" }, "x-f5xc-example": "bigip_virtual_server" }, { "name": "discovery_name", "description": "Filter results to only include items referencing this discovery object name.", "in": "query", "required": false, "x-displayname": "Discovery Name Filter.", "schema": { "type": "string" }, "x-f5xc-example": "disc-cbip-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.ListDiscoveredServices", "tags": [ "discovery" ], "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": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services": { "get": { "summary": "List Discovered Services.", "description": "List the set of discovered_service in a namespace.", "operationId": "ves.io.schema.discovered_service.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 discovered_service.", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.API.List", "tags": [ "discovery" ], "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": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services/{name}": { "get": { "summary": "GET Discovered Service Object.", "description": "GET Discovered Service Object.", "operationId": "ves.io.schema.discovered_service.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.API.Get", "tags": [ "discovery" ], "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": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_http_load_balancer": { "post": { "summary": "Create HTTP/HTTPS load balancer.", "description": "Create HTTP/HTTPS load balancer using the discovered virtual server as an origin server.", "operationId": "ves.io.schema.discovered_service.CustomAPI.CreateHTTPLoadBalancer", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceCreateHTTPLoadBalancerResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the discovered service for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" }, { "name": "name", "description": "Service Name\nx-required\nIdentifies the discovered service name.", "in": "path", "required": true, "x-displayname": "Service Name.", "schema": { "type": "string" }, "x-f5xc-example": "vs1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceCreateHTTPLoadBalancerRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.CreateHTTPLoadBalancer", "tags": [ "discovery" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Create-http-load-balancer resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "create-http-load-balancer" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "create-http-load-balancer" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services/{name}/create_tcp_load_balancer": { "post": { "summary": "Create TCP load balancer.", "description": "Create TCP load balancer using the discovered virtual server as an origin server.", "operationId": "ves.io.schema.discovered_service.CustomAPI.CreateTCPLoadBalancer", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceCreateTCPLoadBalancerResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the discovered service for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" }, { "name": "name", "description": "Service Name\nx-required\nIdentifies the discovered service name.", "in": "path", "required": true, "x-displayname": "Service Name.", "schema": { "type": "string" }, "x-f5xc-example": "vs1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceCreateTCPLoadBalancerRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.CreateTCPLoadBalancer", "tags": [ "discovery" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Create-tcp-load-balancer resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "create-tcp-load-balancer" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "create-tcp-load-balancer" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services/{name}/disable_visibility": { "post": { "summary": "Disable visibility in all workspaces.", "description": "Disable Visibility of the service in all workspaces. This will remove the discovered service\nfrom being visible in other workspaces like WAAP.", "operationId": "ves.io.schema.discovered_service.CustomAPI.DisableVisibility", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceDisableVisibilityResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the discovered service for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" }, { "name": "name", "description": "Service Name\nx-required\nIdentifies the discovered service name.", "in": "path", "required": true, "x-displayname": "Service Name.", "schema": { "type": "string" }, "x-f5xc-example": "vs1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceDisableVisibilityRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.DisableVisibility", "tags": [ "discovery" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Disable-visibility resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "disable-visibility" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "disable-visibility" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/namespaces/{namespace}/discovered_services/{name}/enable_visibility": { "post": { "summary": "Enable visibility in all workspaces.", "description": "Enable Visibility of the service in all workspaces. This action will make the\ndiscovered service visible within WAAP, App Connect where the user can perform\nthe workspace specific actions.", "operationId": "ves.io.schema.discovered_service.CustomAPI.EnableVisibility", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceEnableVisibilityResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace of the discovered service for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "shared" }, { "name": "name", "description": "Service Name\nx-required\nIdentifies the discovered service name.", "in": "path", "required": true, "x-displayname": "Service Name.", "schema": { "type": "string" }, "x-f5xc-example": "vs1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discovered_serviceEnableVisibilityRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.EnableVisibility", "tags": [ "discovery" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Enable-visibility resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "enable-visibility" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "enable-visibility" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/discovery/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.discovered_service.CustomAPI.SuggestValues", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemadiscovered_serviceSuggestValuesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/discovered_serviceSuggestValuesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.discovered_service.CustomAPI.SuggestValues", "tags": [ "discovery" ], "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": "Discovered Services.", "x-ves-proto-service": "ves.io.schema.discovered_service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/flow_anomalys": { "get": { "summary": "List Flow Anomaly.", "description": "List the set of flow_anomaly in a namespace.", "operationId": "ves.io.schema.flow_anomaly.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flow_anomalyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 flow_anomaly.", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.flow_anomaly.API.List", "tags": [ "config" ], "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": "Flow Anomaly.", "x-ves-proto-service": "ves.io.schema.flow_anomaly.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/flow_anomalys/{name}": { "get": { "summary": "GET Flow Anomaly.", "description": "Shape of the flow anomaly specification.", "operationId": "ves.io.schema.flow_anomaly.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flow_anomalyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.flow_anomaly.API.Get", "tags": [ "config" ], "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": "Flow Anomaly.", "x-ves-proto-service": "ves.io.schema.flow_anomaly.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/operate/namespaces/{namespace}/sites/{site}/ver/matching_flows": { "post": { "summary": "Show Matching Flows.", "description": "Show VER flows matching the request.", "operationId": "ves.io.schema.operate.flow.CustomPublicAPI.ShowMatchingFlows", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowFlows" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for which the request is sent (system)", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "site", "description": "Site Name\nName of the site from which flows are requested.", "in": "path", "required": true, "x-displayname": "Site Name", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowFlowMatchRequest" } } }, "required": true }, "x-ves-proto-rpc": "ves.io.schema.operate.flow.CustomPublicAPI.ShowMatchingFlows", "tags": [ "operate" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Matching-flow resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "matching-flow" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.site" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "matching-flow" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Flow Info", "x-ves-proto-service": "ves.io.schema.operate.flow.CustomPublicAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/flow-collection/addon/subscribe": { "post": { "summary": "Subscribe to Flow Collection.", "description": "Subscribe to Flow Collection.", "operationId": "ves.io.schema.flow.CustomFlowConnectionAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowSubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowSubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.flow.CustomFlowConnectionAPI.Subscribe", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Flows", "x-ves-proto-service": "ves.io.schema.flow.CustomFlowConnectionAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/flow-collection/addon/subscription-status": { "get": { "summary": "Check subscription status for Flow Collection.", "description": "Check subscription status flow Flow Collection.", "operationId": "ves.io.schema.flow.CustomFlowConnectionAPI.GetSubscriptionStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowSubscriptionStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.flow.CustomFlowConnectionAPI.GetSubscriptionStatus", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Flows", "x-ves-proto-service": "ves.io.schema.flow.CustomFlowConnectionAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/flow-collection/addon/unsubscribe": { "post": { "summary": "Unsubscribe to Flow Collection.", "description": "Unsubscribe to Flow Collection.", "operationId": "ves.io.schema.flow.CustomFlowConnectionAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowUnsubscribeResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flowUnsubscribeRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.flow.CustomFlowConnectionAPI.Unsubscribe", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Flows", "x-ves-proto-service": "ves.io.schema.flow.CustomFlowConnectionAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/global_log_receivers": { "post": { "summary": "Create Global Log Receiver.", "description": "Creates a new Global Log Receiver object.", "operationId": "ves.io.schema.global_log_receiver.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/global_log_receiverCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Global log receiver for tenant-wide logging", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Global-log-receiver resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "global-log-receiver" ] }, "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": [ "global-log-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/global_log_receivers/{metadata.name}": { "put": { "summary": "Replace Global Log Receiver.", "description": "Replaces the content of an Global Log Receiver object.", "operationId": "ves.io.schema.global_log_receiver.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/global_log_receiverReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Global log receiver for tenant-wide logging", "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": [ "global-log-receiver" ] }, "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": [ "global-log-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/global_log_receiver/status": { "post": { "summary": "Global Log Receiver Status.", "description": "GET status for global log receivers.", "operationId": "ves.io.schema.global_log_receiver.CustomDataAPI.GlobalLogReceiverStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverGlobalLogReceiverStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 of the configured object.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "bookinfo" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverGlobalLogReceiverStatusRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.CustomDataAPI.GlobalLogReceiverStatus", "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": [ "Statu resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "statu" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "statu" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/global_log_receivers": { "get": { "summary": "List Global Log Receiver.", "description": "List the set of global_log_receiver in a namespace.", "operationId": "ves.io.schema.global_log_receiver.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 global_log_receiver.", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Global log receiver for tenant-wide logging", "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": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/global_log_receivers/{name}": { "get": { "summary": "GET Global Log Receiver.", "description": "GET the Global Log Receiver object.", "operationId": "ves.io.schema.global_log_receiver.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Global log receiver for tenant-wide logging", "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 Global Log Receiver.", "description": "DELETE the specified global_log_receiver.", "operationId": "ves.io.schema.global_log_receiver.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/global_log_receiverDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Global log receiver for tenant-wide logging", "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": [ "global-log-receiver", "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": [ "global-log-receiver", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/log_receiver/namespaces/{namespace}/global_log_receivers/{name}/test": { "post": { "summary": "Test Global Log Receiver.", "description": "API to send test log.", "operationId": "ves.io.schema.global_log_receiver.CustomAPI.TestGlobalLogReceiver", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverTestGlobalLogReceiverResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 Global log receiver is configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of the Global log receiver.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "slack1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/global_log_receiverTestGlobalLogReceiverRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.global_log_receiver.CustomAPI.TestGlobalLogReceiver", "tags": [ "log_receiver" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Test resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "test" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "test" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global Log Receiver.", "x-ves-proto-service": "ves.io.schema.global_log_receiver.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/log_receivers": { "post": { "summary": "Create Log Receiver.", "description": "Creates a new Log Receiver object.", "operationId": "ves.io.schema.log_receiver.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/log_receiverCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Log receiver for centralized logging", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Log-receiver resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "log-receiver" ] }, "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": [ "log-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Log Receiver.", "x-ves-proto-service": "ves.io.schema.log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/log_receivers/{metadata.name}": { "put": { "summary": "Replace Log Receiver.", "description": "Replaces the content of an Log Receiver object.", "operationId": "ves.io.schema.log_receiver.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/log_receiverReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Log receiver for centralized logging", "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": [ "log-receiver" ] }, "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": [ "log-receiver" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Log Receiver.", "x-ves-proto-service": "ves.io.schema.log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/log_receivers": { "get": { "summary": "List Log Receiver.", "description": "List the set of log_receiver in a namespace.", "operationId": "ves.io.schema.log_receiver.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 log_receiver.", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Log receiver for centralized logging", "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": "Log Receiver.", "x-ves-proto-service": "ves.io.schema.log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/log_receivers/{name}": { "get": { "summary": "GET Log Receiver.", "description": "GET the Log Receiver object.", "operationId": "ves.io.schema.log_receiver.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Log receiver for centralized logging", "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 Log Receiver.", "description": "DELETE the specified log_receiver.", "operationId": "ves.io.schema.log_receiver.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/log_receiverDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Log receiver for centralized logging", "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": [ "log-receiver", "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": [ "log-receiver", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Log Receiver.", "x-ves-proto-service": "ves.io.schema.log_receiver.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/log_receivers/{name}/test": { "post": { "summary": "Test Log Receiver.", "description": "API to send test log.", "operationId": "ves.io.schema.log_receiver.CustomAPI.TestLogReceiver", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverTestLogReceiverResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 log receiver is configured.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName of the log receiver.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "slack1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/log_receiverTestLogReceiverRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.log_receiver.CustomAPI.TestLogReceiver", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Test resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "test" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "test" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Log Receiver.", "x-ves-proto-service": "ves.io.schema.log_receiver.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs": { "post": { "summary": "Firewall Logs Query.", "description": "Request to GET access logs and network logs with policy hits.\nBy default, the firewall logs in the response are sorted in the reverse chronological order.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch Firewall logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logFirewallLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Security policy for threat protection", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Firewall-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "firewall-log" ] }, "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": [ "firewall-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs/aggregation": { "post": { "summary": "Firewall Logs Aggregation Query.", "description": "Request to GET summary/analytics data for the firewall logs that matches the query in request for a given namespace.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logFirewallLogAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery", "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": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/firewall_logs/scroll": { "get": { "summary": "Firewall Logs Scroll Query.", "description": "The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Firewall Logs Scroll Query.", "description": "The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.", "operationId": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.FirewallLogScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/k8s_audit_logs/scroll": { "get": { "summary": "K8s Audit Log Scroll Query.", "description": "The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "K8s Audit Log Scroll Query.", "description": "The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/k8s_events/scroll": { "get": { "summary": "K8s Events Scroll Query.", "description": "The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "K8s Events Scroll Query.", "description": "The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.K8SEventsScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events": { "post": { "summary": "Platform event Query.", "description": "Request to GET platform event that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for platform events across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch audit logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logPlatformEventRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventQuery", "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": [ "Platform-event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "platform-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": [ "platform-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events/aggregation": { "post": { "summary": "Platform event Aggregation Query.", "description": "Request to GET summary/analytics data for the audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for platform event across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logPlatformEventAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery", "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": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/platform_events/scroll": { "get": { "summary": "Platform event Scroll Query.", "description": "The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "Platform event Scroll Query.", "description": "The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.PlatformEventScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs": { "post": { "summary": "VK8s Audit Log Query.", "description": "Request to GET Virtual K8s audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch vK8s audit logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SAuditLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Vk8s-audit-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "vk8s-audit-log" ] }, "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": [ "vk8s-audit-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs/aggregation": { "post": { "summary": "VK8s Audit Log Aggregation Query.", "description": "Request to GET summary/analytics data for the vK8s audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SAuditLogAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery", "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": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_audit_logs/scroll": { "get": { "summary": "VK8s Audit Log Scroll Query.", "description": "The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "VK8s Audit Log Scroll Query.", "description": "The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events": { "post": { "summary": "VK8s Events Query.", "description": "Request to GET Virtual K8s events that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nvK8s events in the namespace. User with access to the `system` namespace may query for vK8s across\nall namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch vK8s events for the given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SEventsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Kubernetes workload configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Vk8s-event resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "vk8s-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": [ "vk8s-event" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events/aggregation": { "post": { "summary": "VK8s Events Aggregation Query.", "description": "Request to GET summary/analytics data for the vK8s events that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for vK8s events across all namespaces for a given tenant.", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogAggregationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nGET aggregation data for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logVK8SEventsAggregationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery", "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": [ "Aggregation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "aggregation" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "aggregation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/vk8s_events/scroll": { "get": { "summary": "VK8s Events Scroll Query.", "description": "The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery_get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" }, { "name": "scroll_id", "description": "Long Base-64 encoded string which can be used to retrieve next batch of log messages.", "in": "query", "required": false, "x-displayname": "Scroll ID", "schema": { "type": "string" }, "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "post": { "summary": "VK8s Events Scroll Query.", "description": "The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).", "operationId": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery_post", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch the log messages scoped by namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logLogScrollRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/observability/" }, "x-ves-proto-rpc": "ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery", "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": [ "Scroll resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "scroll" ] }, "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": [ "scroll" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Logs", "x-ves-proto-service": "ves.io.schema.log.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/report/namespaces/{namespace}/reports/{name}": { "get": { "summary": "GET Report.", "description": "GET Report will read the report metadata.", "operationId": "ves.io.schema.report.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report.API.Get", "tags": [ "report" ], "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": "Report", "x-ves-proto-service": "ves.io.schema.report.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/report/namespaces/{namespace}/reports/{name}/download": { "get": { "summary": "Download Report.", "description": "Download report.", "operationId": "ves.io.schema.report.CustomAPI.DownloadReport", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reportDownloadReportResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Report Name\n\nx-required\nName of the report which has to be downloadd.", "in": "path", "required": true, "x-displayname": "Report Name.", "schema": { "type": "string" }, "x-f5xc-example": "test-report" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report.CustomAPI.DownloadReport", "tags": [ "report" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report", "x-ves-proto-service": "ves.io.schema.report.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/report/namespaces/{metadata.namespace}/report_configs": { "post": { "summary": "Create Report Configuration.", "description": "Report configuration is used to schedule report generation at a later point in time.", "operationId": "ves.io.schema.report_config.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.API.Create", "tags": [ "report" ], "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": [ "Report-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "report-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "report-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/report/namespaces/{metadata.namespace}/report_configs/{metadata.name}": { "put": { "summary": "Replace Report Configuration.", "description": "Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.", "operationId": "ves.io.schema.report_config.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" }, { "name": "metadata.name", "description": "Name\nThe configuration object to be replaced will be looked up by name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example-corp-web" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.API.Replace", "tags": [ "report" ], "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": [ "report-config" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "report-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs": { "get": { "summary": "List Report Configuration.", "description": "List the set of report_config in a namespace.", "operationId": "ves.io.schema.report_config.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of report_config.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.API.List", "tags": [ "report" ], "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": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs/list-reports-history": { "post": { "summary": "List Reports History.", "description": "List Reports history for the list of report configurations in the given namespace.", "operationId": "ves.io.schema.report_config.CustomAPI.ListReportsHistory", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.CustomAPI.ListReportsHistory", "tags": [ "report" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "List-reports-history resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "list-reports-history" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "list-reports-history" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs/list-reports-history-bot-defence": { "post": { "summary": "List Reports History Bot Defence.", "description": "List Reports history bot defence for the list of report configurations in the given namespace.", "operationId": "ves.io.schema.report_config.CustomAPI.ListReportsHistoryBotDefence", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.CustomAPI.ListReportsHistoryBotDefence", "tags": [ "report" ], "x-f5xc-operation-metadata": { "purpose": "Bot detection and defense configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "List-reports-history-bot-defence resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "list-reports-history-bot-defence" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "list-reports-history-bot-defence" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs/list-reports-history-waap": { "post": { "summary": "List Reports History Waap.", "description": "List Reports history waap for the list of report configurations in the given namespace.", "operationId": "ves.io.schema.report_config.CustomAPI.ListReportsHistoryWaap", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configListReportsHistoryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.CustomAPI.ListReportsHistoryWaap", "tags": [ "report" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "List-reports-history-waap resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "list-reports-history-waap" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "list-reports-history-waap" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs/{name}": { "get": { "summary": "GET Report Configuration.", "description": "GET Report Configuration will read the configuration.", "operationId": "ves.io.schema.report_config.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in 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/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.API.Get", "tags": [ "report" ], "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 Report Configuration.", "description": "DELETE the specified report_config.", "operationId": "ves.io.schema.report_config.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.API.Delete", "tags": [ "report" ], "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": [ "report-config", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "report-config", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/report/namespaces/{namespace}/report_configs/{name}/generate": { "post": { "summary": "Generate Report Now.", "description": "Generate report now.", "operationId": "ves.io.schema.report_config.CustomAPI.GenerateReport", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configGenerateReportResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 for this request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\n\nx-required\nName of the report config for which report has to be generated.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "test-report" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/report_configGenerateReportRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.report_config.CustomAPI.GenerateReport", "tags": [ "report" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Generate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "generate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "generate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Report Configuration.", "x-ves-proto-service": "ves.io.schema.report_config.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/graph/all_ns_service": { "post": { "summary": "Service Graph Query All Namespaces.", "description": "Request to GET monitoring data for a service mesh of a given application.", "operationId": "ves.io.schema.graph.service.CustomAPI.QueryAllNamespaces", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serviceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serviceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.service.CustomAPI.QueryAllNamespaces", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "All-ns-service resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "all-ns-service" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "all-ns-service" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Service Graph.", "x-ves-proto-service": "ves.io.schema.graph.service.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/dc_cluster_group/{dc_cluster_group}": { "post": { "summary": "DC Cluster Topology.", "description": "GET topology of a DC Cluster.", "operationId": "ves.io.schema.topology.CustomDataAPI.DCClusterTopology", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dc_cluster_group", "description": "DC Cluster group\nName of the DC Cluster group.", "in": "path", "required": true, "x-displayname": "DC Cluster group.", "schema": { "type": "string" }, "x-f5xc-example": "dcg-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyDCClusterTopologyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.DCClusterTopology", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.dc_cluster_group" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dc-cluster-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dc-cluster-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.dc_cluster_group" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dc-cluster-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/dc_cluster_groups": { "get": { "summary": "DC Cluster Groups Summary.", "description": "GET summary of all DC Cluster groups.", "operationId": "ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.DCClusterGroupsSummary", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/network/{id}/route_tables": { "get": { "summary": "GET Network Route Tables.", "description": "Gets Route Tables Associated with a Network.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyNetworkRouteTablesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nNetwork ID.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "vpc-1234567898" }, { "name": "route_table_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "Route Table IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "rtb-1234567898, rtb-2345678901" }, { "name": "subnet_ids", "description": "Subnet IDs used as filters.", "in": "query", "required": false, "x-displayname": "Subnet IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "sub-1234567898, sub-2345678901" }, { "name": "subnet_cidrs", "description": "Subnet cidrs used as filters.", "in": "query", "required": false, "x-displayname": "Subnet Cidrs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "192.0.2.0/24, 192.0.2.0/24" }, { "name": "regions", "description": "Regions used as filters.", "in": "query", "required": false, "x-displayname": "Regions", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "us-west1, us-east1" }, { "name": "site", "description": "Site Name", "in": "query", "required": false, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "site-name1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetNetworkRouteTables", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.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": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/route_table/{name}": { "get": { "summary": "GET Route Table.", "description": "GET Route Table.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetRouteTable", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyRouteTableResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "name", "description": "Name\n\nx-required\nRoute table name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "rt-1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetRouteTable", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.name" ], "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" ], "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": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site_mesh_group/{site_mesh_group}": { "post": { "summary": "Site Mesh Topology.", "description": "GET topology of a site mesh.", "operationId": "ves.io.schema.topology.CustomDataAPI.SiteMeshTopology", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "site_mesh_group", "description": "Site Mesh Group\nName of the site mesh group.", "in": "path", "required": true, "x-displayname": "Site Mesh Group.", "schema": { "type": "string" }, "x-f5xc-example": "smg-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologySiteMeshTopologyRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.SiteMeshTopology", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [ "metadata.name", "metadata.namespace", "path.site_mesh_group" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Site-mesh-group resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "site-mesh-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.site_mesh_group" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "site-mesh-group" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/site_mesh_groups": { "get": { "summary": "Site Mesh Groups Summary.", "description": "GET summary of all site mesh groups.", "operationId": "ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTopologyResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.SiteMeshGroupsSummary", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Edge site for distributed deployment", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/topology/tgw/{id}/route_tables": { "get": { "summary": "GET TGW Route Tables.", "description": "Gets Route Tables Associated with a TGW.", "operationId": "ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/topologyTGWRouteTablesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "id", "description": "ID\nx-required\nTGW ID.", "in": "path", "required": true, "x-displayname": "ID", "schema": { "type": "string" }, "x-f5xc-example": "tgw-1234567898" }, { "name": "route_table_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "Route Table IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "rtb-1234567898, rtb-2345678901" }, { "name": "attachment_ids", "description": "Route Table IDs used as filters.", "in": "query", "required": false, "x-displayname": "TGW Attachment IDs.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } }, "x-f5xc-example": "attach-1234567898, attach-2345678901" }, { "name": "site", "description": "Name of the site.", "in": "query", "required": false, "x-displayname": "Site", "schema": { "type": "string" }, "x-f5xc-example": "ce01" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/sites/" }, "x-ves-proto-rpc": "ves.io.schema.topology.CustomDataAPI.GetTGWRouteTables", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Traffic routing configuration", "required_fields": [ "path.id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.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": "Topology", "x-ves-proto-service": "ves.io.schema.topology.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_application/{network_id}": { "post": { "summary": "L3l4 Application traffic Query.", "description": "Request to GET l3l4 Application traffic data.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.ByApplication", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByApplicationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "network_id", "description": "NetworkId\nThe network ID.", "in": "path", "required": true, "x-displayname": "NetworkId", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByApplicationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.ByApplication", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "By-application resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "by-application" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "by-application" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_mitigation/{mitigation_id}": { "post": { "summary": "L3l4 Mitigation Traffic Query.", "description": "Request to GET l3l4 Mitigation Traffic data.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.ByMitigation", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByMitigationResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "MitigationId\nThe mitigation ID.", "in": "path", "required": true, "x-displayname": "MitigationId.", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByMitigationRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.ByMitigation", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.mitigation_id", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "By-mitigation resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "by-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.mitigation_id", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "by-mitigation" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_network/{network_id}": { "post": { "summary": "L3l4 Network Traffic Query.", "description": "Request to GET l3l4 Network Traffic data.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.ByNetwork", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByNetworkResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "network_id", "description": "NetworkId\nThe network ID.", "in": "path", "required": true, "x-displayname": "NetworkId", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByNetworkRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.ByNetwork", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Network configuration for connectivity", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "By-network resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "by-network" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "by-network" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/by_zone/{network_id}": { "post": { "summary": "L3l4 Zone Traffic Query.", "description": "Request to GET l3l4 zone destination Traffic data.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.ByZone", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByZoneResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "network_id", "description": "NetworkId\nThe network ID.", "in": "path", "required": true, "x-displayname": "NetworkId", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4ByZoneRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.ByZone", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "By-zone resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "by-zone" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "by-zone" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/event_count/{network_id}": { "post": { "summary": "L3l4 Event count.", "description": "Request to GET l3l4 Event counts over a period of time.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.EventCount", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4EventCountResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "network_id", "description": "NetworkId\nThe network ID we want the data for. If empty or * is provided then all networks data is returned.", "in": "path", "required": true, "x-displayname": "NetworkId", "schema": { "type": "string" }, "x-f5xc-example": "00000000-0000-4000-8000-2e540be20504" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4EventCountRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.EventCount", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Event-count resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "event-count" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "event-count" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/infraprotect/namespaces/{namespace}/graph/l3l4/top_talkers/{network_id}": { "post": { "summary": "L3l4 Top talkers Query.", "description": "Request to GET l3l4 Top talkers Traffic data.", "operationId": "ves.io.schema.graph.l3l4.CustomAPI.TopTalkers", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4TopTalkersResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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": "network_id", "description": "NetworkId\nThe network ID.", "in": "path", "required": true, "x-displayname": "NetworkId", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/l3l4TopTalkersRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/statistics/" }, "x-ves-proto-rpc": "ves.io.schema.graph.l3l4.CustomAPI.TopTalkers", "tags": [ "infraprotect" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Top-talker resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "top-talker" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace", "path.network_id" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "top-talker" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "L3l4 Graph.", "x-ves-proto-service": "ves.io.schema.graph.l3l4.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "alert_policyAlertName": { "type": "string", "description": "List of Alert Names\n\nCustomer tunnel interface down\nPhysical Interface down\nTunnel Interfaces to Customer Site Down\nVirtual Host server error\nVirtual Host client error\nService Health Low\nService Unavailable\nVirtual Host server error\nVirtual Host client error\nEndpoint Healthcheck failure\nSynthetic monitor health critical\nMalicious user detected\nVirtual Host WAF security events detected\nVirtual Host API security events detected\nVirtual Host Service Policy security events detected\nVirtual Host Many Malicious Bots based WAF security events detected\nVirtual Host Many Malicious Bots based Bot Defense security events detected\nVirtual Host Many Threat campaign based WAF security events detected\nSuspicious domain identified by Client-Side Defense service\nClient-Side Defense has identified a suspicious script that is reading sensitive form field\nTLS Automatic Certificate renewal is failing\nTLS Automatic Certificate renewal is still failing after multiple retries\nTLS Automatic Certificate has expired\nTLS Custom Certificate will expire in less than 28 days\nTLS Custom Certificate will expire in less than 15 days\nTLS Custom Certificate has expired\nDDoS security event detected\nDNS Zone Ignored a Duplicate Record Create Request\nUnused APIs Detected\nShadow APIs Detected\nEndpoints With Sensitive Data In Response Detected\nHigh Risk Score Endpoints Detected\nA routed DDoS traffic anomaly has been detected\nA routed DDoS mitigation has been implemented to block malicious traffic\nA routed DDoS tunnel status has been changed.", "title": "AlertName", "enum": [ "SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN", "SITE_PHYSICAL_INTERFACE_DOWN", "TUNNELS_TO_CUSTOMER_SITE_DOWN", "SERVICE_SERVER_ERROR", "SERVICE_CLIENT_ERROR", "SERVICE_HEALTH_LOW", "SERVICE_UNAVAILABLE", "SERVICE_SERVER_ERROR_PER_SOURCE_SITE", "SERVICE_CLIENT_ERROR_PER_SOURCE_SITE", "SERVICE_ENDPOINT_HEALTHCHECK_FAILURE", "SYNTHETIC_MONITOR_HEALTH_CRITICAL", "MALICIOUS_USER_DETECTED", "WAF_TOO_MANY_ATTACKS", "API_SECURITY_TOO_MANY_ATTACKS", "SERVICE_POLICY_TOO_MANY_ATTACKS", "WAF_TOO_MANY_MALICIOUS_BOTS", "BOT_DEFENSE_TOO_MANY_SECURITY_EVENTS", "THREAT_CAMPAIGN", "VES_CLIENT_SIDE_DEFENSE_SUSPICIOUS_DOMAIN", "VES_CLIENT_SIDE_DEFENSE_SENSITIVE_FIELD_READ", "TLS_AUTOMATIC_CERTIFICATE_RENEWAL_FAILURE", "TLS_AUTOMATIC_CERTIFICATE_RENEWAL_STILL_FAILING", "TLS_AUTOMATIC_CERTIFICATE_EXPIRED", "TLS_CUSTOM_CERTIFICATE_EXPIRING", "TLS_CUSTOM_CERTIFICATE_EXPIRING_SOON", "TLS_CUSTOM_CERTIFICATE_EXPIRED", "L7DDOS", "DNS_ZONE_IGNORED_DUPLICATE_RECORD", "API_SECURITY_UNUSED_API_DETECTED", "API_SECURITY_SHADOW_API_DETECTED", "API_SECURITY_SENSITIVE_DATA_IN_RESPONSE_DETECTED", "API_SECURITY_RISK_SCORE_HIGH_DETECTED", "ROUTED_DDOS_ALERT_NOTIFICATION", "ROUTED_DDOS_MITIGATION_NOTIFICATION", "ROUTED_DDOS_TUNNEL_STATUS_UPDATE_NOTIFICATION" ], "default": "SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN", "x-displayname": "AlertName", "x-ves-proto-enum": "ves.io.schema.alert_policy.AlertName", "x-f5xc-description-short": "List of Alert Names Customer tunnel interface down Physical Interface down Tunnel Interfaces to Customer Site Down Virtual Host server error...", "x-f5xc-description-medium": "List of Alert Names Customer tunnel interface down Physical Interface down Tunnel Interfaces to Customer Site Down Virtual Host server error Virtual Host client error Service Health Low Service Unavailable Virtual Host server error Virtual Host client error Endpoint Healthcheck failure Synthetic...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyAlertName", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN\"", "example_yaml": "SITE_CUSTOMER_TUNNEL_INTERFACE_DOWN\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyAlertPolicyMatch": { "type": "object", "description": "Alert Policy info that matches AlertPolicyMatchRequest giving\nalert policy name,\nalert policy activation state.", "title": "Alert Policy Match", "x-displayname": "Alert Policy Match.", "x-ves-proto-message": "ves.io.schema.alert_policy.AlertPolicyMatch", "properties": { "policy_name": { "type": "string", "description": "Human-readable name for the resource", "title": "policy_name", "x-displayname": "Policy Name.", "x-f5xc-example": "samplepolicy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_status": { "allOf": [ { "$ref": "#/components/schemas/alert_policyAlertPolicyStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Alert Policy info that matches AlertPolicyMatchRequest giving alert policy name, alert policy activation state.", "x-f5xc-description-medium": "Alert Policy info that matches AlertPolicyMatchRequest giving alert policy name, alert policy activation state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyAlertPolicyMatch", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyAlertPolicyMatchRequest": { "type": "object", "description": "Request message for GetAlertPolicyMatch RPC,\ndescribing alert to match against alert policies.", "title": "Alert Policy Match Request", "x-displayname": "Alert Policy Match Request.", "x-ves-proto-message": "ves.io.schema.alert_policy.AlertPolicyMatchRequest", "properties": { "labels": { "type": "object", "description": "\"namespace\": \"system\",\n\"tenant\" :\"example-tenant\",\n\"alertname\": \"podXcrash\",\n\"group\": \"IaaS\",\n\"severity\": \"critical\"\n},\nAlert labels to find match against alert policies\nrequires tenant and namespace to be defined labels map.", "title": "labels", "x-displayname": "Labels", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.map.max_pairs": "50", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "\"labels\"{", "x-validation-rules": { "ves.io.schema.rules.map.max_pairs": "50", "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "\"namespace\": \"system\", \"tenant\" :\"example-tenant\", \"alertname\": \"podXcrash\", \"group\": \"IaaS\", \"severity\": \"critical\" }, Alert labels to find match...", "x-f5xc-description-medium": "\"namespace\": \"system\", \"tenant\" :\"example-tenant\", \"alertname\": \"podXcrash\", \"group\": \"IaaS\", \"severity\": \"critical\" }, Alert labels to find match against alert policies requires tenant and namespace to be defined labels map.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "The namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Request message for GetAlertPolicyMatch RPC, describing alert to match against alert policies.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyAlertPolicyMatchRequest", "required_fields": [ "labels", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"labels\": {},\n \"namespace\": \"ns1\"\n}", "example_yaml": "labels: {}\nnamespace: ns1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyAlertPolicyMatchResponse": { "type": "object", "description": "Response of matching Alert Policies from GET Alert Policy Match request.", "title": "Alert Policy Match Response", "x-displayname": "Alert Policy Match Response.", "x-ves-proto-message": "ves.io.schema.alert_policy.AlertPolicyMatchResponse", "properties": { "alert_match": { "type": "array", "description": "X-example:{\"alert_match\":[{\"policy_name\":\"policy1\",\"policy_active\":1},{\"policy_name\":\"policy4\"}]}\nList of Alert Policies that match given requested namespace,labels.", "title": "alert_match", "items": { "$ref": "#/components/schemas/alert_policyAlertPolicyMatch" }, "x-displayname": "Alert Match.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response of matching Alert Policies from GET Alert Policy Match request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyAlertPolicyMatchResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyAlertPolicyStatus": { "type": "string", "description": "Indicates if Alert Policy is in Alert Policy Set, PolicyStatus is ACTIVE or INACTIVE.\n\nINACTIVE means Alert Policy is not in Alert Policy Set, and will\nnot be used to send Alerts to Alert Receivers.\nACTIVE means Alert Policy is in Alert Policy Set, and is used\nto send out Alert to Alert Receivers.", "title": "AlertPolicyStatus", "enum": [ "INACTIVE", "ACTIVE" ], "default": "INACTIVE", "x-displayname": "AlertPolicyStatus.", "x-ves-proto-enum": "ves.io.schema.alert_policy.AlertPolicyStatus", "x-f5xc-description-short": "Indicates if Alert Policy is in Alert Policy Set, PolicyStatus is ACTIVE or INACTIVE.", "x-f5xc-description-medium": "Indicates if Alert Policy is in Alert Policy Set, PolicyStatus is ACTIVE or INACTIVE. INACTIVE means Alert Policy is not in Alert Policy Set, and will not be used to send Alerts to Alert Receivers. ACTIVE means Alert Policy is in Alert Policy Set, and is used to send out Alert to Alert Receivers.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyAlertPolicyStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INACTIVE\"", "example_yaml": "INACTIVE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of alert_policy", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.alert_policy.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_policyCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.alert_policy.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyCreateSpecType": { "type": "object", "description": "Creates a new Alert Policy Object.", "title": "Create Alert Policy", "x-displayname": "Create Alert Policy.", "x-ves-proto-message": "ves.io.schema.alert_policy.CreateSpecType", "properties": { "notification_parameters": { "allOf": [ { "$ref": "#/components/schemas/alert_policyNotificationParameters" } ], "x-f5xc-description-short": "Configuration parameter for notification parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receivers": { "type": "array", "description": "List of Alert Receivers where the alerts will be sent.", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Alert Receivers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of Alert Receivers where the alerts will be sent.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "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 } }, "routes": { "type": "array", "description": "Set of routes to match the incoming alert.\nThe routes are evaluated in the specified order and terminates on the first match.", "maxItems": 16, "items": { "$ref": "#/components/schemas/alert_policyRoute" }, "x-displayname": "Policy Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-description-short": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-description-medium": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyCreateSpecType", "required_fields": [ "receivers", "routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"receivers\": [\n {}\n ],\n \"routes\": [\n {}\n ]\n}", "example_yaml": "receivers:\n- {}\nroutes:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyCustomGroupBy": { "type": "object", "description": "Specify list of custom labels to group/aggregate the alerts.", "title": "Custom Group By", "x-displayname": "Custom Group By.", "x-ves-proto-message": "ves.io.schema.alert_policy.CustomGroupBy", "properties": { "labels": { "type": "array", "description": "Name of labels to group/aggregate the alerts.", "title": "labels", "maxItems": 5, "items": { "type": "string" }, "x-displayname": "Labels", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "5", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "5", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$" }, "x-f5xc-description-short": "Name of labels to group/aggregate the alerts.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 5, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Specify list of custom labels to group/aggregate the alerts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyCustomGroupBy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyCustomMatcher": { "type": "object", "description": "A set of matchers an alert has to fulfill to match the route.", "title": "Custom Matcher", "x-displayname": "Custom Matcher.", "x-ves-displayorder": "1,2,3,4", "x-ves-proto-message": "ves.io.schema.alert_policy.CustomMatcher", "properties": { "alertlabel": { "type": "object", "description": "AlertLabel to configure the alert policy rule.", "title": "AlertLabel", "x-displayname": "AlertLabel.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "ves.io.schema.rules.map.max_pairs": "3" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.keys.string.pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "ves.io.schema.rules.map.max_pairs": "3" }, "x-f5xc-description-short": "AlertLabel to configure the alert policy rule.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "alertname": { "allOf": [ { "$ref": "#/components/schemas/alert_policyLabelMatcher" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group": { "allOf": [ { "$ref": "#/components/schemas/alert_policyLabelMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "severity": { "allOf": [ { "$ref": "#/components/schemas/alert_policyLabelMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Set of matchers an alert has to fulfill to match the route.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyCustomMatcher", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a alert_policy", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.alert_policy.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read alert_policy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.alert_policy.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/alert_policyCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/alert_policyReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_policyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyGetSpecType": { "type": "object", "description": "GET the Alert Policy Object.", "title": "Get Alert Policy", "x-displayname": "GET Alert Policy.", "x-ves-proto-message": "ves.io.schema.alert_policy.GetSpecType", "properties": { "notification_parameters": { "allOf": [ { "$ref": "#/components/schemas/alert_policyNotificationParameters" } ], "x-f5xc-description-short": "Configuration parameter for notification parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receivers": { "type": "array", "description": "List of Alert Receivers where the alerts will be sent.", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Alert Receivers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of Alert Receivers where the alerts will be sent.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "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 } }, "routes": { "type": "array", "description": "Set of routes to match the incoming alert.\nThe routes are evaluated in the specified order and terminates on the first match.", "maxItems": 16, "items": { "$ref": "#/components/schemas/alert_policyRoute" }, "x-displayname": "Policy Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-description-short": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-description-medium": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyGetSpecType", "required_fields": [ "receivers", "routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"receivers\": [\n {}\n ],\n \"routes\": [\n {}\n ]\n}", "example_yaml": "receivers:\n- {}\nroutes:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyGroup": { "type": "string", "description": "List of Groups\n\nInfrastructure alerts\nAlerts related to Infrastructure as a Service/Communication as a Service\nAlerts related to Virtual Host\nAlerts related to the VoltShare feature\nAlerts related to User Access Management\nAlerts related to Application Security\nAlerts related to Timeseries Anomaly\nAlerts related to Shape Security\nAlerts related to CSD Security\nAlerts related to CDN\nAlerts related to Synthetic Monitors\nAlerts related to TLS Certificates\nAlerts related to Bot Defense\nAlerts related Cloud Link\nAlerts related DNS\nAlerts related to Routed DDoS.", "title": "Group", "enum": [ "INFRASTRUCTURE", "IAAS_CAAS", "VIRTUAL_HOST", "VOLT_SHARE", "UAM", "SECURITY", "TIMESERIES_ANOMALY", "SHAPE_SECURITY", "SECURITY_CSD", "CDN", "SYNTHETIC_MONITORS", "TLS", "SECURITY_BOT_DEFENSE", "CLOUD_LINK", "DNS", "ROUTED_DDOS" ], "default": "INFRASTRUCTURE", "x-displayname": "Group", "x-ves-proto-enum": "ves.io.schema.alert_policy.Group", "x-f5xc-description-short": "List of Groups Infrastructure alerts Alerts related to Infrastructure as a Service/Communication as a Service Alerts related to Virtual Host...", "x-f5xc-description-medium": "List of Groups Infrastructure alerts Alerts related to Infrastructure as a Service/Communication as a Service Alerts related to Virtual Host Alerts related to the VoltShare feature Alerts related to User Access Management Alerts related to Application Security Alerts related to Timeseries...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyGroup", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INFRASTRUCTURE\"", "example_yaml": "INFRASTRUCTURE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyGroupMatcher": { "type": "object", "description": "Select one or more known group names to match the incoming alert.", "title": "Group Matcher", "x-displayname": "Group Matcher.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.alert_policy.GroupMatcher", "properties": { "groups": { "type": "array", "description": "Name of groups to match the alert.", "title": "groups", "items": { "$ref": "#/components/schemas/alert_policyGroup" }, "x-displayname": "Groups", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Select one or more known group names to match the incoming alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyGroupMatcher", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyLabelMatcher": { "type": "object", "title": "Label Matcher", "x-displayname": "Label Matcher.", "x-ves-displayorder": "3", "x-ves-oneof-field-matcher_type": "[\"exact_match\",\"regex_match\"]", "x-ves-proto-message": "ves.io.schema.alert_policy.LabelMatcher", "properties": { "exact_match": { "type": "string", "description": "Exclusive with [regex_match]\nEquality match value for the label.", "title": "Exact Match", "x-displayname": "Exact Match.", "x-ves-example": "Major", "x-f5xc-example": "Major", "x-f5xc-description-short": "Exclusive with [regex_match] Equality match value for the label.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "regex_match" ] }, "regex_match": { "type": "string", "description": "Exclusive with [exact_match]\nRegular expression match value for the label.", "title": "Regex Match", "x-displayname": "RegEx Match.", "x-ves-example": "Major|Critical.", "x-f5xc-example": "Major|Critical", "x-f5xc-description-short": "Exclusive with [exact_match] Regular expression match value for the label.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "exact_match" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyLabelMatcher", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of alert_policy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.alert_policy.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/alert_policyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyListResponseItem": { "type": "object", "description": "By default a summary of alert_policy is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of alert_policy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.alert_policy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this alert_policy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this alert_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this alert_policy.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this alert_policy.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates alert_policy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates alert_policy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/alert_policyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this alert_policy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this alert_policy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this alert_policy.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_policyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this alert_policy.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of alert_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of alert_policy is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyNotificationParameters": { "type": "object", "description": "Set of notification parameters to decide how and when the alert notifications should be sent to the receivers.", "title": "Notification Parameters", "x-displayname": "Notification Parameters.", "x-ves-oneof-field-group_by": "[\"custom\",\"default\",\"individual\",\"ves_io_group\"]", "x-ves-proto-message": "ves.io.schema.alert_policy.NotificationParameters", "properties": { "custom": { "allOf": [ { "$ref": "#/components/schemas/alert_policyCustomGroupBy" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default", "individual", "ves_io_group" ] }, "default": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "True", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom", "individual", "ves_io_group" ] }, "group_interval": { "type": "string", "description": "Group Interval is used to specify how long to wait before sending a notification about new alerts\nthat are added to the group for which an initial notification has already been sent.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"1m\"", "title": "Group Interval", "x-displayname": "Notify Interval for a Group.", "x-ves-example": "1m", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "10m", "ves.io.schema.rules.string.min_time_interval": "30s", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "1m", "x-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "10m", "ves.io.schema.rules.string.min_time_interval": "30s", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Group Interval is used to specify how long to wait before sending a notification about new alerts that are added to the group for which an initial...", "x-f5xc-description-medium": "Group Interval is used to specify how long to wait before sending a notification about new alerts that are added to the group for which an initial notification has already been sent. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_wait": { "type": "string", "description": "Time value used to specify how long to initially wait for an inhibiting alert to arrive or\ncollect more alerts for the same group.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_wait defaults to \"30s\"", "title": "Group Wait", "x-displayname": "Wait to Notify.", "x-ves-example": "30s", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "5m", "ves.io.schema.rules.string.min_time_interval": "0s", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30s", "x-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "5m", "ves.io.schema.rules.string.min_time_interval": "0s", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Time value used to specify how long to initially wait for an inhibiting alert to arrive or collect more alerts for the same group.", "x-f5xc-description-medium": "Time value used to specify how long to initially wait for an inhibiting alert to arrive or collect more alerts for the same group. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_wait defaults to \"30s\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "individual": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom", "default", "ves_io_group" ] }, "repeat_interval": { "type": "string", "description": "Repeat Interval is used to specify how long to wait before sending a notification again if it\nhas already been sent successfully.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\nIf not specified, group_interval defaults to \"4h\"", "title": "Repeat Interval", "x-displayname": "Notify Interval For a Alert.", "x-ves-example": "4h", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "10d", "ves.io.schema.rules.string.min_time_interval": "30m", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "4h", "x-validation-rules": { "ves.io.schema.rules.string.max_time_interval": "10d", "ves.io.schema.rules.string.min_time_interval": "30m", "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Repeat Interval is used to specify how long to wait before sending a notification again if it has already been sent successfully.", "x-f5xc-description-medium": "Repeat Interval is used to specify how long to wait before sending a notification again if it has already been sent successfully. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days If not specified, group_interval defaults to \"4h\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ves_io_group": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for ves io group.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom", "default", "individual" ] } }, "x-f5xc-description-short": "Set of notification parameters to decide how and when the alert notifications should be sent to the receivers.", "x-f5xc-description-medium": "Set of notification parameters to decide how and when the alert notifications should be sent to the receivers.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyNotificationParameters", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a alert_policy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.alert_policy.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_policyReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.alert_policy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyReplaceSpecType": { "type": "object", "description": "Replaces the content of the Alert Policy Object.", "title": "Replace Alert Policy", "x-displayname": "Replace Alert Policy.", "x-ves-proto-message": "ves.io.schema.alert_policy.ReplaceSpecType", "properties": { "notification_parameters": { "allOf": [ { "$ref": "#/components/schemas/alert_policyNotificationParameters" } ], "x-f5xc-description-short": "Configuration parameter for notification parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receivers": { "type": "array", "description": "List of Alert Receivers where the alerts will be sent.", "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Alert Receivers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of Alert Receivers where the alerts will be sent.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "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 } }, "routes": { "type": "array", "description": "Set of routes to match the incoming alert.\nThe routes are evaluated in the specified order and terminates on the first match.", "maxItems": 16, "items": { "$ref": "#/components/schemas/alert_policyRoute" }, "x-displayname": "Policy Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16" }, "x-f5xc-description-short": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-description-medium": "Set of routes to match the incoming alert. The routes are evaluated in the specified order and terminates on the first match.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Replaces the content of the Alert Policy Object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyReplaceSpecType", "required_fields": [ "receivers", "routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"receivers\": [\n {}\n ],\n \"routes\": [\n {}\n ]\n}", "example_yaml": "receivers:\n- {}\nroutes:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyRoute": { "type": "object", "description": "Route defines the match conditions to match the incoming alert and the receiver to send the alert.", "title": "Route", "x-displayname": "Route", "x-ves-oneof-field-action": "[\"dont_send\",\"send\"]", "x-ves-oneof-field-matcher": "[\"alertname\",\"alertname_regex\",\"any\",\"custom\",\"group\",\"severity\"]", "x-ves-proto-message": "ves.io.schema.alert_policy.Route", "properties": { "alertname": { "allOf": [ { "$ref": "#/components/schemas/alert_policyAlertName" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname_regex", "any", "custom", "group", "severity" ] }, "alertname_regex": { "type": "string", "description": "Exclusive with [alertname any custom group severity]\nRegular Expression match for the alertname.", "title": "Alertname Regex Match", "x-displayname": "Matching RegEx of Alertname.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Exclusive with [alertname any custom group severity] Regular Expression match for the alertname.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname", "any", "custom", "group", "severity" ] }, "any": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname", "alertname_regex", "custom", "group", "severity" ] }, "custom": { "allOf": [ { "$ref": "#/components/schemas/alert_policyCustomMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname", "alertname_regex", "any", "group", "severity" ] }, "dont_send": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "send" ] }, "group": { "allOf": [ { "$ref": "#/components/schemas/alert_policyGroupMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname", "alertname_regex", "any", "custom", "severity" ] }, "notification_parameters": { "allOf": [ { "$ref": "#/components/schemas/alert_policyNotificationParameters" } ], "x-f5xc-description-short": "Configuration parameter for notification parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "send": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dont_send" ] }, "severity": { "allOf": [ { "$ref": "#/components/schemas/alert_policySeverityMatcher" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "alertname", "alertname_regex", "any", "custom", "group" ] } }, "x-f5xc-description-short": "Route defines the match conditions to match the incoming alert and the receiver to send the alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyRoute", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "network", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policySeverity": { "type": "string", "description": "List of alert severities\n\nMinor\nMajor\nCritical.", "title": "Severity", "enum": [ "MINOR", "MAJOR", "CRITICAL" ], "default": "MINOR", "x-displayname": "Severity", "x-ves-proto-enum": "ves.io.schema.alert_policy.Severity", "x-f5xc-description-short": "List of alert severities Minor Major Critical.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policySeverity", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"MINOR\"", "example_yaml": "MINOR\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policySeverityMatcher": { "type": "object", "description": "Select one or more severity levels to match the incoming alert.", "title": "Severity Matcher", "x-displayname": "Severity Matcher.", "x-ves-displayorder": "1", "x-ves-proto-message": "ves.io.schema.alert_policy.SeverityMatcher", "properties": { "severities": { "type": "array", "description": "List of severity levels.", "title": "Severities", "items": { "$ref": "#/components/schemas/alert_policySeverity" }, "x-displayname": "Severities.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Select one or more severity levels to match the incoming alert.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policySeverityMatcher", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_policyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Alert Policy Status", "x-displayname": "Status Object.", "x-ves-proto-message": "ves.io.schema.alert_policy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_policyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "ioschemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alert_receiverAuthToken": { "type": "object", "description": "Authentication Token for access.", "title": "Token Authentication", "x-displayname": "Access Token.", "x-ves-proto-message": "ves.io.schema.alert_receiver.AuthToken", "properties": { "token": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverAuthToken", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverCACertificateObj": { "type": "object", "description": "Configuration for CA certificate.", "title": "CA Certificate Object", "x-displayname": "CA Certificate Object.", "x-ves-proto-message": "ves.io.schema.alert_receiver.CACertificateObj", "properties": { "trusted_ca": { "type": "array", "description": "Reference to client certificate object.", "title": "certificate_object_refs", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Certificate Object.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverCACertificateObj", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverClientCertificateObj": { "type": "object", "description": "Configuration for client certificate.", "title": "Client Certificate Object", "x-displayname": "Client Certificate Object.", "x-ves-proto-message": "ves.io.schema.alert_receiver.ClientCertificateObj", "properties": { "use_tls_obj": { "type": "array", "description": "Reference to client certificate object.", "title": "certificate_object_refs", "maxItems": 1, "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Certificate Object.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverClientCertificateObj", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverConfirmAlertReceiverRequest": { "type": "object", "description": "Request to confirm the Alert Receiver.", "title": "Confirm Alert Receiver Request", "x-displayname": "Confirm Alert Receiver Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.ConfirmAlertReceiverRequest", "properties": { "name": { "type": "string", "description": "Name of the alert receiver.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Email1", "x-f5xc-example": "email1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the alert receiver is configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace in which the alert receiver is configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "verification_code": { "type": "string", "description": "Verification Code received by the user.", "title": "Verification Code", "x-displayname": "Verification Code.", "x-ves-example": "123456", "x-ves-validation-rules": { "ves.io.schema.rules.string.len_bytes": "6" }, "x-f5xc-example": "123456", "x-validation-rules": { "ves.io.schema.rules.string.len_bytes": "6" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverConfirmAlertReceiverRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"ns1\"\n}", "example_yaml": "namespace: ns1" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverConfirmAlertReceiverResponse": { "type": "object", "description": "Response for the Alert Receiver Confirm request; empty because the only returned\ninformation is error message.", "title": "Confirm Alert Receiver Response", "x-displayname": "Confirm Alert Receiver Response.", "x-ves-proto-message": "ves.io.schema.alert_receiver.ConfirmAlertReceiverResponse", "x-f5xc-description-short": "Response for the Alert Receiver Confirm request; empty because the only returned information is error message.", "x-f5xc-description-medium": "Response for the Alert Receiver Confirm request; empty because the only returned information is error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverConfirmAlertReceiverResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of alert_receiver", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Alert receiver for F5 XC alert notifications", "required_fields": [ "metadata.name", "metadata.namespace" ], "mutually_exclusive_groups": [ { "name": "receiver", "fields": [ "spec.email", "spec.opsgenie", "spec.pagerduty", "spec.slack", "spec.sms", "spec.webhook" ], "required": true, "reason": "Choose exactly one notification channel" } ], "example_yaml": "metadata:\n name: example-alert-receiver\n namespace: system\nspec:\n email:\n email: alerts@example.com\n", "example_json": "{\n \"metadata\": {\"name\": \"example-alert-receiver\", \"namespace\": \"system\"},\n \"spec\": {\n \"email\": {\"email\": \"alerts@example.com\"}\n }\n}\n" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.alert_receiver.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverCreateSpecType": { "type": "object", "description": "Creates a new Alert Receiver object.", "title": "Create Alert Receiver", "x-displayname": "Create Alert Receiver.", "x-ves-oneof-field-receiver": "[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]", "x-ves-proto-message": "ves.io.schema.alert_receiver.CreateSpecType", "properties": { "email": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverEmailConfig" } ], "x-f5xc-example": "user@example.com", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "opsgenie", "pagerduty", "slack", "sms", "webhook" ] }, "opsgenie": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverOpsGenieConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "pagerduty", "slack", "sms", "webhook" ] }, "pagerduty": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverPagerDutyConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "slack", "sms", "webhook" ] }, "slack": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSlackConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "sms", "webhook" ] }, "sms": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSMSConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "webhook" ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverWebhookConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "sms" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a alert_receiver", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverEmailConfig": { "type": "object", "title": "EmailConfig", "x-displayname": "Email Configuration.", "x-ves-proto-message": "ves.io.schema.alert_receiver.EmailConfig", "properties": { "email": { "type": "string", "description": "Email ID of the user.", "title": "Email", "x-displayname": "Email", "x-ves-example": "Dana@example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "x-f5xc-example": "dana@example.com", "x-validation-rules": { "ves.io.schema.rules.string.email": "true" }, "format": "email", "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "format": "email", "minLength": 3, "formatDescription": "RFC 5322 email address, max 254 characters", "validation": { "rfc": "RFC 5322" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverEmailConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read alert_receiver", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.alert_receiver.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverReplaceRequest" } ], "x-f5xc-description-short": "Configuration parameter for replace form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_receiverStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverGetSpecType": { "type": "object", "description": "GET the Alert Receiver object.", "title": "Get Alert Receiver", "x-displayname": "GET Alert Receiver.", "x-ves-oneof-field-receiver": "[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]", "x-ves-proto-message": "ves.io.schema.alert_receiver.GetSpecType", "properties": { "email": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverEmailConfig" } ], "x-f5xc-example": "user@example.com", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "opsgenie", "pagerduty", "slack", "sms", "webhook" ] }, "opsgenie": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverOpsGenieConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "pagerduty", "slack", "sms", "webhook" ] }, "pagerduty": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverPagerDutyConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "slack", "sms", "webhook" ] }, "slack": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSlackConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "sms", "webhook" ] }, "sms": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSMSConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "webhook" ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverWebhookConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "sms" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverHTTPConfig": { "type": "object", "description": "Configuration for HTTP endpoint.", "title": "HTTP Configuration", "x-displayname": "HTTP Configuration.", "x-ves-displayorder": "15,11,4,5", "x-ves-oneof-field-auth_choice": "[\"auth_token\",\"basic_auth\",\"client_cert_obj\",\"no_authorization\"]", "x-ves-oneof-field-tls_choice": "[\"no_tls\",\"use_tls\"]", "x-ves-proto-message": "ves.io.schema.alert_receiver.HTTPConfig", "properties": { "auth_token": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverAuthToken" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "basic_auth", "client_cert_obj", "no_authorization" ] }, "basic_auth": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverHttpBasicAuth" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_token", "client_cert_obj", "no_authorization" ] }, "client_cert_obj": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverClientCertificateObj" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_token", "basic_auth", "no_authorization" ] }, "enable_http2": { "type": "boolean", "description": "Configure to use HTTP2 protocol.", "title": "Enable HTTP2", "format": "boolean", "x-displayname": "Enable HTTP2.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "follow_redirects": { "type": "boolean", "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", "title": "Follow Redirects", "format": "boolean", "x-displayname": "Follow Redirects.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Configure whether HTTP requests follow HTTP 3xx redirects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "no_authorization": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no authorization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "auth_token", "basic_auth", "client_cert_obj" ] }, "no_tls": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_tls" ] }, "use_tls": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverTLSConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_tls" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverHTTPConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverHttpBasicAuth": { "type": "object", "description": "Authorization parameters to access HTPP alert Receiver Endpoint.", "title": "HTTP Basic Authorization", "x-displayname": "Basic Authorization Credentials.", "x-ves-proto-message": "ves.io.schema.alert_receiver.HttpBasicAuth", "properties": { "password": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "user_name": { "type": "string", "description": "HTTP Basic Auth User Name.", "title": "username", "maxLength": 64, "x-displayname": "User Name", "x-ves-example": "Joe", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-example": "Joe", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Authorization parameters to access HTPP alert Receiver Endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverHttpBasicAuth", "required_fields": [ "user_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"user_name\": \"Joe\"\n}", "example_yaml": "user_name: Joe" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of alert_receiver", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.alert_receiver.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/alert_receiverListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverListResponseItem": { "type": "object", "description": "By default a summary of alert_receiver is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of alert_receiver", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.alert_receiver.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this alert_receiver.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this alert_receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this alert_receiver.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this alert_receiver.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates alert_receiver is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates alert_receiver is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this alert_receiver.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this alert_receiver.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this alert_receiver.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/alert_receiverStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this alert_receiver.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of alert_receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of alert_receiver is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverOpsGenieConfig": { "type": "object", "description": "OpsGenie configuration to send alert notifications.", "title": "Opsgenie Config", "x-displayname": "OpsGenie Config.", "x-ves-proto-message": "ves.io.schema.alert_receiver.OpsGenieConfig", "properties": { "api_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "URL to send API requests to.", "title": "URL", "x-displayname": "API URL", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "OpsGenie configuration to send alert notifications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverOpsGenieConfig", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"value\"\n}", "example_yaml": "url: value" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverPagerDutyConfig": { "type": "object", "description": "PagerDuty configuration to send alert notifications.", "title": "PagerDuty Config", "x-displayname": "PagerDuty Config.", "x-ves-proto-message": "ves.io.schema.alert_receiver.PagerDutyConfig", "properties": { "routing_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "type": "string", "description": "URL to send API requests to.", "title": "URL", "x-displayname": "Pager Duty URL.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "PagerDuty configuration to send alert notifications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverPagerDutyConfig", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"value\"\n}", "example_yaml": "url: value" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a alert_receiver", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.ReplaceRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectReplaceMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverReplaceSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Alert receiver for F5 XC alert notifications", "required_fields": [], "mutually_exclusive_groups": [ { "name": "receiver", "fields": [ "spec.email", "spec.opsgenie", "spec.pagerduty", "spec.slack", "spec.sms", "spec.webhook" ], "required": true, "reason": "Choose exactly one notification channel" } ], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.alert_receiver.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverReplaceSpecType": { "type": "object", "description": "Replaces the content of an Alert Receiver object.", "title": "Replace Alert Receiver", "x-displayname": "Replace Alert Receiver.", "x-ves-oneof-field-receiver": "[\"email\",\"opsgenie\",\"pagerduty\",\"slack\",\"sms\",\"webhook\"]", "x-ves-proto-message": "ves.io.schema.alert_receiver.ReplaceSpecType", "properties": { "email": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverEmailConfig" } ], "x-f5xc-example": "user@example.com", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "opsgenie", "pagerduty", "slack", "sms", "webhook" ] }, "opsgenie": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverOpsGenieConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "pagerduty", "slack", "sms", "webhook" ] }, "pagerduty": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverPagerDutyConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "slack", "sms", "webhook" ] }, "slack": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSlackConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "sms", "webhook" ] }, "sms": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverSMSConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "webhook" ] }, "webhook": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverWebhookConfig" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "email", "opsgenie", "pagerduty", "slack", "sms" ] } }, "x-f5xc-description-short": "Replaces the content of an Alert Receiver object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverSMSConfig": { "type": "object", "title": "SMSConfig", "x-displayname": "SMS Configuration.", "x-ves-proto-message": "ves.io.schema.alert_receiver.SMSConfig", "properties": { "contact_number": { "type": "string", "description": "Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code]", "title": "Contact Number", "x-displayname": "Contact Number.", "x-ves-example": "+14084004001.", "x-ves-validation-rules": { "ves.io.schema.rules.string.phone_number": "true" }, "x-f5xc-example": "+14084004001", "x-validation-rules": { "ves.io.schema.rules.string.phone_number": "true" }, "x-f5xc-description-short": "Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code].", "x-f5xc-description-medium": "Contact number of the user in ITU E.164 format [+][country code][subscriber number including area code].", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverSMSConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverSlackConfig": { "type": "object", "description": "Slack configuration to send alert notifications.", "title": "Slack Config", "x-displayname": "Slack Config.", "x-ves-proto-message": "ves.io.schema.alert_receiver.SlackConfig", "properties": { "channel": { "type": "string", "description": "Channel or user to send notifications to.", "title": "Channel", "x-displayname": "Channel", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^[a-z0-9-_]{1,80}$" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^[a-z0-9-_]{1,80}$" }, "x-f5xc-description-short": "Channel or user to send notifications to.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[a-z0-9-_]{1,80}$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "url": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Slack configuration to send alert notifications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverSlackConfig", "required_fields": [ "channel" ], "mutually_exclusive_groups": [], "example_json": "{\n \"channel\": \"value\"\n}", "example_yaml": "channel: value" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Alert Receiver Status", "x-displayname": "Status Object.", "x-ves-proto-message": "ves.io.schema.alert_receiver.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverTLSConfig": { "type": "object", "description": "Configures the token request's TLS settings.", "title": "TLS Config", "x-displayname": "TLS Config.", "x-ves-displayorder": "10,14,15", "x-ves-oneof-field-server_validation_choice": "[\"use_server_verification\",\"volterra_trusted_ca\"]", "x-ves-oneof-field-sni_choice": "[\"disable_sni\",\"sni\"]", "x-ves-proto-message": "ves.io.schema.alert_receiver.TLSConfig", "properties": { "disable_sni": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable sni.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sni" ] }, "max_version": { "allOf": [ { "$ref": "#/components/schemas/schemaTlsProtocol" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "min_version": { "allOf": [ { "$ref": "#/components/schemas/schemaTlsProtocol" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sni": { "type": "string", "description": "Exclusive with [disable_sni]\nSNI value to be used.", "title": "sni", "maxLength": 256, "x-displayname": "SNI Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Exclusive with [disable_sni] SNI value to be used.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_sni" ] }, "use_server_verification": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverUpstreamTlsValidationContext" } ], "x-f5xc-description-short": "Configuration parameter for use server verification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "volterra_trusted_ca" ] }, "volterra_trusted_ca": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for volterra trusted ca.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_server_verification" ] } }, "x-f5xc-description-short": "Configures the token request's TLS settings.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverTLSConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverTestAlertReceiverRequest": { "type": "object", "description": "Request to send test alert.", "title": "Test Alert Receiver Request", "x-displayname": "Test Alert Receiver Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.TestAlertReceiverRequest", "properties": { "name": { "type": "string", "description": "Name of the alert receiver.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Slack1", "x-f5xc-example": "slack1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the alert receiver is configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace in which the alert receiver is configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverTestAlertReceiverRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"ns1\"\n}", "example_yaml": "namespace: ns1" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverTestAlertReceiverResponse": { "type": "object", "description": "Response for the Alert Receiver test request; empty because the only returned\ninformation is error message.", "title": "Test Alert Receiver Response", "x-displayname": "Test Alert Receiver Response.", "x-ves-proto-message": "ves.io.schema.alert_receiver.TestAlertReceiverResponse", "x-f5xc-description-short": "Response for the Alert Receiver test request; empty because the only returned information is error message.", "x-f5xc-description-medium": "Response for the Alert Receiver test request; empty because the only returned information is error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverTestAlertReceiverResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverUpstreamTlsValidationContext": { "type": "object", "description": "Upstream TLS Validation Context.", "title": "UpstreamTlsValidationContext", "x-displayname": "TLS Validation Context for Servers.", "x-ves-proto-message": "ves.io.schema.alert_receiver.UpstreamTlsValidationContext", "properties": { "ca_cert_obj": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverCACertificateObj" } ], "x-f5xc-description-short": "Configuration parameter for ca cert obj.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverUpstreamTlsValidationContext", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverVerifyAlertReceiverRequest": { "type": "object", "description": "Send request to verify Alert Receiver.", "title": "Verify Alert Receiver Request", "x-displayname": "Verify Alert Receiver Request.", "x-ves-proto-message": "ves.io.schema.alert_receiver.VerifyAlertReceiverRequest", "properties": { "name": { "type": "string", "description": "Name of the alert receiver.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Email1", "x-f5xc-example": "email1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the alert receiver is configured.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace in which the alert receiver is configured.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverVerifyAlertReceiverRequest", "required_fields": [ "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"namespace\": \"ns1\"\n}", "example_yaml": "namespace: ns1" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverVerifyAlertReceiverResponse": { "type": "object", "description": "Response for the Alert Receiver Verify request; empty because the only returned\ninformation is error message.", "title": "Verify Alert Receiver Response", "x-displayname": "Verify Alert Receiver Response.", "x-ves-proto-message": "ves.io.schema.alert_receiver.VerifyAlertReceiverResponse", "x-f5xc-description-short": "Response for the Alert Receiver Verify request; empty because the only returned information is error message.", "x-f5xc-description-medium": "Response for the Alert Receiver Verify request; empty because the only returned information is error message.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverVerifyAlertReceiverResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "alert_receiverWebhookConfig": { "type": "object", "description": "Webhook configuration to send alert notifications.", "title": "Webhook Config", "x-displayname": "Webhook Config.", "x-ves-proto-message": "ves.io.schema.alert_receiver.WebhookConfig", "properties": { "http_config": { "allOf": [ { "$ref": "#/components/schemas/alert_receiverHTTPConfig" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "url": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Webhook configuration to send alert notifications.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alert_receiverWebhookConfig", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "alert", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert receivers are platform-level monitoring" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "schemaBlindfoldSecretInfoType": { "type": "object", "description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "title": "BlindfoldSecretInfoType", "x-displayname": "Blindfold Secret.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BlindfoldSecretInfoType", "properties": { "decryption_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "title": "Decryption Provider", "x-displayname": "Decryption Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location is the uri_ref. It could be in URL format for string:///\nOr it could be a path if the store provider is an HTTP/HTTPS location.", "title": "Location", "x-displayname": "Location", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "minLength": 4, "maxLength": 131072, "format": "uri", "deterministic": true, "metadata": { "source": "manual-override", "confidence": 1.0, "category": "content", "note": "Blindfold envelope encryption (AES-256-GCM + RSA-OAEP) of an RSA-2048 TLS private key produces ~3700 char string:/// URL. 128KB max secret size = ~175KB base64. Discovery reported 1024 which is incorrect.", "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "store_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Store Provider", "x-displayname": "Store Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBlindfoldSecretInfoType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "location: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "per-tenant" } } }, "schemaClearSecretInfoType": { "type": "object", "description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "title": "ClearSecretInfoType", "x-displayname": "In-Clear Secret.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.ClearSecretInfoType", "properties": { "provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "Box-provider.", "x-f5xc-example": "box-provider", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "URL of the secret. Currently supported URL schemes is string:///.\nFor string:/// scheme, Secret needs to be encoded Base64 format.\nWhen asked for this secret, caller will GET Secret bytes after Base64 decoding.", "title": "URL", "maxLength": 131072, "x-displayname": "URL", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.", "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding.", "format": "uri", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 131072 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaClearSecretInfoType", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "url: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaSecretType": { "type": "object", "description": "SecretType is used in an object to indicate a sensitive/confidential field.", "title": "SecretType", "x-displayname": "Secret", "x-ves-oneof-field-secret_info_oneof": "[\"blindfold_secret_info\",\"clear_secret_info\"]", "x-ves-proto-message": "ves.io.schema.SecretType", "properties": { "blindfold_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaBlindfoldSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "clear_secret_info" ] }, "clear_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaClearSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blindfold_secret_info" ] } }, "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSecretType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Secret management is platform-level" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemaTlsProtocol": { "type": "string", "description": "TlsProtocol is enumeration of supported TLS versions\n\nF5 Distributed Cloud will choose the optimal TLS version.", "title": "TlsProtocol", "enum": [ "TLS_AUTO", "TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3" ], "default": "TLS_AUTO", "x-displayname": "TLS Protocol.", "x-ves-proto-enum": "ves.io.schema.TlsProtocol", "x-f5xc-description-short": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.", "x-f5xc-description-medium": "TlsProtocol is enumeration of supported TLS versions F5 Distributed Cloud will choose the optimal TLS version.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTlsProtocol", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TLS_AUTO\"", "example_yaml": "TLS_AUTO\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alertAlertsHistoryAggregationRequest": { "type": "object", "description": "Request to GET only aggregation data for alerts.", "title": "Alerts History Aggregation Request", "x-displayname": "Alerts History Aggregation Request.", "x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryAggregationRequest", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\nOptional.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the alert response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the alert response. If the number of alerts that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key'ed by user-defined aggregation name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "end_time": { "type": "string", "description": "Fetch alerts whose timestamp <= end_time\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": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch alerts whose timestamp <= end_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to...", "x-f5xc-description-medium": "Fetch alerts whose timestamp <= end_time 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 } }, "filter": { "type": "string", "description": "List of matchers to filter alert by.\nSyntax for filter := {[]}\n := \"\"\n := string\nAll alerts have the following default labels:\n\"alertname\", \"identifier\", \"group\", \"severity\"\n := string\n := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n= : Select labels that are exactly equal to the provided string\n!= : Select labels that are not equal to the provided string.\nWhen more than one matcher is specified in the filter, then alerts matching ALL the matchers will be returned.\n\nOptional: If not specified, then all the alerts for the tenant and namespace specified in the request will be returned.", "title": "filter", "x-displayname": "Filter", "x-ves-example": "{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}", "x-f5xc-example": "\"{alertname=\\\"HighDiskUsage\\\", severity=\\\"critical\\\"}\"", "x-f5xc-description-medium": "List of matchers to filter alert by. Syntax for filter := {[]} := \"\" := string All alerts have the following default labels: \"alertname\", \"identifier\", \"group\", \"severity\" := string :=...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace to scope the listing of alerts.\nFor \"system\" namespace, all alerts for the tenant will be returned.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace to scope the listing of alerts. For \"system\" namespace, all alerts for the tenant will be returned.", "x-f5xc-description-medium": "Namespace to scope the listing of alerts. For \"system\" namespace, all alerts for the tenant will be returned.", "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": "Fetch alerts whose timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Fetch alerts whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to...", "x-f5xc-description-medium": "Fetch alerts whose timestamp >= start_time format: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET only aggregation data for alerts.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alertAlertsHistoryAggregationRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alertAlertsHistoryAggregationResponse": { "type": "object", "description": "Response message for AlertsHistoryAggregationRequest.", "title": "Alerts History Aggregation Response", "x-displayname": "Alerts History Aggregation Response.", "x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryAggregationResponse", "properties": { "aggs": { "type": "object", "description": "Aggregations provide summary/analytics data over the alerts response. If the number of alerts that matched the query\nis large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations.\nThe aggregation data is key'ed with the aggregation name specified in the request.", "title": "aggregations", "x-displayname": "Aggregations.", "x-f5xc-description-short": "Aggregations provide summary/analytics data over the alerts response.", "x-f5xc-description-medium": "Aggregations provide summary/analytics data over the alerts response. If the number of alerts that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is key'ed with the aggregation name...", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "total_hits": { "type": "string", "description": "Total number of alerts that matched the query.", "title": "total hits", "format": "uint64", "x-displayname": "Total Hits.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Total number of alerts that matched the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response message for AlertsHistoryAggregationRequest.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alertAlertsHistoryAggregationResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alertAlertsHistoryResponse": { "type": "object", "description": "Response message for AlertsHistoryRequest/AlertsHistoryScrollRequest.", "title": "Alerts History Response", "x-displayname": "Alerts History Response.", "x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryResponse", "properties": { "alerts": { "type": "array", "description": "List of alerts that matched the filter. Contains no more than 500 alerts per response.", "title": "alerts", "items": { "type": "string" }, "x-displayname": "Alerts", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "List of alerts that matched the filter. Contains no more than 500 alerts per response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scroll_id": { "type": "string", "description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.\nEmpty scroll_id indicates no more messages to scroll (EOF).\nNote: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the\nscroll request should be sent within 2 minutes upon receiving the response.", "title": "scroll_id", "x-displayname": "Scroll ID", "x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.", "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==", "x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request.", "x-f5xc-description-medium": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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" }, "total_hits": { "type": "string", "description": "Total number of alerts that matched the query.", "title": "total hits", "format": "uint64", "x-displayname": "Total Hits.", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Total number of alerts that matched the query.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response message for AlertsHistoryRequest/AlertsHistoryScrollRequest.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alertAlertsHistoryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alertAlertsHistoryScrollRequest": { "type": "object", "description": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse\ncontaining no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the\nAlertsHistoryScrollRequest. Use the scroll_id returned in the AlertsHistoryResponse to fetch the next batch of alert messages and\none can continue this process till the scroll_id returned in the AlertsHistoryResponse is \"\" which indicates no more\nalert messages to scroll.", "title": "Alerts History Scroll Request", "x-displayname": "Alerts History Scroll Request.", "x-ves-proto-message": "ves.io.schema.alert.AlertsHistoryScrollRequest", "properties": { "namespace": { "type": "string", "description": "Fetch the alerts scoped by namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "scroll_id": { "type": "string", "description": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages.", "title": "scroll_id", "x-displayname": "Scroll ID", "x-ves-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==.", "x-f5xc-example": "Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==", "x-f5xc-description-short": "Long Base-64 encoded string which can be used to retrieve next batch of alert messages.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse containing no more than 500 alerts.", "x-f5xc-description-medium": "Scroll request is used to fetch large number of alert messages in multiple batches with each AlertsHistoryResponse containing no more than 500 alerts. To scroll through more than 500 or all alert messages, one can use the AlertsHistoryScrollRequest. Use the scroll_id returned in the...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alertAlertsHistoryScrollRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "alertResponse": { "type": "object", "description": "Returns list of alerts that matches the selection criteria in the request\nExample value:\n[\n{\n\"annotations\": {\n\"description\": \"string\",\n\"additionalProp1\": \"string\",\n\"additionalProp2\": \"string\"\n},\n\"receivers\": [\n{\n\"name\": \"string\"\n}\n],\n\"fingerprint\": \"string\",\n\"startsAt\": \"2019-06-06T22:14:27.304Z\",\n\"updatedAt\": \"2019-06-06T22:14:27.304Z\",\n\"endsAt\": \"2019-06-06T22:14:27.304Z\",\n\"status\": {\n\"state\": \"unprocessed\",\n\"silencedBy\": [\n\"string\"\n],\n\"inhibitedBy\": [\n\"string\"\n]\n},\n\"labels\": {\n\"alertname\": \"string\",\n\"type\": \"string\",\n\"identifier\": \"string\",\n\"severity\": \"string\",\n\"additionalLabel1\": \"string\",\n\"additionalLabel2\": \"string\"\n},\n\"generatorURL\": \"string\"\n}\n]", "title": "Alerts Response", "x-displayname": "Alerts Response.", "x-ves-proto-message": "ves.io.schema.alert.Response", "properties": { "data": { "type": "string", "description": "Data contains the list of alerts.", "title": "data", "x-displayname": "Alerts", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Returns list of alerts that matches the selection criteria in the request Example value: [ { \"annotations\": { \"description\": \"string\"...", "x-f5xc-description-medium": "Returns list of alerts that matches the selection criteria in the request Example value: [ { \"annotations\": { \"description\": \"string\", \"additionalProp1\": \"string\", \"additionalProp2\": \"string\" }, \"receivers\": [ { \"name\": \"string\" } ], \"fingerprint\": \"string\", \"startsAt\"...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for alertResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "catalogListRequest": { "type": "object", "description": "List request message. Includes optional filter.", "title": "ListRequest", "x-displayname": "ListRequest.", "x-ves-oneof-field-filter": "[\"use_case_filter\",\"workspace_filter\"]", "x-ves-proto-message": "ves.io.schema.pbac.catalog.ListRequest", "properties": { "use_case_filter": { "type": "string", "description": "Exclusive with [workspace_filter]\nFilter by use case name. If empty, all use cases are returned.", "title": "Use case filter", "x-displayname": "Use case Filter.", "x-ves-example": "F5xc-base", "x-f5xc-example": "f5xc-base", "x-f5xc-description-short": "Exclusive with [workspace_filter] Filter by use case name. If empty, all use cases are returned.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "workspace_filter" ] }, "workspace_filter": { "type": "string", "description": "Exclusive with [use_case_filter]\nFilter by workspace name. If empty, all workspaces are returned.\nThe use case response field will contain the use case of the workspace and no other use cases.", "title": "Workspace Filter", "x-displayname": "Workspace Filter.", "x-ves-example": "F5xc-base", "x-f5xc-example": "f5xc-base", "x-f5xc-description-short": "Exclusive with [use_case_filter] Filter by workspace name. If empty, all workspaces are returned.", "x-f5xc-description-medium": "Exclusive with [use_case_filter] Filter by workspace name. If empty, all workspaces are returned. The use case response field will contain the use case of the workspace and no other use cases.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_case_filter" ] } }, "x-f5xc-description-short": "List request message. Includes optional filter.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for catalogListRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "catalogListResponse": { "type": "object", "description": "Response message for list request.", "title": "ListResponse", "x-displayname": "ListResponse.", "x-ves-proto-message": "ves.io.schema.pbac.catalog.ListResponse", "properties": { "addon_services": { "type": "object", "description": "List of Addon Services. The key is the addon service name.", "title": "Addon Services", "x-displayname": "Addon Services.", "x-f5xc-description-short": "List of Addon Services. The key is the addon service name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "services": { "type": "object", "description": "List of result services (addons). The key is the service name.", "title": "Services", "x-displayname": "Services", "x-f5xc-description-short": "List of result services (addons). The key is the service name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_management": { "type": "object", "description": "List of system management tiles. The key is the workspace name.", "title": "System Management", "x-displayname": "System Management.", "x-f5xc-description-short": "List of system management tiles. The key is the workspace name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_cases": { "type": "object", "description": "List of result use cases. The key is the use case name.", "title": "Use Cases", "x-displayname": "Use Cases", "x-f5xc-description-short": "List of result use cases. The key is the use case name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "workspaces": { "type": "object", "description": "List of result tiles (workspaces). The key is the workspace name.", "title": "Workspaces", "x-displayname": "Workspaces.", "x-f5xc-description-short": "List of result tiles (workspaces). The key is the workspace name.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for catalogListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityEdgeData": { "type": "object", "description": "EdgeData wraps all the response data for an edge in the connectivity graph response.", "title": "Edge Data", "x-displayname": "Edge Data", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeData", "properties": { "dst_id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreData" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Edge Metric data specified in the request.", "title": "Metric", "items": { "$ref": "#/components/schemas/graphconnectivityEdgeMetricData" }, "x-displayname": "Metric", "x-f5xc-description-short": "Edge Metric data specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-description-short": "EdgeData wraps all the response data for an edge in the connectivity graph response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityEdgeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityEdgeFieldSelector": { "type": "object", "description": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "title": "Edge Field Selector", "x-displayname": "Edge Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeFieldSelector", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreSelector" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphconnectivityEdgeMetricSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "x-f5xc-description-medium": "EdgeFieldSelector is used to specify the list of fields that should be returned per edge in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityEdgeFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityEdgeMetricType": { "type": "string", "description": "EdgeMetricType specifies the metrics that can be queried per edge in the connectivity graph.\n\nIndicates field not being set\nx-unit: \"percentage\"\nReachability of the destination site from the source site\nx-unit: \"seconds\"\nAverage latency for the edge reported by the source site\nx-unit: \"bits per second (bps)\"\nThroughput of the incoming traffic from destination site reported by the source site\nx-unit: \"bits per second (bps)\"\nThroughput of the outgoing traffic to destination site reported by the source site\nx-unit: \"packets per second (pps)\"\nDrop rate of the incoming traffic from destination site reported by the source site\nx-unit: \"packets per second (pps)\"\nDrop rate of the outgoing traffic to destination site reported by the source site\nx-unit: \"bool\"\nConnection status of the edge - 0 (down), 1 (up)\nx-unit: \"bool\"\nARES connection status of the edge - 0 (down), 1 (up)\nx-unit: \"bool\"\nData Plane Connection status of the edge - 0 (down), 1 (up)\nx-unit: \"bool\"\nControl Plane connection status of the edge - 0 (down), 1 (up)", "title": "Edge Metric Type", "enum": [ "EDGE_METRIC_TYPE_NONE", "EDGE_REACHABILITY", "EDGE_LATENCY", "EDGE_IN_THROUGHPUT", "EDGE_OUT_THROUGHPUT", "EDGE_IN_DROP_RATE", "EDGE_OUT_DROP_RATE", "EDGE_CONNECTION_STATUS", "EDGE_ARES_CONNECTION_STATUS", "EDGE_DATA_PLANE_CONNECTION_STATUS", "EDGE_CONTROL_PLANE_CONNECTION_STATUS" ], "default": "EDGE_METRIC_TYPE_NONE", "x-displayname": "Edge Metric Type.", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.EdgeMetricType", "x-f5xc-description-short": "EdgeMetricType specifies the metrics that can be queried per edge in the connectivity graph.", "x-f5xc-description-medium": "EdgeMetricType specifies the metrics that can be queried per edge in the connectivity graph. Indicates field not being set x-unit: \"percentage\" Reachability of the destination site from the source site x-unit: \"seconds\" Average latency for the edge reported by the source site x-unit: \"bits per...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityEdgeMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EDGE_METRIC_TYPE_NONE\"", "example_yaml": "EDGE_METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityEdgeRequest": { "type": "object", "description": "Request to GET the time-series data for an edge in the connectivity graph.\nWhile graph/connectivity API is used to GET connectivity data for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/connectivity/edge API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.", "title": "Connectivity Edge Request", "x-displayname": "Connectivity Edge Request.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeRequest", "properties": { "dst_id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "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 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": { "allOf": [ { "$ref": "#/components/schemas/connectivityEdgeFieldSelector" } ], "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])?$" }, "range": { "type": "string", "description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.", "title": "range", "x-displayname": "Range", "x-ves-example": "10m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "10m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.", "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "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: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "1570194000.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "1570194000", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-description-short": "Start time of 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: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET the time-series data for an edge in the connectivity graph.", "x-f5xc-description-medium": "Request to GET the time-series data for an edge in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/edge API is used to GET the time-series data...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityEdgeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityEdgeResponse": { "type": "object", "description": "Response for graph/connectivity/edge API returns the time-series data for the edge specified in the request.", "title": "Connectivity Edge Response", "x-displayname": "Connectivity Edge Response.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeResponse", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/connectivityEdgeData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/connectivity/edge API returns the time-series data for the edge specified in the request.", "x-f5xc-description-medium": "Response for graph/connectivity/edge API returns the time-series data for the edge specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityEdgeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityFieldSelector": { "type": "object", "description": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.", "title": "Field Selector", "x-displayname": "Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.FieldSelector", "properties": { "edge": { "allOf": [ { "$ref": "#/components/schemas/connectivityEdgeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.", "x-f5xc-description-medium": "FieldSelector is used to specify the list of fields to be returned in the response for connectivity graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityId": { "type": "object", "description": "ID uniquely identifies a node or an edge in the connectivity graph.", "title": "Id", "x-displayname": "ID", "x-ves-proto-message": "ves.io.schema.graph.connectivity.Id", "properties": { "site": { "type": "string", "description": "Name of the site.", "title": "Site", "x-displayname": "Site", "x-ves-example": "Ce01", "x-f5xc-example": "ce01", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_type": { "allOf": [ { "$ref": "#/components/schemas/siteSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "ID uniquely identifies a node or an edge in the connectivity graph.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityId", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityIdField": { "type": "string", "description": "IdField is used to select one or more fields that uniquely identifies\na node or an edge in the connectivity graph.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)", "title": "Id Field", "enum": [ "NONE", "SITE" ], "default": "NONE", "x-displayname": "ID Field", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.IdField", "x-f5xc-description-short": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the connectivity graph.", "x-f5xc-description-medium": "IdField is used to select one or more fields that uniquely identifies a node or an edge in the connectivity graph. Indicates the field not being set Identifies a site (CE or RE).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityIdField", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NONE\"", "example_yaml": "NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityLabelFilter": { "type": "object", "description": "Metrics used in the connectivity graph are tagged with labels listed in the enum Label.\nLabel Filter is used to filter the timeseries that match the specified label key/value\nand the operator.", "title": "Label Filter", "x-displayname": "Label Filter.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.LabelFilter", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/graphconnectivityLabel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/graphQueryOp" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Value of the label.", "title": "Value", "x-displayname": "Value", "x-ves-example": "Ce01", "x-f5xc-example": "ce01", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metrics used in the connectivity graph are tagged with labels listed in the enum Label.", "x-f5xc-description-medium": "Metrics used in the connectivity graph are tagged with labels listed in the enum Label. Label Filter is used to filter the timeseries that match the specified label key/value and the operator.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityLabelFilter", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeData": { "type": "object", "description": "NodeData wraps all the response data for a node in the connectivity graph response.", "title": "Node Data", "x-displayname": "Node Data", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeData", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreData" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "instances": { "type": "array", "description": "Instance data for the node requested by the user.", "title": "Instances", "items": { "$ref": "#/components/schemas/connectivityNodeInstanceData" }, "x-displayname": "Instances", "x-f5xc-description-short": "Instance data for the node requested by the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interfaces": { "type": "array", "description": "Interface data for the node requested by the user.", "title": "Interfaces", "items": { "$ref": "#/components/schemas/connectivityNodeInterfaceData" }, "x-displayname": "Interfaces.", "x-f5xc-description-short": "Interface data for the node requested by the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Node Metric data specified in the request.", "title": "Metric", "items": { "$ref": "#/components/schemas/graphconnectivityNodeMetricData" }, "x-displayname": "Metric", "x-f5xc-description-short": "Node Metric data specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeData wraps all the response data for a node in the connectivity graph response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeFieldSelector": { "type": "object", "description": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "title": "Node Field Selector", "x-displayname": "Node Field Selector.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeFieldSelector", "properties": { "healthscore": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreSelector" } ], "x-f5xc-description-short": "Configuration parameter for healthscore.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "allOf": [ { "$ref": "#/components/schemas/graphconnectivityNodeMetricSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "x-f5xc-description-medium": "NodeFieldSelector is used to specify the list of fields that should be returned per node in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInstanceData": { "type": "object", "description": "NodeInstanceData is part of the connectivity graph response that contains the instance name\nalong with the corresponding metric.", "title": "Node Instance Data", "x-displayname": "Node Instance Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeInstanceData", "properties": { "id": { "type": "string", "description": "Instance name.", "title": "ID", "x-displayname": "ID", "x-ves-example": "Master-0", "x-f5xc-example": "master-0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Instance Metric Data.", "title": "Metric", "items": { "$ref": "#/components/schemas/connectivityNodeInstanceMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeInstanceData is part of the connectivity graph response that contains the instance name along with the corresponding metric.", "x-f5xc-description-medium": "NodeInstanceData is part of the connectivity graph response that contains the instance name along with the corresponding metric.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInstanceData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInstanceMetricData": { "type": "object", "description": "NodeInstanceMetricData contains the metric type and the corresponding value for a node instance.", "title": "Node Instance Metric Data", "x-displayname": "Node Instance Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeInstanceMetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeInstanceMetricType" } ], "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 } }, "value": { "allOf": [ { "$ref": "#/components/schemas/graphMetricFeatureData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "NodeInstanceMetricData contains the metric type and the corresponding value for a node instance.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInstanceMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInstanceMetricType": { "type": "string", "description": "NodeInstanceMetricType lists the instance specific metrics per site.\n\nIndicates field not being set\nx-unit: \"percentage\"\nCPU utilization\nx-unit: \"percentage\"\nCPU utilization (excludes cpus allocated to dpdk and other internal entities)\nx-unit: \"percentage\"\nMemory utilization\nx-unit: \"percentage\"\nDisk utilization\nx-unit: \"celsius\"\nAverage GPU temperature\nx-unit: \"bits per second (bps)\"\nGPU Tx Throughput\nx-unit: \"bits per second (bps)\"\nGPU Rx Throughput\nx-unit: \"percentage\"\nGPU utilization\nx-unit: \"bool\"\nIndicates the status of a node - 0 (down), 1 (up)\nx-unit: \"bits per second\"\nIndicates incoming traffic from RE sites to site nodes\nx-unit: \"bits per second\"\nIndicates outgoing traffic from site nodes to RE sites\nx-unit: \"bool\"\nData plane connection status of a node\nx-unit: \"bool\"\nControl plane connection status of a node.", "title": "Node Interface Metric Type", "enum": [ "NODE_INSTANCE_METRIC_TYPE_NONE", "NODE_INSTANCE_CPU_USAGE", "NODE_INSTANCE_MEMORY_USAGE", "NODE_INSTANCE_DISK_USAGE", "NODE_INSTANCE_GPU_TEMPERATURE", "NODE_INSTANCE_GPU_TX_THROUGHPUT", "NODE_INSTANCE_GPU_RX_THROUGHPUT", "NODE_INSTANCE_GPU_USAGE", "NODE_INSTANCE_STATUS", "NODE_INSTANCE_CPU_USAGE_EXTERNAL", "NODE_INSTANCE_RE_IN_THROUGHPUT", "NODE_INSTANCE_RE_OUT_THROUGHPUT", "NODE_INSTANCE_DATA_PLANE_CONNECTION_STATUS", "NODE_INSTANCE_CONTROL_PLANE_CONNECTION_STATUS" ], "default": "NODE_INSTANCE_METRIC_TYPE_NONE", "x-displayname": "Node Interface Metric Type.", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeInstanceMetricType", "x-f5xc-description-short": "NodeInstanceMetricType lists the instance specific metrics per site.", "x-f5xc-description-medium": "NodeInstanceMetricType lists the instance specific metrics per site. Indicates field not being set x-unit: \"percentage\" CPU utilization x-unit: \"percentage\" CPU utilization (excludes cpus allocated to dpdk and other internal entities) x-unit: \"percentage\" Memory utilization x-unit: \"percentage\"...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInstanceMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NODE_INSTANCE_METRIC_TYPE_NONE\"", "example_yaml": "NODE_INSTANCE_METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInterfaceData": { "type": "object", "description": "NodeInterfaceData is part of the connectivity graph response that contains the interface name\nalong with the corresponding metric.", "title": "Node Interface Data", "x-displayname": "Node Interface Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeInterfaceData", "properties": { "id": { "type": "string", "description": "Interface name.", "title": "ID", "x-displayname": "ID", "x-ves-example": "Eth0", "x-f5xc-example": "eth0", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metric": { "type": "array", "description": "Interface Metric Data.", "title": "Metric", "items": { "$ref": "#/components/schemas/connectivityNodeInterfaceMetricData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_type": { "type": "string", "description": "Network Type can be \"INSIDE\" (LAN traffic) or \"OUTSIDE\" (WAN traffic)", "title": "Network Type", "x-displayname": "Network Type.", "x-ves-example": "OUTSIDE", "x-f5xc-example": "OUTSIDE", "x-f5xc-description-short": "Network Type can be \"INSIDE\" (LAN traffic) or \"OUTSIDE\" (WAN traffic).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment_name": { "type": "string", "description": "Segment name for network_type segment should be added in response.", "title": "Segment Name", "x-displayname": "Segment Name.", "x-ves-example": "Segment-1", "x-f5xc-example": "segment-1", "x-f5xc-description-short": "Segment name for network_type segment should be added in response.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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": "NodeInterfaceData is part of the connectivity graph response that contains the interface name along with the corresponding metric.", "x-f5xc-description-medium": "NodeInterfaceData is part of the connectivity graph response that contains the interface name along with the corresponding metric.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInterfaceData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInterfaceMetricData": { "type": "object", "description": "NodeInterfaceMetricData contains the metric type and the corresponding value for a node interface.", "title": "Node Interface Metric Data", "x-displayname": "Node Interface Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeInterfaceMetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeInterfaceMetricType" } ], "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 } }, "value": { "allOf": [ { "$ref": "#/components/schemas/graphMetricFeatureData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "NodeInterfaceMetricData contains the metric type and the corresponding value for a node interface.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInterfaceMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeInterfaceMetricType": { "type": "string", "description": "NodeInterfaceMetricType lists the interface specific metrics per site.\n\nIndicates field not being set\nx-unit: \"bool\"\nIndicates the interface status - 0 (down), 1 (up)\nx-unit: \"bits per second (bps)\"\nThroughput of the incoming traffic\nx-unit: \"bits per second (bps)\"\nThroughput of the outgoing traffic\nx-unit: \"packets per second (pps)\"\nDrop rate of incoming traffic\nx-unit: \"packets per second (pps)\"\nDrop rate of outgoing traffic\nx-unit: \"packets per second (pps)\"\nRate of incoming traffic\nx-unit: \"packets per second (pps)\"\nRate of outgoing traffic.", "title": "Node Interface Metric Type", "enum": [ "NODE_IF_METRIC_TYPE_NONE", "NODE_IF_STATUS", "NODE_IF_IN_THROUGHPUT", "NODE_IF_OUT_THROUGHPUT", "NODE_IF_IN_DROP_RATE", "NODE_IF_OUT_DROP_RATE", "NODE_IF_IN_PACKETS_RATE", "NODE_IF_OUT_PACKETS_RATE" ], "default": "NODE_IF_METRIC_TYPE_NONE", "x-displayname": "Node Interface Metric Type.", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeInterfaceMetricType", "x-f5xc-description-short": "NodeInterfaceMetricType lists the interface specific metrics per site.", "x-f5xc-description-medium": "NodeInterfaceMetricType lists the interface specific metrics per site. Indicates field not being set x-unit: \"bool\" Indicates the interface status - 0 (down), 1 (up) x-unit: \"bits per second (bps)\" Throughput of the incoming traffic x-unit: \"bits per second (bps)\" Throughput of the outgoing...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeInterfaceMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NODE_IF_METRIC_TYPE_NONE\"", "example_yaml": "NODE_IF_METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeMetricType": { "type": "string", "description": "NodeMetricType specifies the metrics that can be queried per node in the connectivity graph.\n\nIndicates field not being set\nx-unit: \"bits per second (bps)\"\nThroughput of incoming traffic\nx-unit: \"bits per second (bps)\"\nThroughput of outgoing traffic\nx-unit: \"packets per second (pps)\"\nDrop rate of incoming traffic\nx-unit: \"packets per second (pps)\"\nDrop rate of outgoing traffic\nx-unit: \"count\"\nNumber of deployments\nx-unit: \"count\"\nNumber of pods\nx-unit: \"percentage\"\nReachability of the node computed based on reachability from all the connected nodes.\nX-unit: \"bool\"\nConnection status of the node - 0 (down), 1 (up)\nx-unit: \"bool\"\nARES connection status of the node = 0 (down), 1 (up)\nx-unit: \"bool\"\nData Plane Connection status of the node - 0 (down), 1 (up)\nx-unit: \"bool\"\nControl Plane connection status of the node = 0 (down), 1 (up)\nx-unit: \"bool\"\nLocal Control Plane connection status of the node = 0 (down), 1 (up)", "title": "Node Metric Type", "enum": [ "NODE_METRIC_TYPE_NONE", "NODE_IN_THROUGHPUT", "NODE_OUT_THROUGHPUT", "NODE_IN_DROP_RATE", "NODE_OUT_DROP_RATE", "NODE_DEPLOYMENT_COUNT", "NODE_POD_COUNT", "NODE_REACHABILITY", "NODE_CONNECTION_STATUS", "NODE_ARES_CONNECTION_STATUS", "NODE_DATA_PLANE_CONNECTION_STATUS", "NODE_CONTROL_PLANE_CONNECTION_STATUS", "NODE_LOCAL_CONTROL_PLANE_CONNECTION_STATUS" ], "default": "NODE_METRIC_TYPE_NONE", "x-displayname": "Node Metric Type.", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.NodeMetricType", "x-f5xc-description-short": "NodeMetricType specifies the metrics that can be queried per node in the connectivity graph.", "x-f5xc-description-medium": "NodeMetricType specifies the metrics that can be queried per node in the connectivity graph. Indicates field not being set x-unit: \"bits per second (bps)\" Throughput of incoming traffic x-unit: \"bits per second (bps)\" Throughput of outgoing traffic x-unit: \"packets per second (pps)\" Drop rate of...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeMetricType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NODE_METRIC_TYPE_NONE\"", "example_yaml": "NODE_METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeRequest": { "type": "object", "description": "Request to GET time-series data for a node in the connectivity graph.\nWhile graph/connectivity API is used to GET connectivity data for all sites,\nwhere each node and edge contains the aggregated value for each field;\ngraph/connectivity/node API is used to GET the time-series data (drill-down of aggregated data)\nfor each field.", "title": "Connectivity Node Request", "x-displayname": "Connectivity Node Request.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeRequest", "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": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "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": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_by": { "type": "array", "description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.", "title": "group_by", "maxItems": 4, "items": { "$ref": "#/components/schemas/connectivityIdField" }, "x-displayname": "Group By", "x-ves-validation-rules": { "ves.io.schema.rules.enum.defined_only": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.enum.defined_only": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "allOf": [ { "$ref": "#/components/schemas/connectivityId" } ], "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label_filter": { "type": "array", "description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.", "title": "label_filter", "items": { "$ref": "#/components/schemas/connectivityLabelFilter" }, "x-displayname": "Label Filter.", "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".", "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.", "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])?$" }, "range": { "type": "string", "description": "Range decides how far to go back in time to fetch values for each step.\nFor example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\nt2, query will be evaluated for t2-5m and so on.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nNote: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\nOptional: If not specified, range is set to 5m.", "title": "range", "x-displayname": "Range", "x-ves-example": "10m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "10m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Range decides how far to go back in time to fetch values for each step.", "x-f5xc-description-medium": "Range decides how far to go back in time to fetch values for each step. For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for t2, query will be evaluated for t2-5m and so on. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered to build graph.\nFormat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "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: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nOptional: If not specified, then step size is evaluated to ", "title": "step", "x-displayname": "Step", "x-ves-example": "5m", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-example": "5m", "x-validation-rules": { "ves.io.schema.rules.string.query_step": "true" }, "x-f5xc-description-short": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.", "x-f5xc-description-medium": "Step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response. The timestamps in the response will be t1=start_time, t2=t1+step, ... Tn=tn-1+step, where tn <= end_time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to GET time-series data for a node in the connectivity graph.", "x-f5xc-description-medium": "Request to GET time-series data for a node in the connectivity graph. While graph/connectivity API is used to GET connectivity data for all sites, where each node and edge contains the aggregated value for each field; graph/connectivity/node API is used to GET the time-series data (drill-down of...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityNodeResponse": { "type": "object", "description": "Response for graph/connectivity/node API returns the time-series data for the site\nspecified in the request.", "title": "Connectivity Node Response", "x-displayname": "Connectivity Node Response.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeResponse", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "step": { "type": "string", "description": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "title": "step", "x-displayname": "Step", "x-ves-example": "30m", "x-ves-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-example": "30m", "x-validation-rules": { "ves.io.schema.rules.string.time_interval": "true" }, "x-f5xc-description-short": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.", "x-f5xc-description-medium": "Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration. Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/connectivity/node API returns the time-series data for the site specified in the request.", "x-f5xc-description-medium": "Response for graph/connectivity/node API returns the time-series data for the site specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityNodeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityRequest": { "type": "object", "description": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data\nfor the tenant's CEs and the connected REs.", "title": "Connectivity Graph Request", "x-displayname": "Connectivity Graph Request.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.Request", "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": "2019-09-24T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-24T12:30:11.733Z", "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": { "allOf": [ { "$ref": "#/components/schemas/connectivityFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "group_by": { "type": "array", "description": "Aggregate data by site.\n\nOptional: If not specified, then the data is aggregated/grouped by site.", "title": "group_by", "items": { "$ref": "#/components/schemas/connectivityIdField" }, "x-displayname": "Group By", "x-f5xc-description-short": "Aggregate data by site. Optional: If not specified, then the data is aggregated/grouped by site.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "label_filter": { "type": "array", "description": "List of label filter expressions of the form \"label key\" QueryOp \"value\".\nResponse will only contain data that matches all the conditions specified in the label_filter.\n\nOptional: If not specified, connectivity data for all sites will be returned in the response.", "title": "label_filter", "items": { "$ref": "#/components/schemas/connectivityLabelFilter" }, "x-displayname": "Label Filter.", "x-f5xc-description-short": "List of label filter expressions of the form \"label key\" QueryOp \"value\".", "x-f5xc-description-medium": "List of label filter expressions of the form \"label key\" QueryOp \"value\". Response will only contain data that matches all the conditions specified in the label_filter. Optional: If not specified, connectivity data for all sites will be returned in the response.", "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: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to -10m.", "title": "start_time", "x-displayname": "Start Time.", "x-ves-example": "2019-09-23T12:30:11.733Z.", "x-ves-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "x-f5xc-example": "2019-09-23T12:30:11.733Z", "x-validation-rules": { "ves.io.schema.rules.string.query_time": "true" }, "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: unix_timestamp|RFC 3339 Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.", "x-f5xc-description-medium": "Graph/connectivity API is used to GET the reachability, throughput and other monitoring data for the tenant's CEs and the connected REs.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "connectivityResponse": { "type": "object", "description": "Response for graph/connectivity API contains list of nodes and edges.\nEach node contains connectivity data for a site and each edge contains the\nconnectivity data between the sites.", "title": "Connectivity Graph Response", "x-displayname": "Connectivity Graph Response.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.Response", "properties": { "edges": { "type": "array", "description": "Connectivity data between the the Customer sites and the Regional sites.", "title": "Edges", "items": { "$ref": "#/components/schemas/connectivityEdgeData" }, "x-displayname": "Edges", "x-f5xc-description-short": "Connectivity data between the the Customer sites and the Regional sites.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nodes": { "type": "array", "description": "Connectivity data for list of sites owned by a tenant.", "title": "Nodes", "items": { "$ref": "#/components/schemas/connectivityNodeData" }, "x-displayname": "Nodes", "x-f5xc-description-short": "Connectivity data for list of sites owned by a tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for graph/connectivity API contains list of nodes and edges.", "x-f5xc-description-medium": "Response for graph/connectivity API contains list of nodes and edges. Each node contains connectivity data for a site and each edge contains the connectivity data between the sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for connectivityResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphHealthscoreData": { "type": "object", "description": "Contains the list of healthscores requested by the user.", "title": "Healthscore Data", "x-displayname": "Healthscore Data.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreData", "properties": { "data": { "type": "array", "description": "List of healthscores specified in the request.", "title": "Data", "items": { "$ref": "#/components/schemas/graphHealthscoreTypeData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of healthscores specified in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains the list of healthscores requested by the user.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphHealthscoreSelector": { "type": "object", "description": "Healthscore Selector is used to specify the healthscore types to be returned in the response.", "title": "Healthscore Selector", "x-displayname": "Healthscore Selector.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreSelector", "properties": { "types": { "type": "array", "description": "Healthscore types to be returned in the response.", "title": "Types", "items": { "$ref": "#/components/schemas/graphHealthscoreType" }, "x-displayname": "Types", "x-f5xc-description-short": "Healthscore types to be returned in the response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Healthscore Selector is used to specify the healthscore types to be returned in the response.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphHealthscoreType": { "type": "string", "description": "Healthscore for a site or service calculated based on SLAs and KPIs for the application\n\nHealthscore not requested\nx-unit: \"percentage\"\nConnectivity Healthscore\nx-unit: \"percentage\"\nPerformance Healthscore\nx-unit: \"percentage\"\nSecurity Healthscore\nx-unit: \"percentage\"\nReliability Healthscore\nx-unit: \"percentage\"\nOverall Healthscore.", "title": "Healthscore Type", "enum": [ "HEALTHSCORE_NONE", "HEALTHSCORE_CONNECTIVITY", "HEALTHSCORE_PERFORMANCE", "HEALTHSCORE_SECURITY", "HEALTHSCORE_RELIABILITY", "HEALTHSCORE_OVERALL" ], "default": "HEALTHSCORE_NONE", "x-displayname": "Healthscore Type.", "x-ves-proto-enum": "ves.io.schema.graph.HealthscoreType", "x-f5xc-description-short": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\"...", "x-f5xc-description-medium": "Healthscore for a site or service calculated based on SLAs and KPIs for the application Healthscore not requested x-unit: \"percentage\" Connectivity Healthscore x-unit: \"percentage\" Performance Healthscore x-unit: \"percentage\" Security Healthscore x-unit: \"percentage\" Reliability Healthscore...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HEALTHSCORE_NONE\"", "example_yaml": "HEALTHSCORE_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphHealthscoreTypeData": { "type": "object", "description": "HealthScoreTypeData contains healthscore type and the corresponding value.", "title": "Healthscore Type Data", "x-displayname": "Healthscore Type Data.", "x-ves-proto-message": "ves.io.schema.graph.HealthscoreTypeData", "properties": { "reason": { "type": "string", "description": "A human readable string explaining the reason in case of bad healthscore.", "title": "Reason", "x-displayname": "Reason", "x-ves-example": "Only one healthy RE connected.", "x-f5xc-example": "Only one healthy RE connected", "x-f5xc-description-short": "Human readable string explaining the reason in case of bad healthscore.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/graphHealthscoreType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "array", "description": "Healthscore value.", "title": "Value", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "HealthScoreTypeData contains healthscore type and the corresponding value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphHealthscoreTypeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphMetricFeatureData": { "type": "object", "description": "Contains metric values for timeseries features specified in the request.", "title": "Metric Feature Data", "x-displayname": "Metric Feature Data.", "x-ves-proto-message": "ves.io.schema.graph.MetricFeatureData", "properties": { "anomaly": { "type": "array", "description": "Number of anomalies for the given time range.", "title": "Anomaly", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Anomaly", "x-f5xc-description-short": "Number of anomalies for the given time range.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "confidence_lower_bound": { "type": "array", "description": "Lower Bound of the metric value.", "title": "Confidence Lower Bound", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Confidence Lower Bound.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "confidence_upper_bound": { "type": "array", "description": "Upper Bound of the metric value.", "title": "Confidence Upper Bound", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Confidence Upper Bound.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "healthscore": { "type": "array", "description": "Healscore of the metric calculated based on the number of anomalies\nand the value of the anomalies for the time range.", "title": "Healthscore", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Healthscore.", "x-f5xc-description-short": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.", "x-f5xc-description-medium": "Healscore of the metric calculated based on the number of anomalies and the value of the anomalies for the time range.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "raw": { "type": "array", "description": "List of metric values for a given metric type.", "title": "Raw", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Raw", "x-f5xc-description-short": "List of metric values for a given metric type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend": { "type": "array", "description": "Indicates the metric trend.", "title": "Trend", "items": { "$ref": "#/components/schemas/schemagraphMetricValue" }, "x-displayname": "Trend", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains metric values for timeseries features specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphMetricFeatureData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphQueryOp": { "type": "string", "description": "Match operators supported on a label\n\nIndicates that the field is not set\nSelect timeseries whose label value exactly matches the specified string\nSelect timeseries whose label value does not match the specified string.", "title": "Label Operator", "enum": [ "NOP", "EQ", "NEQ" ], "default": "NOP", "x-displayname": "Label Operator.", "x-ves-proto-enum": "ves.io.schema.graph.QueryOp", "x-f5xc-description-short": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string...", "x-f5xc-description-medium": "Match operators supported on a label Indicates that the field is not set Select timeseries whose label value exactly matches the specified string Select timeseries whose label value does not match the specified string.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphQueryOp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NOP\"", "example_yaml": "NOP\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphconnectivityEdgeMetricData": { "type": "object", "description": "EdgeMetricData contains the metric type and the corresponding metric value.", "title": "Edge Metric Data", "x-displayname": "Edge Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeMetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/connectivityEdgeMetricType" } ], "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 } }, "value": { "allOf": [ { "$ref": "#/components/schemas/graphMetricFeatureData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "EdgeMetricData contains the metric type and the corresponding metric value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphconnectivityEdgeMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphconnectivityEdgeMetricSelector": { "type": "object", "description": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.", "title": "Edge Metric Selector", "x-displayname": "Edge Metric Selector.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.EdgeMetricSelector", "properties": { "features": { "type": "array", "description": "Specify list of timeseries features that should be returned for each metric type\nin the request.", "title": "Features", "items": { "$ref": "#/components/schemas/timeseriesTimeseriesFeature" }, "x-displayname": "Features", "x-f5xc-example": "True", "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "types": { "type": "array", "description": "Specify list of metrics that should be returned for each edge in the connectivity graph.", "title": "Types", "items": { "$ref": "#/components/schemas/connectivityEdgeMetricType" }, "x-displayname": "Types", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Specify list of metrics that should be returned for each edge in the connectivity graph.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeMetricSelector is used to select the metrics that should be returned for an edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphconnectivityEdgeMetricSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphconnectivityLabel": { "type": "string", "description": "Metrics used to construct the connectivity graph are tagged with these labels and therefore\nthe metrics can be sliced and diced based on one or more labels.\n\nIndicates the field not being set\nIdentifies a site (CE or RE)\nIdentifies a network (INSIDE or OUTSIDE or segment)\nIdentifies a interface (tunnel_ipsec or tunnel_ssl or segment_interface or tunnel_tgw_Gre)\nIdentifies a connection (TGW_CONNECTIVITY)", "title": "Label", "enum": [ "LABEL_NONE", "LABEL_SITE", "LABEL_NETWORK_TYPE", "LABEL_INTERFACE_TYPE", "LABEL_CONNECTIVITY_TYPE" ], "default": "LABEL_NONE", "x-displayname": "Label", "x-ves-proto-enum": "ves.io.schema.graph.connectivity.Label", "x-f5xc-description-short": "Metrics used to construct the connectivity graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or...", "x-f5xc-description-medium": "Metrics used to construct the connectivity graph are tagged with these labels and therefore the metrics can be sliced and diced based on one or more labels. Indicates the field not being set Identifies a site (CE or RE) Identifies a network (INSIDE or OUTSIDE or segment) Identifies a interface...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphconnectivityLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LABEL_NONE\"", "example_yaml": "LABEL_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphconnectivityNodeMetricData": { "type": "object", "description": "NodeMetricData contains metric type and the corresponding value for a node.", "title": "Node Metric Data", "x-displayname": "Node Metric Data.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeMetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/connectivityNodeMetricType" } ], "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 } }, "value": { "allOf": [ { "$ref": "#/components/schemas/graphMetricFeatureData" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "NodeMetricData contains metric type and the corresponding value for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphconnectivityNodeMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "graphconnectivityNodeMetricSelector": { "type": "object", "description": "NodeMetricSelector is used to select the metrics that should be returned for a node.", "title": "Node Metric Selector", "x-displayname": "Node Metric Selector.", "x-ves-proto-message": "ves.io.schema.graph.connectivity.NodeMetricSelector", "properties": { "features": { "type": "array", "description": "Specify list of timeseries features that should be returned for each metric type\nin the request.", "title": "Features", "items": { "$ref": "#/components/schemas/timeseriesTimeseriesFeature" }, "x-displayname": "Features", "x-f5xc-example": "True", "x-f5xc-description-short": "Specify list of timeseries features that should be returned for each metric type in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "instances": { "type": "array", "description": "Specify list of metrics.", "title": "Instance Metrics", "items": { "$ref": "#/components/schemas/connectivityNodeInstanceMetricType" }, "x-displayname": "Instance Metrics.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interfaces": { "type": "array", "description": "Specify list of metrics that should be returned for each physical interface in a site.", "title": "Interface Metrics", "items": { "$ref": "#/components/schemas/connectivityNodeInterfaceMetricType" }, "x-displayname": "Interface Metrics.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Specify list of metrics that should be returned for each physical interface in a site.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "types": { "type": "array", "description": "Specify list of metrics that should be returned for each node in the connectivity graph.", "title": "Node Metrics", "items": { "$ref": "#/components/schemas/connectivityNodeMetricType" }, "x-displayname": "Node Metrics.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Specify list of metrics that should be returned for each node in the connectivity graph.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "NodeMetricSelector is used to select the metrics that should be returned for a node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for graphconnectivityNodeMetricSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaTrendSentiment": { "type": "string", "description": "Trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.", "title": "Trend Sentiment", "enum": [ "TREND_SENTIMENT_NONE", "TREND_SENTIMENT_POSITIVE", "TREND_SENTIMENT_NEGATIVE" ], "default": "TREND_SENTIMENT_NONE", "x-displayname": "Trend Sentiment.", "x-ves-proto-enum": "ves.io.schema.TrendSentiment", "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendSentiment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TREND_SENTIMENT_NONE\"", "example_yaml": "TREND_SENTIMENT_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaTrendValue": { "type": "object", "description": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "title": "Trend Value", "x-displayname": "Trend Value.", "x-ves-proto-message": "ves.io.schema.TrendValue", "properties": { "description": { "type": "string", "description": "Description of the method used to calculate trend.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.", "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval", "x-f5xc-description-short": "Description of the method used to calculate trend.", "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" }, "previous_value": { "type": "string", "description": "Configuration parameter for previous value", "title": "Previous Value", "x-displayname": "Previous Value.", "x-ves-example": "200.00", "x-f5xc-example": "200.00", "x-f5xc-description-short": "Configuration parameter for previous value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendSentiment" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "-15", "x-f5xc-example": "-15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaUnitType": { "type": "string", "description": "UnitType is enumeration of units for scalar fields.", "title": "UnitType", "enum": [ "UNIT_MILLISECONDS", "UNIT_SECONDS", "UNIT_MINUTES", "UNIT_HOURS", "UNIT_DAYS", "UNIT_BYTES", "UNIT_KBYTES", "UNIT_MBYTES", "UNIT_GBYTES", "UNIT_TBYTES", "UNIT_KIBIBYTES", "UNIT_MIBIBYTES", "UNIT_GIBIBYTES", "UNIT_TEBIBYTES", "UNIT_BITS_PER_SECOND", "UNIT_BYTES_PER_SECOND", "UNIT_KBITS_PER_SECOND", "UNIT_KBYTES_PER_SECOND", "UNIT_MBITS_PER_SECOND", "UNIT_MBYTES_PER_SECOND", "UNIT_CONNECTIONS_PER_SECOND", "UNIT_ERRORS_PER_SECOND", "UNIT_PACKETS_PER_SECOND", "UNIT_REQUESTS_PER_SECOND", "UNIT_PACKETS", "UNIT_PERCENTAGE", "UNIT_COUNT" ], "default": "UNIT_MILLISECONDS", "x-displayname": "Unit", "x-ves-proto-enum": "ves.io.schema.UnitType", "x-f5xc-description-short": "UnitType is enumeration of units for scalar fields.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaUnitType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNIT_MILLISECONDS\"", "example_yaml": "UNIT_MILLISECONDS\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemagraphMetricValue": { "type": "object", "description": "Each metric value consists of a timestamp and a value.\nTimestamp in the Metric Value is based on the start_time, end_time and step in the request.\nValid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ... Tn=tn-1+step, where tn <= end_time.\nResponse may not contain values for all timestamps between start_time and end_time.", "title": "Metric Value", "x-displayname": "Metric Value.", "x-ves-proto-message": "ves.io.schema.graph.MetricValue", "properties": { "timestamp": { "type": "number", "description": "UTC timestamp in seconds.", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1569528992.", "x-f5xc-example": "1569528992", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend_value": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendValue" } ], "x-f5xc-description-short": "Configuration parameter for trend value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Metric value.", "title": "Value", "x-displayname": "Value", "x-ves-example": "10.6", "x-f5xc-example": "10.6", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request.", "x-f5xc-description-medium": "Each metric value consists of a timestamp and a value. Timestamp in the Metric Value is based on the start_time, end_time and step in the request. Valid values for timestamp are t1=start_time, t2=t1+step, t3=t2+step, ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemagraphMetricValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "siteSiteType": { "type": "string", "description": "Site Type which can either RE or CE\n\nInvalid type of site\nRegional Edge site\nCustomer Edge site.", "title": "SiteType", "enum": [ "INVALID", "REGIONAL_EDGE", "CUSTOMER_EDGE", "NGINX_ONE" ], "default": "INVALID", "x-displayname": "Site Type", "x-ves-proto-enum": "ves.io.schema.site.SiteType", "x-f5xc-description-short": "Site Type which can either RE or CE Invalid type of site Regional Edge site Customer Edge site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for siteSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID\"", "example_yaml": "INVALID\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "timeseriesTimeseriesFeature": { "type": "string", "description": "Various Timeseries Features that can be enabled\n\nDo not enable any feature\nEnable calculating confidence interval, upper and lower bound time series where metric is expected to vary.\nDetect anomalies and generate alarm when metric goes out of confidence interval\ndetect trend of the metric\nIndicate a score between 0 to 100 which indicates if the metric is healthy.", "title": "Timeseries", "enum": [ "TIMESERIES_FEATURE_NONE", "CONFIDENCE_INTERVAL", "ANOMALY_DETECTION", "TREND", "HEALTHSCORE" ], "default": "TIMESERIES_FEATURE_NONE", "x-displayname": "Timeseries.", "x-ves-proto-enum": "ves.io.schema.timeseries.TimeseriesFeature", "x-f5xc-description-short": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time...", "x-f5xc-description-medium": "Various Timeseries Features that can be enabled Do not enable any feature Enable calculating confidence interval, upper and lower bound time series where metric is expected to vary. Detect anomalies and generate alarm when metric goes out of confidence interval detect trend of the metric...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for timeseriesTimeseriesFeature", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TIMESERIES_FEATURE_NONE\"", "example_yaml": "TIMESERIES_FEATURE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "discovered_serviceAwsPortInfo": { "type": "object", "description": "Information about a discovered port of a service.", "title": "AWS Port Information", "x-displayname": "Port Information.", "x-ves-proto-message": "ves.io.schema.discovered_service.AwsPortInfo", "properties": { "port": { "type": "integer", "description": "Port number on which the service is exposed.", "title": "Port", "format": "int64", "x-displayname": "Port Number.", "x-ves-example": "8080", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Port number on which the service is exposed.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "protocol": { "type": "string", "description": "Protocol for the exposed service.", "title": "Protocol", "x-displayname": "Protocol", "x-ves-example": "TCP", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"TCP\\\",\\\"UDP\\\"]" }, "x-f5xc-example": "TCP", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.in": "[\\\"TCP\\\",\\\"UDP\\\"]" }, "maxLength": 1024, "enum": [ "TCP", "UDP" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a discovered port of a service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceAwsPortInfo", "required_fields": [ "port", "protocol" ], "mutually_exclusive_groups": [], "example_json": "{\n \"port\": 1,\n \"protocol\": \"TCP\"\n}", "example_yaml": "port: 1\nprotocol: TCP" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceAwsService": { "type": "object", "description": "Service detailed discovered from AWS.", "title": "AWS Service", "x-displayname": "AWS Service.", "x-ves-proto-message": "ves.io.schema.discovered_service.AwsService", "properties": { "discovery_cloud_object": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for discovery cloud object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "discovery_cloud_object", "gated_by": null, "required": false, "cardinality": "single" } ] }, "endpoint_address": { "type": "string", "description": "Endpoint address of discovered service, may be DNS name or IP address.", "title": "Endpoint Address", "x-displayname": "Endpoint Address.", "x-ves-example": "example-service.example.amazonaws.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-service.example.amazonaws.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Endpoint address of discovered service, may be DNS name or IP address.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of discovered service.", "title": "Service Name", "x-displayname": "Service", "x-ves-example": "Example-service.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-service", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ports": { "type": "array", "description": "Ports of discovered service.", "title": "Ports", "items": { "$ref": "#/components/schemas/discovered_serviceAwsPortInfo" }, "x-displayname": "Ports", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "region": { "type": "string", "description": "Region of discovered service.", "title": "Region", "x-displayname": "Region", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "us-west-2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "subnet_id": { "type": "string", "description": "Subnet ID of discovered service.", "title": "Subnet ID", "x-displayname": "Subnet ID", "x-ves-example": "Subnet-01234567890abcdef.", "x-f5xc-example": "subnet-01234567890abcdef", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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" }, "type": { "allOf": [ { "$ref": "#/components/schemas/discovery_cloudAwsServiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "ID of VPC to discover from.", "title": "VPC ID", "maxLength": 64, "x-displayname": "VPC ID", "x-ves-example": "VPC-12345678901234567.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "vpc-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(vpc-)([a-z0-9]{8}|[a-z0-9]{17})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceAwsService", "required_fields": [ "endpoint_address", "name", "region", "vpc_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"endpoint_address\": \"example-service.example.amazonaws.com\",\n \"name\": \"example-service\",\n \"region\": \"us-west-2\",\n \"vpc_id\": \"vpc-12345678901234567\"\n}", "example_yaml": "endpoint_address: example-service.example.amazonaws.com\nname: example-service\nregion: us-west-2\nvpc_id: vpc-12345678901234567" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceConsulService": { "type": "object", "description": "Service details discovered from Consul.", "title": "Consul Service", "x-displayname": "Consul Service.", "x-ves-proto-message": "ves.io.schema.discovered_service.ConsulService", "properties": { "discovery_object": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for discovery object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "discovery", "field_path": "discovery_object", "gated_by": null, "required": false, "cardinality": "single" } ] }, "pods": { "type": "array", "description": "List of pod-name to IP address mappings for the service.", "title": "Pod List", "maxItems": 50, "items": { "$ref": "#/components/schemas/discoveryPodInfoType" }, "x-displayname": "PODs", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-f5xc-description-short": "List of pod-name to IP address mappings for the service.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 50, "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 } }, "ports": { "type": "array", "description": "List of ports along with protocol on which the service is exposed.", "title": "Port List", "maxItems": 50, "items": { "$ref": "#/components/schemas/discoveryPortInfoType" }, "x-displayname": "Ports", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-f5xc-description-short": "List of ports along with protocol on which the service is exposed.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 50, "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 } }, "service_name": { "type": "string", "description": "Name of the discovered service.", "title": "Service Name", "x-displayname": "Service", "x-ves-example": "Example-service.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-service", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceConsulService", "required_fields": [ "service_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"service_name\": \"example-service\"\n}", "example_yaml": "service_name: example-service" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceCreateHTTPLoadBalancerRequest": { "type": "object", "description": "CreateHTTPLoadBalancerRequest.", "title": "CreateHTTPLoadBalancerRequest", "x-displayname": "CreateHTTPLoadBalancerRequest.", "x-ves-proto-message": "ves.io.schema.discovered_service.CreateHTTPLoadBalancerRequest", "properties": { "http_lb_request": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceHTTPLBRequest" } ], "x-f5xc-description-short": "Configuration parameter for http lb request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceCreateHTTPLoadBalancerRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceCreateHTTPLoadBalancerResponse": { "type": "object", "description": "CreateHTTPLoadBalancerResponse.", "title": "CreateHTTPLoadBalancerResponse", "x-displayname": "CreateHTTPLoadBalancerResponse.", "x-ves-proto-message": "ves.io.schema.discovered_service.CreateHTTPLoadBalancerResponse", "properties": { "http_loadbalancer": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for http loadbalancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "http_load_balancer", "field_path": "http_loadbalancer", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceCreateHTTPLoadBalancerResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceCreateTCPLoadBalancerRequest": { "type": "object", "description": "CreateTCPLoadBalancerRequest.", "title": "CreateTCPLoadBalancerRequest", "x-displayname": "CreateTCPLoadBalancerRequest.", "x-ves-proto-message": "ves.io.schema.discovered_service.CreateTCPLoadBalancerRequest", "properties": { "name": { "type": "string", "description": "Identifies the discovered service name.", "title": "Service Name", "x-displayname": "Service Name.", "x-ves-example": "Vs1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "vs1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the discovered service for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Shared", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "shared", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace of the discovered service for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tcp_lb_request": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceTCPLBRequest" } ], "x-f5xc-description-short": "Configuration parameter for tcp lb request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceCreateTCPLoadBalancerRequest", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"vs1\",\n \"namespace\": \"shared\"\n}", "example_yaml": "name: vs1\nnamespace: shared" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceCreateTCPLoadBalancerResponse": { "type": "object", "description": "CreateTCPLoadBalancerResponse.", "title": "CreateTCPLoadBalancerResponse", "x-displayname": "CreateTCPLoadBalancerResponse.", "x-ves-proto-message": "ves.io.schema.discovered_service.CreateTCPLoadBalancerResponse", "properties": { "tcp_loadbalancer": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for tcp loadbalancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "tcp_load_balancer", "field_path": "tcp_loadbalancer", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceCreateTCPLoadBalancerResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceDisableVisibilityRequest": { "type": "object", "description": "Disable visibility on the discovered service.", "title": "DisableVisibilityRequest", "x-displayname": "Disable visibility on the discovered service.", "x-ves-proto-message": "ves.io.schema.discovered_service.DisableVisibilityRequest", "properties": { "name": { "type": "string", "description": "Identifies the discovered service name.", "title": "Service Name", "x-displayname": "Service Name.", "x-ves-example": "Vs1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "vs1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the discovered service for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Shared", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "shared", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace of the discovered service for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Disable visibility on the discovered service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceDisableVisibilityRequest", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"vs1\",\n \"namespace\": \"shared\"\n}", "example_yaml": "name: vs1\nnamespace: shared" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceDisableVisibilityResponse": { "type": "object", "description": "Response to the Disable Visibility request.", "title": "DisableVisibilityResponse", "x-displayname": "Disable Visibility Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.DisableVisibilityResponse", "x-f5xc-description-short": "Response to the Disable Visibility request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceDisableVisibilityResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceDiscoveredServiceHealthStatusResponse": { "type": "object", "description": "Response for Discovered Service Health Status Request.", "title": "DiscoveredServiceHealthStatusResponse", "x-displayname": "Discovered Service Health Status Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.DiscoveredServiceHealthStatusResponse", "properties": { "status": { "type": "array", "description": "Health Status of Discovered Service.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "virtual_server_pool_members_health": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceVirtualServerPoolMemberHealth" } ], "x-f5xc-description-short": "Configuration parameter for virtual server pool members health.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for Discovered Service Health Status Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceDiscoveredServiceHealthStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceEnableVisibilityRequest": { "type": "object", "description": "Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc.", "title": "EnableVisibilityRequest", "x-displayname": "Enable visibility.", "x-ves-proto-message": "ves.io.schema.discovered_service.EnableVisibilityRequest", "properties": { "name": { "type": "string", "description": "Identifies the discovered service name.", "title": "Service Name", "x-displayname": "Service Name.", "x-ves-example": "Vs1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "vs1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace of the discovered service for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "Shared", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "shared", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Namespace of the discovered service for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Enable visibility of the discovered service in all workspaces like WAAP, App Connect, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceEnableVisibilityRequest", "required_fields": [ "name", "namespace" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"vs1\",\n \"namespace\": \"shared\"\n}", "example_yaml": "name: vs1\nnamespace: shared" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceEnableVisibilityResponse": { "type": "object", "description": "Response to the Enable Visibility request.", "title": "EnableVisibilityResponse", "x-displayname": "Enable Visibility Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.EnableVisibilityResponse", "properties": { "virtual_host_ref": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_host", "field_path": "virtual_host_ref", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Response to the Enable Visibility request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceEnableVisibilityResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read discovered_service", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceHTTPLBRequest": { "type": "object", "description": "HTTP LB Request Parameters.", "title": "HTTP LB Request", "x-displayname": "HTTP(s) LB Request.", "x-ves-displayorder": "1,2,9,6,13", "x-ves-oneof-field-advertise_choice": "[]", "x-ves-oneof-field-caching": "[\"default_caching_disable\",\"default_caching_enable\"]", "x-ves-oneof-field-loadbalancer_type": "[\"http\",\"https\",\"https_auto_cert\"]", "x-ves-oneof-field-server_validation_choice": "[\"skip_server_verification\",\"trusted_ca\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.HTTPLBRequest", "properties": { "default_caching_disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default caching disable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_caching_enable" ] }, "default_caching_enable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default caching enable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_caching_disable" ] }, "domain": { "type": "string", "description": "Domain name for routing and identification", "title": "Domain", "x-displayname": "Domain", "x-ves-example": "www.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.vh_domain": "true" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.vh_domain": "true" }, "x-f5xc-description-short": "Domain name for routing and identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "fqdn", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "http": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceProxyTypeHttp" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "https", "https_auto_cert" ] }, "https": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceProxyTypeHttps" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http", "https_auto_cert" ] }, "https_auto_cert": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for https auto cert.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http", "https" ] }, "name": { "type": "string", "description": "The configuration object will be created with name. It has to be unique within the namespace.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The configuration object will be created with name. It has to be unique within the namespace.", "x-f5xc-description-medium": "The configuration object will be created with name. It has to be unique within the namespace. The value of name has to follow DNS-1035 format.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "skip_server_verification": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "trusted_ca" ] }, "trusted_ca": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "skip_server_verification" ], "x-f5xc-references": [ { "resource_kind": "certificate", "field_path": "trusted_ca", "gated_by": { "choice": "server_validation_choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceHTTPLBRequest", "required_fields": [ "domain", "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"www.foo.com\",\n \"name\": \"example-corp-web\"\n}", "example_yaml": "domain: www.foo.com\nname: example-corp-web" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceK8sService": { "type": "object", "description": "Service details discovered from K8s.", "title": "K8s Service", "x-displayname": "K8s Service.", "x-ves-proto-message": "ves.io.schema.discovered_service.K8sService", "properties": { "discovery_object": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for discovery object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "discovery", "field_path": "discovery_object", "gated_by": null, "required": false, "cardinality": "single" } ] }, "pods": { "type": "array", "description": "List of pod-name to IP address mappings for the service.", "title": "Pod List", "maxItems": 50, "items": { "$ref": "#/components/schemas/discoveryPodInfoType" }, "x-displayname": "PODs", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-f5xc-description-short": "List of pod-name to IP address mappings for the service.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 50, "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 } }, "ports": { "type": "array", "description": "List of ports along with protocol on which the service is exposed.", "title": "Port List", "maxItems": 50, "items": { "$ref": "#/components/schemas/discoveryPortInfoType" }, "x-displayname": "Ports", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "50" }, "x-f5xc-description-short": "List of ports along with protocol on which the service is exposed.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 50, "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 } }, "service_name": { "type": "string", "description": "Name of the discovered service.", "title": "Service Name", "x-displayname": "Service", "x-ves-example": "Example-service.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-service", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceK8sService", "required_fields": [ "service_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"service_name\": \"example-service\"\n}", "example_yaml": "service_name: example-service" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of discovered_service", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/discovered_serviceListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceListResponseItem": { "type": "object", "description": "By default a summary of discovered_service is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of discovered_service", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.discovered_service.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this discovered_service.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this discovered_service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this discovered_service.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this discovered_service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates discovered_service is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates discovered_service is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this discovered_service.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this discovered_service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this discovered_service.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this discovered_service.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this discovered_service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of discovered_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of discovered_service is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceListServicesResponse": { "type": "object", "description": "This is the output message of List for specific service type.", "title": "ListServicesResponse is the collection of discovered service", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.discovered_service.ListServicesResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/discovered_serviceListServicesResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Output message of List for specific service type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceListServicesResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceListServicesResponseItem": { "type": "object", "description": "By default a summary of discovered services is returned in 'List'. By setting\n'report_fields' in the ListServicesRequest more details of each item can be got.", "title": "ListServicesResponseItem is an individual item in a collection of discovered services of specific type", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.discovered_service.ListServicesResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this discovered service.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this discovered service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this discovered service.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this discovered service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates discovered service is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates discovered service is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this discovered service.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this discovered service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this discovered service.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/discovered_serviceStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this discovered service.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "x-f5xc-description-short": "The unique uid of this discovered service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of discovered services is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of discovered services is returned in 'List'. By setting 'report_fields' in the ListServicesRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceListServicesResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceNginxOneDiscoveredServer": { "type": "object", "description": "Discovered Servers Info.", "title": "NginxOneDiscoveredServer", "x-displayname": "NGINX One Discovered Server.", "x-ves-proto-message": "ves.io.schema.discovered_service.NginxOneDiscoveredServer", "properties": { "domains": { "type": "array", "description": "Domains configured on the Server.", "title": "Domains", "maxItems": 32, "items": { "type": "string" }, "x-displayname": "Domains", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 32, "minItems": 1, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_one_object_id": { "type": "string", "description": "ID of the NGINX Instance or Config Sync Group.", "title": "NGINX Instance or Config Sync Group ID", "maxLength": 256, "x-displayname": "Instance or Config Sync Group Object ID.", "x-ves-example": "Inst_awuzd-6yRb2zbUPRxLa0SQ.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "inst_awuzd-6yRb2zbUPRxLa0SQ", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-description-short": "ID of the NGINX Instance or Config Sync Group.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" }, "nginx_one_object_name": { "type": "string", "description": "Hostname value set for Instance or Name for a Config Sync Group\nin NGINX One.", "title": "NGINX Instance or Config Sync Group Name", "x-displayname": "Instance or Config Sync Group Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname value set for Instance or Name for a Config Sync Group in NGINX One.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "nginx_service_discovery_ref": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for nginx service discovery ref.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "nginx_service_discovery_ref", "gated_by": null, "required": false, "cardinality": "single" } ] }, "port": { "type": "integer", "description": "Port number on which the Server is exposed.", "title": "Port", "format": "int64", "x-displayname": "Port", "x-ves-example": "8080", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Port number on which the Server is exposed.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "server_block": { "type": "string", "description": "Server Block Name.", "title": "Server Block Name", "maxLength": 256, "x-displayname": "Server Block Name.", "x-ves-example": "Server-block-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-example": "server-block-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "256", "ves.io.schema.rules.string.not_empty": "true" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "byteLength": { "max": 256 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceNginxOneDiscoveredServer", "required_fields": [ "nginx_one_object_id", "port", "server_block" ], "mutually_exclusive_groups": [], "example_json": "{\n \"nginx_one_object_id\": \"inst_awuzd-6yRb2zbUPRxLa0SQ\",\n \"port\": 1,\n \"server_block\": \"server-block-1\"\n}", "example_yaml": "nginx_one_object_id: inst_awuzd-6yRb2zbUPRxLa0SQ\nport: 1\nserver_block: server-block-1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceProxyTypeHttp": { "type": "object", "description": "Choice for selecting HTTP proxy.", "title": "HTTP Choice", "x-displayname": "HTTP", "x-ves-oneof-field-advertise_choice": "[\"advertise_on_public_default_vip\",\"site\",\"virtual_site\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.ProxyTypeHttp", "properties": { "advertise_on_public_default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site", "virtual_site" ] }, "site": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceWhereSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public_default_vip", "virtual_site" ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceWhereVirtualSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public_default_vip", "site" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceProxyTypeHttp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceProxyTypeHttps": { "type": "object", "description": "Choice for selecting HTTP proxy with bring your own certificate.", "title": "BYOC HTTPS Choice", "x-displayname": "BYOC HTTPS Choice.", "x-ves-oneof-field-advertise_choice": "[\"advertise_on_public_default_vip\",\"site\",\"virtual_site\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.ProxyTypeHttps", "properties": { "advertise_on_public_default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site", "virtual_site" ] }, "certificates": { "type": "array", "description": "Select a certificate.", "title": "TLS Certificate", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "TLS Certificate.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "site": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceWhereSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public_default_vip", "virtual_site" ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemadiscovered_serviceWhereVirtualSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public_default_vip", "site" ] } }, "x-f5xc-description-short": "Choice for selecting HTTP proxy with bring your own certificate.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceProxyTypeHttps", "required_fields": [ "certificates" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificates\": [\n {}\n ]\n}", "example_yaml": "certificates:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Discovered Services Status Object", "x-displayname": "Discovered Services Status Object.", "x-ves-proto-message": "ves.io.schema.discovered_service.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceSuggestValuesReq": { "type": "object", "description": "Request body of SuggestValues request.", "title": "SuggestValuesReq", "x-displayname": "Request for SuggestValues.", "x-ves-proto-message": "ves.io.schema.discovered_service.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 discovered_serviceSuggestValuesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceTCPLBRequest": { "type": "object", "description": "TCP LB Request.", "title": "TCP LB Request", "x-displayname": "TCP LB Request.", "x-ves-displayorder": "1,2,3,6,9", "x-ves-oneof-field-advertise_choice": "[\"advertise_custom\",\"advertise_on_public_default_vip\"]", "x-ves-oneof-field-port_choice": "[\"listen_port\",\"port_ranges\"]", "x-ves-oneof-field-sni_default_lb_choice": "[\"no_sni\",\"sni\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.TCPLBRequest", "properties": { "advertise_custom": { "allOf": [ { "$ref": "#/components/schemas/viewsAdvertiseCustom__ves_io_schema_discovered_service" } ], "x-f5xc-description-short": "Configuration parameter for advertise custom.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public_default_vip" ] }, "advertise_on_public_default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_custom" ] }, "domain": { "type": "string", "description": "Domain name for routing and identification", "title": "Domain", "x-displayname": "Domain", "x-ves-example": "www.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.vh_domain": "true" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.vh_domain": "true" }, "x-f5xc-description-short": "Domain name for routing and identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "fqdn", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "listen_port": { "type": "integer", "description": "Exclusive with [port_ranges]\nListen Port for this load balancer.", "title": "Port", "format": "int64", "x-displayname": "Listen Port.", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Exclusive with [port_ranges] Listen Port for this load balancer.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port_ranges" ] }, "name": { "type": "string", "description": "The configuration object will be created with name. It has to be unique within the namespace.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "The configuration object will be created with name. It has to be unique within the namespace.", "x-f5xc-description-medium": "The configuration object will be created with name. It has to be unique within the namespace. The value of name has to follow DNS-1035 format.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "no_sni": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sni" ] }, "port_ranges": { "type": "string", "description": "Exclusive with [listen_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".", "title": "Port_ranges", "minLength": 1, "maxLength": 512, "x-displayname": "Port Ranges.", "x-ves-example": "80,443,8080-8191,9080.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-example": "80,443,8080-8191,9080", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-description-short": "Exclusive with [listen_port] A string containing a comma separated list of port ranges.", "x-f5xc-description-medium": "Exclusive with [listen_port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "listen_port" ] }, "sni": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_sni" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceTCPLBRequest", "required_fields": [ "domain", "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"www.foo.com\",\n \"name\": \"example-corp-web\"\n}", "example_yaml": "domain: www.foo.com\nname: example-corp-web" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceThirdPartyApplicationDiscovery": { "type": "object", "description": "Configure third party log source applications to send logs to your XC environment. Define application names and allowed IP ranges using CIDR notation.\nSee Tech Docs for detailed setup instructions.", "title": "third_party_application", "x-displayname": "Discovery", "x-ves-proto-message": "ves.io.schema.discovered_service.ThirdPartyApplicationDiscovery", "properties": { "discovery_object": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for discovery object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "discovery", "field_path": "discovery_object", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Configure third party log source applications to send logs to your XC environment.", "x-f5xc-description-medium": "Configure third party log source applications to send logs to your XC environment. Define application names and allowed IP ranges using CIDR notation. See Tech Docs for detailed setup instructions.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceThirdPartyApplicationDiscovery", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceVirtualServer": { "type": "object", "description": "Virtual Server discovered from BIG-IP.", "title": "virtual_server", "x-displayname": "Virtual Server.", "x-ves-proto-message": "ves.io.schema.discovered_service.VirtualServer", "properties": { "bigip_version": { "type": "string", "description": "Version of the BIG-IP from where the service was discovered.", "title": "BIG-IP version", "maxLength": 256, "x-displayname": "BIG-IP Version.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Version of the BIG-IP from where the service was discovered.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "cbip_cluster": { "type": "string", "description": "Name of CBIP Cluster.", "title": "CBIP Cluster Name", "maxLength": 256, "x-displayname": "CBIP Cluster Name.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "discovery_object": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for discovery object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "discovery", "field_path": "discovery_object", "gated_by": null, "required": false, "cardinality": "single" } ] }, "enabled_state": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceVirtualServerEnabledState" } ], "x-f5xc-description-short": "Configuration parameter for enabled state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_address": { "type": "string", "description": "IP address of the BIG-IP Virtual Server.", "title": "Virtual Server IP Address", "x-displayname": "Virtual Server IP.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.1", "x-f5xc-description-short": "IP address of the BIG-IP Virtual Server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 7, "pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)\\.?\\b){4}$", "format": "ip", "formatDescription": "IPv4 dotted-decimal notation (e.g., 192.168.1.1)", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "partition": { "type": "string", "description": "Partition of virtual-server.", "title": "partition", "maxLength": 256, "x-displayname": "Partition", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "256" }, "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, "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 } }, "port": { "type": "integer", "description": "Port number on which the virtual-server is exposed.", "title": "Port", "format": "int64", "x-displayname": "Port Number.", "x-ves-example": "8080", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Port number on which the virtual-server is exposed.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "server_name": { "type": "string", "description": "Virtual Server name.", "title": "Server Name", "maxLength": 1024, "x-displayname": "Server Name.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "example-resource", "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 } }, "status": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceVirtualServerStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "sub_path": { "type": "string", "description": "BIG-IP Virtual Server sub path in relation to partition.", "title": "Sub Path", "maxLength": 1024, "x-displayname": "Sub Path", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "BIG-IP Virtual Server sub path in relation to partition.", "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 } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceVirtualServer", "required_fields": [ "bigip_version", "cbip_cluster", "ip_address", "partition", "port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"bigip_version\": \"value\",\n \"cbip_cluster\": \"{\\\"key\\\": \\\"value\\\"}\",\n \"ip_address\": \"192.0.2.1\",\n \"partition\": \"value\",\n \"port\": 1\n}", "example_yaml": "bigip_version: value\ncbip_cluster: '{\"key\": \"value\"}'\nip_address: 192.0.2.1\npartition: value\nport: 1" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceVirtualServerEnabledState": { "type": "string", "description": "Enabled state of the virtual server.\n\n- NONE: NONE\n\nInvalid state.\n- ENABLED: ENABLED\n\nVirtual Server is enabled.\n- DISABLED: DISABLED\n\nVirtual Server is administratively disabled.", "title": "Enabled state of the virtual server", "enum": [ "NONE", "ENABLED", "DISABLED" ], "default": "NONE", "x-displayname": "Virtual Server Enabled State.", "x-ves-proto-enum": "ves.io.schema.discovered_service.VirtualServerEnabledState", "x-f5xc-description-short": "Enabled state of the virtual server. - NONE: NONE Invalid state. - ENABLED: ENABLED Virtual Server is enabled. - DISABLED: DISABLED Virtual Server...", "x-f5xc-description-medium": "Enabled state of the virtual server. - NONE: NONE Invalid state. - ENABLED: ENABLED Virtual Server is enabled. - DISABLED: DISABLED Virtual Server is administratively disabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceVirtualServerEnabledState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NONE\"", "example_yaml": "NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceVirtualServerPoolHealthStatusListResponseItem": { "type": "object", "description": "Pool member health.", "title": "VirtualServerPoolHealthStatusListResponseItem", "x-displayname": "Discovered Service Pool Health Status List Item.", "x-ves-proto-message": "ves.io.schema.discovered_service.VirtualServerPoolHealthStatusListResponseItem", "properties": { "name": { "type": "string", "description": "Name of the Virtual Server's Pool Member.", "title": "Name", "x-displayname": "Pool Member Name.", "x-ves-example": "Vs_pm_1", "x-f5xc-example": "vs_pm_1", "x-f5xc-description-short": "Name of the Virtual Server's Pool Member.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "type": "array", "description": "Health Status of Pool Member.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceVirtualServerPoolHealthStatusListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceVirtualServerPoolMemberHealth": { "type": "object", "description": "Health of each pool member of the virtual server.", "title": "BIG-IP Virtual Server's Pool Member Health", "x-displayname": "Virtual Server's Pool Members Health.", "x-ves-proto-message": "ves.io.schema.discovered_service.VirtualServerPoolMemberHealth", "properties": { "virtual_server_pool_members": { "type": "array", "description": "Collection of Pool member health status.", "title": "BIG-IP Virtual Server's Pool Member Health", "items": { "$ref": "#/components/schemas/discovered_serviceVirtualServerPoolHealthStatusListResponseItem" }, "x-displayname": "Pool Member health.", "x-f5xc-description-short": "Collection of Pool member health status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Health of each pool member of the virtual server.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceVirtualServerPoolMemberHealth", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovered_serviceVirtualServerStatus": { "type": "string", "description": "Availability Status of the virtual server.\n\n- UNSPECIFIED: UNSPECIFIED\n\nInvalid status.\n- AVAILABLE: AVAILABLE\n\nVirtual Server is available and serving traffic.\n- OFFLINE: OFFLINE\n\nVirtual Server is not serving traffic.\n- UNKNOWN: UNKNOWN\n\nVirtual Server availability is unknown. It can indicate that no service checks are enabled on the virtual server.\n- UNAVAILABLE: UNAVAILABLE\n\nVirtual Server is temporarily unavailable maybe due to hitting connection limit.\n- DELETED: DELETED\n\nVirtual Server has been deleted on the BIG-IP but is in use on Distributed Cloud.", "title": "Availability Status of the virtual server", "enum": [ "UNSPECIFIED", "AVAILABLE", "OFFLINE", "UNKNOWN", "UNAVAILABLE", "DELETED" ], "default": "UNSPECIFIED", "x-displayname": "Virtual Server Availability Status.", "x-ves-proto-enum": "ves.io.schema.discovered_service.VirtualServerStatus", "x-f5xc-description-short": "Availability Status of the virtual server. - UNSPECIFIED: UNSPECIFIED Invalid status. - AVAILABLE: AVAILABLE Virtual Server is available and...", "x-f5xc-description-medium": "Availability Status of the virtual server. - UNSPECIFIED: UNSPECIFIED Invalid status. - AVAILABLE: AVAILABLE Virtual Server is available and serving traffic. - OFFLINE: OFFLINE Virtual Server is not serving traffic. - UNKNOWN: UNKNOWN Virtual Server availability is unknown. It can indicate that...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovered_serviceVirtualServerStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNSPECIFIED\"", "example_yaml": "UNSPECIFIED\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discoveryPodInfoType": { "type": "object", "description": "Information about POD providing the service.", "title": "Pod info", "x-displayname": "POD", "x-ves-proto-message": "ves.io.schema.discovery.PodInfoType", "properties": { "ip": { "type": "string", "description": "IP Address of the POD.", "title": "IP Address", "x-displayname": "IP", "x-ves-example": "192.0.2.106.", "x-f5xc-example": "192.0.2.106", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pod_name": { "type": "string", "description": "Name of the Pod.", "title": "POD name", "x-displayname": "Name", "x-ves-example": "Example-pod-nk8wr.", "x-f5xc-example": "example-pod-nk8wr", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about POD providing the service.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discoveryPodInfoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Service discovery is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discoveryPortInfoType": { "type": "object", "description": "Information about port and protocol on which the service is provided.", "title": "Port information", "x-displayname": "Port details.", "x-ves-proto-message": "ves.io.schema.discovery.PortInfoType", "properties": { "port": { "type": "integer", "description": "Port number on which the service is exposed.", "title": "Port", "format": "int64", "x-displayname": "Port number.", "x-ves-example": "8080", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Port number on which the service is exposed.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "protocol": { "type": "string", "description": "Protocol on which the service is exposed.", "title": "Protocol", "x-displayname": "Protocol", "x-ves-example": "TCP", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "TCP", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Protocol on which the service is exposed.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "target_port": { "type": "integer", "description": "Port on which the pods targeted by the service can be reached.\nTargetPort of Kubernetes service when its type is ClusterIP.\nNodePort of Kubernetes service when its type is NodePort.", "title": "Target Port", "format": "int64", "x-displayname": "Target Port number.", "x-ves-example": "8081", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8081", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Port on which the pods targeted by the service can be reached. TargetPort of Kubernetes service when its type is ClusterIP.", "x-f5xc-description-medium": "Port on which the pods targeted by the service can be reached. TargetPort of Kubernetes service when its type is ClusterIP. NodePort of Kubernetes service when its type is NodePort.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about port and protocol on which the service is provided.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discoveryPortInfoType", "required_fields": [ "port", "protocol", "target_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"port\": 1,\n \"protocol\": \"TCP\",\n \"target_port\": 1\n}", "example_yaml": "port: 1\nprotocol: TCP\ntarget_port: 1" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Service discovery is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "discovery_cloudAwsServiceType": { "type": "string", "description": "Specifies the type of AWS service\n\nInvalid type of AWS service\nElastic cloud compute (EC2) instance\nAuto scaling group\nTarget group\nLambda function\nVirtual private cloud (VPC) endpoint\nNetwork load balancer (NLB)\nApplication load balancer (ALB)\nGateway load balancer (Gateway LB)", "title": "AwsServiceType", "enum": [ "INVALID_AWS_SERVICE", "EC2", "AUTO_SCALING_GROUP", "TARGET_GROUP", "LAMBDA_FUNCTION", "VPC_ENDPOINT", "NETWORK_LOAD_BALANCER", "APPLICATION_LOAD_BALANCER", "GATEWAY_LOAD_BALANCER" ], "default": "INVALID_AWS_SERVICE", "x-displayname": "Service Type.", "x-ves-proto-enum": "ves.io.schema.discovery_cloud.AwsServiceType", "x-f5xc-description-short": "Specifies the type of AWS service Invalid type of AWS service Elastic cloud compute (EC2) instance Auto scaling group Target group Lambda function...", "x-f5xc-description-medium": "Specifies the type of AWS service Invalid type of AWS service Elastic cloud compute (EC2) instance Auto scaling group Target group Lambda function Virtual private cloud (VPC) endpoint Network load balancer (NLB) Application load balancer (ALB) Gateway load balancer (Gateway LB).", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for discovery_cloudAwsServiceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID_AWS_SERVICE\"", "example_yaml": "INVALID_AWS_SERVICE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Service discovery is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "ioschemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaMetricValue": { "type": "object", "description": "Metric data contains timestamp and the value.", "title": "Metric Value", "x-displayname": "Metric Value.", "x-ves-proto-message": "ves.io.schema.MetricValue", "properties": { "timestamp": { "type": "number", "description": "Timestamp", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1570007981.", "x-f5xc-example": "1570007981", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend_value": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendValue" } ], "x-f5xc-description-short": "Configuration parameter for trend value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "15", "x-f5xc-example": "15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metric data contains timestamp and the value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaMetricValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemadiscovered_serviceGetSpecType": { "type": "object", "description": "GET Discovered Service Object.", "title": "Get Discovered Service Object", "x-displayname": "GET Discovered Service Object.", "x-ves-oneof-field-service_type": "[\"aws_service\",\"consul_service\",\"k8s_service\",\"n1_discovered_server\",\"third_party\",\"virtual_server\"]", "x-ves-oneof-field-visibility_action_choice": "[\"visibility_disabled\",\"visibility_enabled\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.GetSpecType", "properties": { "aws_service": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceAwsService" } ], "x-f5xc-description-short": "Configuration parameter for aws service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "consul_service", "k8s_service", "n1_discovered_server", "third_party", "virtual_server" ] }, "consul_service": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceConsulService" } ], "x-f5xc-description-short": "Configuration parameter for consul service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_service", "k8s_service", "n1_discovered_server", "third_party", "virtual_server" ] }, "http_load_balancers": { "type": "array", "description": "List of references to HTTP Load Balancers using this service.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "HTTP Load Balancers.", "x-f5xc-description-short": "List of references to HTTP Load Balancers using this service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "k8s_service": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceK8sService" } ], "x-f5xc-description-short": "Configuration parameter for k8s service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_service", "consul_service", "n1_discovered_server", "third_party", "virtual_server" ] }, "n1_discovered_server": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceNginxOneDiscoveredServer" } ], "x-f5xc-description-short": "Configuration parameter for n1 discovered server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_service", "consul_service", "k8s_service", "third_party", "virtual_server" ] }, "tcp_load_balancers": { "type": "array", "description": "List of references to TCP Load Balancers using this service.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "TCP Load Balancers.", "x-f5xc-description-short": "List of references to TCP Load Balancers using this service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "third_party": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceThirdPartyApplicationDiscovery" } ], "x-f5xc-description-short": "Configuration parameter for third party.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_service", "consul_service", "k8s_service", "n1_discovered_server", "virtual_server" ] }, "virtual_server": { "allOf": [ { "$ref": "#/components/schemas/discovered_serviceVirtualServer" } ], "x-f5xc-description-short": "Configuration parameter for virtual server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_service", "consul_service", "k8s_service", "n1_discovered_server", "third_party" ] }, "visibility_disabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "visibility_enabled" ] }, "visibility_enabled": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "visibility_disabled" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadiscovered_serviceGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemadiscovered_serviceSuggestValuesResp": { "type": "object", "description": "Response body of SuggestValues request.", "title": "SuggestValuesResp", "x-displayname": "Response for SuggestValues.", "x-ves-proto-message": "ves.io.schema.discovered_service.SuggestValuesResp", "properties": { "items": { "type": "array", "description": "List of suggested items.", "title": "item_lists", "items": { "$ref": "#/components/schemas/schemadiscovered_serviceSuggestedItem" }, "x-displayname": "Suggested Items.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadiscovered_serviceSuggestValuesResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemadiscovered_serviceSuggestedItem": { "type": "object", "description": "A tuple with a suggested value and it's description.", "title": "SuggestedItem", "x-displayname": "Suggested Item.", "x-ves-oneof-field-value_choice": "[\"ref_value\",\"str_value\"]", "x-ves-proto-message": "ves.io.schema.discovered_service.SuggestedItem", "properties": { "description": { "type": "string", "description": "Optional description for the suggested value.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "Optional description for the suggested value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref_value": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "str_value" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "ref_value", "gated_by": { "choice": "value_choice" }, "required": false, "cardinality": "single" } ] }, "str_value": { "type": "string", "description": "Exclusive with [ref_value]", "title": "str_value", "x-displayname": "String", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ref_value" ] } }, "x-f5xc-description-short": "Tuple with a suggested value and it's description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadiscovered_serviceSuggestedItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemadiscovered_serviceWhereSite": { "type": "object", "description": "This defines a reference to a CE site where a load balancer could be advertised.", "title": "WhereSite", "x-displayname": "Site", "x-ves-proto-message": "ves.io.schema.discovered_service.WhereSite", "properties": { "site": { "type": "array", "description": "Reference to site object.", "title": "Site", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Site Reference.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines a reference to a CE site where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadiscovered_serviceWhereSite", "required_fields": [ "site" ], "mutually_exclusive_groups": [], "example_json": "{\n \"site\": [\n {}\n ]\n}", "example_yaml": "site:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemadiscovered_serviceWhereVirtualSite": { "type": "object", "description": "This defines a reference to a customer site virtual site where a load balancer could be advertised.", "title": "WhereVirtualSite", "x-displayname": "Virtual Site.", "x-ves-proto-message": "ves.io.schema.discovered_service.WhereVirtualSite", "properties": { "virtual_site": { "type": "array", "description": "Reference to virtual site object.", "title": "Virtual Site", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Virtual Site Reference.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines a reference to a customer site virtual site where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadiscovered_serviceWhereVirtualSite", "required_fields": [ "virtual_site" ], "mutually_exclusive_groups": [], "example_json": "{\n \"virtual_site\": [\n {}\n ]\n}", "example_yaml": "virtual_site:\n- {}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaviewsObjectRefType": { "type": "object", "description": "This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name.", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.views.ObjectRefType", "properties": { "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "minLength": 1, "maxLength": 128, "x-displayname": "Name", "x-ves-example": "Contacts-route.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "contacts-route", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaviewsWhereSite": { "type": "object", "description": "This defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "title": "WhereSite", "x-displayname": "Site", "x-ves-displayorder": "1,2,3", "x-ves-proto-message": "ves.io.schema.views.WhereSite", "properties": { "ip": { "type": "string", "description": "Use given IP address as VIP on the site.", "title": "IP address on the site", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.132.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Use given IP address as VIP on the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetwork" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "site", "field_path": "site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsWhereSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaviewsWhereVirtualSite": { "type": "object", "description": "This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "title": "WhereVirtualSite", "x-displayname": "Virtual Site.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualSite", "properties": { "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetwork" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsWhereVirtualSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsAdvertiseCustom__ves_io_schema_discovered_service": { "type": "object", "description": "This defines a way to advertise a VIP on specific sites.", "title": "AdvertiseWhere", "x-displayname": "Advertise Custom.", "x-ves-proto-message": "ves.io.schema.views.AdvertiseCustom", "properties": { "advertise_where": { "type": "array", "description": "Where should this load balancer be available.", "title": "Advertise Where", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/viewsWhereType__ves_io_schema_discovered_service" }, "x-displayname": "List of Sites to Advertise.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "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": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Where should this load balancer be available.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines a way to advertise a VIP on specific sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAdvertiseCustom", "required_fields": [ "advertise_where" ], "mutually_exclusive_groups": [], "example_json": "{\n \"advertise_where\": [\n {}\n ]\n}", "example_yaml": "advertise_where:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsAdvertisePublic": { "type": "object", "description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.", "title": "AdvertisePublic", "x-displayname": "Advertise Public.", "x-ves-proto-message": "ves.io.schema.views.AdvertisePublic", "properties": { "public_ip": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "public_ip", "field_path": "public_ip", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a way to advertise a load balancer on public.", "x-f5xc-description-medium": "Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAdvertisePublic", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsSiteNetwork": { "type": "string", "description": "This defines network types to be used on site\n\nAll inside and outside networks.\nAll inside and outside networks with internet VIP support.\nAll inside networks.\nAll outside networks.\nAll outside networks with internet VIP support.\nVK8s service network.\n- SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site\n\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network.", "title": "SiteNetwork", "enum": [ "SITE_NETWORK_INSIDE_AND_OUTSIDE", "SITE_NETWORK_INSIDE", "SITE_NETWORK_OUTSIDE", "SITE_NETWORK_SERVICE", "SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP", "SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP", "SITE_NETWORK_IP_FABRIC" ], "default": "SITE_NETWORK_INSIDE_AND_OUTSIDE", "x-displayname": "Site Network.", "x-ves-proto-enum": "ves.io.schema.views.SiteNetwork", "x-f5xc-description-short": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support.", "x-f5xc-description-medium": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_NETWORK_INSIDE_AND_OUTSIDE\"", "example_yaml": "SITE_NETWORK_INSIDE_AND_OUTSIDE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteNetworkSpecifiedVIP": { "type": "string", "description": "This defines network types to be used on virtual-site with specified VIP\n\nAll outside networks.\nAll inside networks.", "title": "SiteNetworkSpecifiedVIP", "enum": [ "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE", "SITE_NETWORK_SPECIFIED_VIP_INSIDE" ], "default": "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE", "x-displayname": "Site Network.", "x-ves-proto-enum": "ves.io.schema.views.SiteNetworkSpecifiedVIP", "x-f5xc-description-short": "Defines network types to be used on virtual-site with specified VIP All outside networks.", "x-f5xc-description-medium": "Defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteNetworkSpecifiedVIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_NETWORK_SPECIFIED_VIP_OUTSIDE\"", "example_yaml": "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsWhereType__ves_io_schema_discovered_service": { "type": "object", "description": "This defines various OPTIONS where a Loadbalancer could be advertised.", "title": "WhereType", "x-displayname": "Select Where to Advertise.", "x-ves-displayorder": "4,5", "x-ves-oneof-field-choice": "[\"advertise_on_public\",\"cloud_edge_segment\",\"segment\",\"site\",\"site_segment\",\"virtual_network\",\"virtual_site\",\"virtual_site_segment\",\"virtual_site_with_vip\",\"vk8s_service\"]", "x-ves-oneof-field-port_choice": "[\"port\",\"port_ranges\",\"use_default_port\"]", "x-ves-proto-message": "ves.io.schema.views.WhereType", "properties": { "advertise_on_public": { "allOf": [ { "$ref": "#/components/schemas/viewsAdvertisePublic" } ], "x-f5xc-description-short": "Configuration parameter for advertise on public.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "port": { "type": "integer", "description": "Exclusive with [port_ranges use_default_port]\nPort to Listen.", "title": "Port to listen", "format": "int64", "x-displayname": "Listen Port.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-f5xc-description-short": "Exclusive with [port_ranges use_default_port] Port to Listen.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port_ranges", "use_default_port" ] }, "port_ranges": { "type": "string", "description": "Exclusive with [port use_default_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".", "title": "Port ranges to listen", "minLength": 1, "maxLength": 512, "x-displayname": "Listen Port Ranges.", "x-ves-example": "80,443,8080-8191,9080.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-example": "80,443,8080-8191,9080", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-description-short": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges.", "x-f5xc-description-medium": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port", "use_default_port" ] }, "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsWhereSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "use_default_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port", "port_ranges" ] }, "virtual_network": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVirtualNetwork" } ], "x-f5xc-description-short": "Configuration parameter for virtual network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsWhereVirtualSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "virtual_site_with_vip": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVirtualSiteSpecifiedVIP" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "vk8s_service" ] }, "vk8s_service": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVK8SService" } ], "x-f5xc-description-short": "Configuration parameter for vk8s service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip" ] } }, "x-f5xc-description-short": "Defines various OPTIONS where a Loadbalancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVK8SService": { "type": "object", "description": "This defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "title": "WhereVK8SService", "x-displayname": "VK8s Services on RE.", "x-ves-displayorder": "3", "x-ves-oneof-field-choice": "[\"site\",\"virtual_site\"]", "x-ves-proto-message": "ves.io.schema.views.WhereVK8SService", "properties": { "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "virtual_site" ], "x-f5xc-references": [ { "resource_kind": "site", "field_path": "site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "x-f5xc-description-medium": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVK8SService", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVirtualNetwork": { "type": "object", "description": "Parameters to advertise on a given virtual network.", "title": "WhereVirtualNetwork", "x-displayname": "Virtual Network.", "x-ves-displayorder": "1,2,10", "x-ves-oneof-field-v6_vip_choice": "[\"default_v6_vip\",\"specific_v6_vip\"]", "x-ves-oneof-field-vip_choice": "[\"default_vip\",\"specific_vip\"]", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualNetwork", "properties": { "default_v6_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "specific_v6_vip" ] }, "default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "specific_vip" ] }, "specific_v6_vip": { "type": "string", "description": "Exclusive with [default_v6_vip]\nUse given IPv6 address as VIP on virtual Network.", "title": "Specific V6 VIP", "x-displayname": "Specific V6 VIP.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Exclusive with [default_v6_vip] Use given IPv6 address as VIP on virtual Network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_v6_vip" ] }, "specific_vip": { "type": "string", "description": "Exclusive with [default_vip]\nUse given IPv4 address as VIP on virtual Network.", "title": "Specific VIP", "x-displayname": "Specific V4 VIP.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Exclusive with [default_vip] Use given IPv4 address as VIP on virtual Network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_vip" ] }, "virtual_network": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for virtual network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_network", "field_path": "virtual_network", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Parameters to advertise on a given virtual network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVirtualNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVirtualSiteSpecifiedVIP": { "type": "object", "description": "This defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "title": "WhereVirtualSiteSpecifiedVIP", "x-displayname": "Virtual Site with Specified VIP.", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualSiteSpecifiedVIP", "properties": { "ip": { "type": "string", "description": "Use given IP address as VIP on the site.", "title": "IP address on the site", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.132.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Use given IP address as VIP on the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetworkSpecifiedVIP" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVirtualSiteSpecifiedVIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flow_anomalyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read flow_anomaly", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.flow_anomaly.GetResponse", "properties": { "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/flow_anomalyGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/flow_anomalyStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flow_anomalyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flow_anomalyGetSpecType": { "type": "object", "description": "Shape of the flow anomaly specification.", "title": "Get Flow Anomaly", "x-displayname": "GET Flow Anomaly.", "x-ves-proto-message": "ves.io.schema.flow_anomaly.GetSpecType", "properties": { "last_enabled_time": { "type": "string", "description": "Last enabled time for flow anomaly add on service.", "format": "date-time", "x-displayname": "Last Enabled Time.", "x-ves-example": "2024-05-08T09:46:10Z.", "x-f5xc-example": "2024-05-08T09:46:10Z", "x-f5xc-description-short": "Last enabled time for flow anomaly add on service.", "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 } }, "service_state": { "allOf": [ { "$ref": "#/components/schemas/schemaAddonServiceState" } ], "x-f5xc-description-short": "Configuration parameter for service state.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the flow anomaly specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flow_anomalyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flow_anomalyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of flow_anomaly", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.flow_anomaly.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/flow_anomalyListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flow_anomalyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flow_anomalyListResponseItem": { "type": "object", "description": "By default a summary of flow_anomaly is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of flow_anomaly", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.flow_anomaly.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this flow_anomaly.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this flow_anomaly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this flow_anomaly.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this flow_anomaly.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates flow_anomaly is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates flow_anomaly is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/flow_anomalyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this flow_anomaly.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this flow_anomaly.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this flow_anomaly.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/flow_anomalyStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this flow_anomaly.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of flow_anomaly is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of flow_anomaly is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flow_anomalyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flow_anomalyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for flow anomaly", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.flow_anomaly.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Reference to object for current status.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flow_anomalyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "schemaAddonServiceState": { "type": "string", "description": "State of a service\n\ndefault state\ninitiated subscription request and is pending to activate (requested).\nSuccessfully subscribed\nservice subscription request ended up in error state.", "title": "AddonServiceState", "enum": [ "AS_NONE", "AS_PENDING", "AS_SUBSCRIBED", "AS_ERROR" ], "default": "AS_NONE", "x-displayname": "Addon Service State.", "x-ves-proto-enum": "ves.io.schema.AddonServiceState", "x-f5xc-description-short": "State of a service default state initiated subscription request and is pending to activate (requested).", "x-f5xc-description-medium": "State of a service default state initiated subscription request and is pending to activate (requested). Successfully subscribed service subscription request ended up in error state.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaAddonServiceState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"AS_NONE\"", "example_yaml": "AS_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlowInfo": { "type": "object", "description": "Flow information.", "title": "Flow Information", "x-displayname": "Flow Information.", "x-ves-proto-message": "ves.io.schema.operate.flow.FlowInfo", "properties": { "ace_id": { "type": "integer", "description": "ACE identifier.", "title": "Ace", "format": "int64", "x-displayname": "Ace", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "acl_id": { "type": "integer", "description": "ACL identifier.", "title": "Acl", "format": "int64", "x-displayname": "ACL", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "action": { "type": "string", "description": "Action on the flow traffic.", "title": "Flow Action", "x-displayname": "Flow Action.", "x-ves-example": "Forward", "x-f5xc-example": "Forward", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "byte_count": { "type": "string", "description": "Total byte count of the packets that hit the flow.", "title": "Byte Count", "format": "uint64", "x-displayname": "Bytes", "x-ves-example": "1000", "x-f5xc-example": "1000", "x-f5xc-description-short": "Total byte count of the packets that hit the flow.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dest_nh_id": { "type": "integer", "description": "Destination nexthop ID.", "title": "Destination Nexthop", "format": "int64", "x-displayname": "Destination Nexthop.", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "dest_vrf_id": { "type": "integer", "description": "Destination VRF ID, when VRF translation is involved.", "title": "Dest VRF", "format": "int64", "x-displayname": "Dest VRF", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-description-short": "Destination VRF ID, when VRF translation is involved.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "drop_reason": { "type": "string", "description": "Reason for flow drop, when action is \"Drop\"", "title": "Drop Reason", "x-displayname": "Drop Reason.", "x-ves-example": "No source route.", "x-f5xc-example": "No source route", "x-f5xc-description-short": "Reason for flow drop, when action is \"Drop\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ecmp_nh_id": { "type": "array", "description": "List of nexthop identifiers, when ecmp is applicable.", "title": "Ecmp Nexthop", "items": { "type": "integer", "format": "int64" }, "x-displayname": "Ecmp Nexthop.", "x-ves-example": "20 30 40", "x-f5xc-example": "20 30 40", "x-f5xc-description-short": "List of nexthop identifiers, when ecmp is applicable.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "external_service_nh_id": { "type": "integer", "description": "Nexthop for the External Service.", "title": "External Service Nexthop", "format": "int64", "x-displayname": "External Service Nexthop.", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "flags": { "type": "string", "description": "Flow TCP flags.", "title": "Flags", "x-displayname": "Flags", "x-f5xc-example": "\"SYN; ESTABLISHED\";", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "flow_index": { "type": "integer", "description": "Index of the forward flow.", "title": "Flow Index", "format": "int64", "x-displayname": "Flow Index.", "x-ves-example": "44444", "x-f5xc-example": "44444", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "forward_flow": { "allOf": [ { "$ref": "#/components/schemas/flowFlowKey" } ], "x-f5xc-description-short": "Configuration parameter for forward flow.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "forward_label": { "type": "integer", "description": "Forward label.", "title": "Forward Label", "format": "int32", "x-displayname": "Forward Label.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fr_ttl": { "type": "integer", "description": "TTL value", "title": "Ttl", "format": "int64", "x-displayname": "TTL", "x-ves-example": "64", "x-f5xc-example": "64", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pkt_count": { "type": "string", "description": "Number of packets that hit the flow.", "title": "Packet Count", "format": "uint64", "x-displayname": "Packets", "x-ves-example": "100", "x-f5xc-example": "100", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "uint64", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "qos_id": { "type": "integer", "description": "QoS identifier.", "title": "Qos", "format": "int64", "x-displayname": "QoS", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "reverse_flow_index": { "type": "integer", "description": "Index of the reverse flow.", "title": "Reverse Flow Index", "format": "int64", "x-displayname": "Reverse Flow Index.", "x-ves-example": "55555", "x-f5xc-example": "55555", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_nh_id": { "type": "integer", "description": "Source nexthop ID.", "title": "Source Nexthop", "format": "int64", "x-displayname": "Source Nexthop.", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFlowInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlowKey": { "type": "object", "description": "Flow Key", "title": "Flow Key", "x-displayname": "Flow Key", "x-ves-proto-message": "ves.io.schema.operate.flow.FlowKey", "properties": { "dest": { "type": "string", "description": "Destination Address of the flow.", "title": "Destination Address", "x-displayname": "Destination Address.", "x-ves-example": "192.0.2.104.", "x-f5xc-example": "192.0.2.104", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dest_port": { "type": "integer", "description": "Destination port of the flow.", "title": "Destination Port", "format": "int32", "x-displayname": "Destination Port.", "x-ves-example": "22225", "x-f5xc-example": "22225", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "intf_id": { "type": "integer", "description": "Interface index.", "title": "Interface Index", "format": "int64", "x-displayname": "Interface Index.", "x-ves-example": "20", "x-f5xc-example": "20", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "proto": { "type": "integer", "description": "Protocol of the flow.", "title": "Protocol", "format": "int64", "x-displayname": "Protocol", "x-ves-example": "6", "x-f5xc-example": "6", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src": { "type": "string", "description": "Source Address of the flow.", "title": "Source Address", "x-displayname": "Source Address.", "x-ves-example": "192.0.2.104.", "x-f5xc-example": "192.0.2.104", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_port": { "type": "integer", "description": "Source port of the flow.", "title": "Source Port", "format": "int64", "x-displayname": "Source Port.", "x-ves-example": "22225", "x-f5xc-example": "22225", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vrf_id": { "type": "integer", "description": "Vrf index", "title": "Vrf", "format": "int64", "x-displayname": "Vrf", "x-ves-example": "10", "x-f5xc-example": "10", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFlowKey", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlowMatchRequest": { "type": "object", "description": "Request to GET list of VER flows matching the request.", "title": "Flow Match Request", "x-displayname": "Flow Match Request.", "x-ves-oneof-field-interface_or_network": "[\"external_service\",\"intf\",\"pod\",\"vn\",\"vn_type\"]", "x-ves-proto-message": "ves.io.schema.operate.flow.FlowMatchRequest", "properties": { "dest": { "type": "string", "description": "Destination Address of the flow (optional)", "title": "Destination Address", "x-displayname": "Destination Address.", "x-ves-example": "192.0.2.104.", "x-f5xc-example": "192.0.2.104", "x-f5xc-description-short": "Destination Address of the flow (optional).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dest_port": { "type": "integer", "description": "Destination port of the flow (optional)", "title": "Destination Port", "format": "int64", "x-displayname": "Destination Port.", "x-ves-example": "22225", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "22225", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Destination port of the flow (optional).", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "external_service": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for external service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "intf", "pod", "vn", "vn_type" ] }, "intf": { "type": "string", "description": "Exclusive with [external_service pod vn vn_type]\nName of the Interface on which flows are to be matched.", "title": "Interface", "x-displayname": "Interface", "x-ves-example": "Eth0", "x-f5xc-example": "eth0", "x-f5xc-description-short": "Exclusive with [external_service pod vn vn_type] Name of the Interface on which flows are to be matched.", "x-f5xc-description-medium": "Exclusive with [external_service pod vn vn_type] Name of the Interface on which flows are to be matched.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "external_service", "pod", "vn", "vn_type" ] }, "namespace": { "type": "string", "description": "Namespace for which the request is sent (system)", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "Namespace for which the request is sent (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])?$" }, "node": { "type": "string", "description": "Name of the node from which flows are requested.", "title": "Node Name", "minLength": 1, "maxLength": 64, "x-displayname": "Node Name", "x-ves-example": "Master-0", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "master-0", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "Name of the node from which flows are requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "pod": { "type": "string", "description": "Exclusive with [external_service intf vn vn_type]\nName of the pod for which flows are to be matched.", "title": "Pod Name", "x-displayname": "Pod Name", "x-ves-example": "Pod-5444dcd747-868hq.", "x-f5xc-example": "pod-5444dcd747-868hq", "x-f5xc-description-short": "Exclusive with [external_service intf vn vn_type] Name of the pod for which flows are to be matched.", "x-f5xc-description-medium": "Exclusive with [external_service intf vn vn_type] Name of the pod for which flows are to be matched.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "external_service", "intf", "vn", "vn_type" ] }, "proto": { "type": "integer", "description": "Protocol of the flow (optional)", "title": "Protocol", "format": "int64", "x-displayname": "Protocol", "x-ves-example": "6", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "6", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 255, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "seconds": { "type": "integer", "description": "Number of seconds for which flows are requested.\nA value of 100 returns flows created in the past 100 seconds,\nwith a maximum of 1024 flows. A value of 0 returns all matching\nflows upto a maximum of 1024.", "title": "Seconds", "format": "int64", "x-displayname": "Seconds", "x-ves-example": "100", "x-f5xc-example": "100", "x-f5xc-description-short": "Number of seconds for which flows are requested. A value of 100 returns flows created in the past 100 seconds, with a maximum of 1024 flows.", "x-f5xc-description-medium": "Number of seconds for which flows are requested. A value of 100 returns flows created in the past 100 seconds, with a maximum of 1024 flows. A value of 0 returns all matching flows upto a maximum of 1024.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "type": "string", "description": "Name of the site from which flows are requested.", "title": "Site Name", "x-displayname": "Site Name", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the site from which flows are requested.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src": { "type": "string", "description": "Source Address of the flow (optional)", "title": "Source Address", "x-displayname": "Source Address.", "x-ves-example": "192.0.2.104.", "x-f5xc-example": "192.0.2.104", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "src_port": { "type": "integer", "description": "Source port of the flow (optional)", "title": "Source Port", "format": "int64", "x-displayname": "Source Port.", "x-ves-example": "22225", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "22225", "x-validation-rules": { "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vn": { "type": "string", "description": "Exclusive with [external_service intf pod vn_type]\nName of Virtual Network on which flows are matched.", "title": "Virtual Network", "x-displayname": "Virtual Network.", "x-ves-example": "Site-local-outside-vn.", "x-f5xc-example": "site-local-outside-vn", "x-f5xc-description-short": "Exclusive with [external_service intf pod vn_type] Name of Virtual Network on which flows are matched.", "x-f5xc-description-medium": "Exclusive with [external_service intf pod vn_type] Name of Virtual Network on which flows are matched.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "external_service", "intf", "pod", "vn_type" ] }, "vn_type": { "allOf": [ { "$ref": "#/components/schemas/schemaVirtualNetworkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "external_service", "intf", "pod", "vn" ] } }, "x-f5xc-description-short": "Request to GET list of VER flows matching the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFlowMatchRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlows": { "type": "object", "description": "Matching flow list from VER.", "title": "Flows", "x-displayname": "Flows", "x-ves-proto-message": "ves.io.schema.operate.flow.Flows", "properties": { "flow": { "type": "array", "description": "Flow information.", "title": "Flow Info", "items": { "$ref": "#/components/schemas/flowFlowInfo" }, "x-displayname": "Flow Info", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFlows", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "schemaVirtualNetworkType": { "type": "string", "description": "Different types of virtual networks understood by the system\n\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network.\nThis is an insecure network and is connected to public internet via NAT Gateways/firwalls\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created automatically and present on all sites\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE is a private network inside site.\nIt is a secure network and is not connected to public network.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different\nsites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on CE sites. This network is created during provisioning of site\nUser defined per-site virtual network. Scope of this virtual network is limited to the site.\nThis is not yet supported\nVirtual-network of type VIRTUAL_NETWORK_PUBLIC directly connects to the public internet.\nVirtual-network of this type is local to every site. Two virtual networks of this type on different sites are neither related nor connected.\n\nConstraints:\nThere can be atmost one virtual network of this type in a given site.\nThis network type is supported on RE sites only\nIt is an internally created by the system. They must not be created by user\nVirtual Networks with global scope across different sites in F5XC domain.\nAn example global virtual-network called \"AIN Network\" is created for every tenant.\nFor F5 Distributed Cloud fabric\n\nConstraints:\nIt is currently only supported as internally created by the system.\nVK8s service network for a given tenant. Used to advertise a virtual host only to vk8s pods for that tenant\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVER internal network for the site. It can only be used for virtual hosts with SMA_PROXY type proxy\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE represents both\nVIRTUAL_NETWORK_SITE_LOCAL and VIRTUAL_NETWORK_SITE_LOCAL_INSIDE\n\nConstraints:\nThis network type is only meaningful in an advertise policy\nWhen virtual-network of type VIRTUAL_NETWORK_IP_AUTO is selected for\nan endpoint, VER will try to determine the network based on the provided\nIP address\n\nConstraints:\nThis network type is only meaningful in an endpoint\n\nVoltADN Private Network is used on F5 Distributed Cloud RE(s) to connect to customer private networks\nThis network is created by opening a support ticket\n\nThis network is per site srv6 network\nVER IP Fabric network for the site.\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network\nConstraints:\nIt is an internally created by the system. Must not be created by user\nNetwork internally created for a segment\nConstraints:\nIt is an internally created by the system. Must not be created by user\nVirtual-network of type VIRTUAL_NETWORK_MANAGEMENT is used for management purposes.", "title": "VirtualNetworkType", "enum": [ "VIRTUAL_NETWORK_SITE_LOCAL", "VIRTUAL_NETWORK_SITE_LOCAL_INSIDE", "VIRTUAL_NETWORK_PER_SITE", "VIRTUAL_NETWORK_PUBLIC", "VIRTUAL_NETWORK_GLOBAL", "VIRTUAL_NETWORK_SITE_SERVICE", "VIRTUAL_NETWORK_VER_INTERNAL", "VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE", "VIRTUAL_NETWORK_IP_AUTO", "VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK", "VIRTUAL_NETWORK_SRV6_NETWORK", "VIRTUAL_NETWORK_IP_FABRIC", "VIRTUAL_NETWORK_SEGMENT", "VIRTUAL_NETWORK_MANAGEMENT" ], "default": "VIRTUAL_NETWORK_SITE_LOCAL", "x-displayname": "Virtual Network Type.", "x-ves-proto-enum": "ves.io.schema.VirtualNetworkType", "x-f5xc-description-short": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public...", "x-f5xc-description-medium": "Different types of virtual networks understood by the system Virtual-network of type VIRTUAL_NETWORK_SITE_LOCAL provides connectivity to public (outside) network. This is an insecure network and is connected to public internet via NAT Gateways/firwalls Virtual-network of this type is local to...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaVirtualNetworkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VIRTUAL_NETWORK_SITE_LOCAL\"", "example_yaml": "VIRTUAL_NETWORK_SITE_LOCAL\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual network is platform-level infrastructure" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "flowAnomalyData": { "type": "object", "description": "Anomaly Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "x-displayname": "Anomaly Data.", "x-ves-proto-message": "ves.io.schema.flow.AnomalyData", "properties": { "anomalous_data_transferred": { "type": "string", "title": "Anomalous data transferred in bytes\nx-displayName: \"Anomalous Data Transferred\"", "format": "int64", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "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 } }, "anomaly_duration_seconds": { "type": "string", "description": "Security-related configuration", "title": "Time between anomaly start and last seen time.\nx-displayName: \"Anomaly duration\"\nx-example: \"300\"", "format": "int64", "x-displayname": "Anomaly duration.", "x-ves-example": "300", "x-f5xc-example": "300", "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 } }, "anomaly_level": { "allOf": [ { "$ref": "#/components/schemas/flowAnomalyLevel" } ], "x-f5xc-description-short": "Configuration parameter for anomaly level.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomaly_score": { "type": "number", "title": "Anomaly Score\nHigher value indicates more a anomalous datapoint.\nx-displayName: \"Anomaly score\"", "format": "float", "x-displayname": "Anomaly score.", "description": "Configuration parameter for anomaly score", "x-f5xc-description-short": "Configuration parameter for anomaly score.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "anomaly_start_time": { "type": "string", "description": "Configuration parameter for anomaly start time", "title": "Time when the anomaly began.\nx-displayName: \"Anomaly start time\"\nx-example: \"2021-01-22 15:46:23.767649\"", "format": "date-time", "x-displayname": "Anomaly start time.", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "x-f5xc-description-short": "Configuration parameter for anomaly 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 } }, "flow_count": { "type": "string", "description": "Number of items or occurrences", "title": "Count of anomalous flows\nx-displayName: \"Flow Count\"\nx-example: \"100000\"", "format": "int64", "x-displayname": "Flow Count.", "x-ves-example": "100000", "x-f5xc-example": "100000", "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 } }, "labels": { "type": "object", "title": "Labels with metadata about the anomaly\nKey is the label name defined in the Labels enum.\nx-displayName: \"Labels\"", "x-displayname": "Labels", "description": "Key-value labels for organization and selection", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Key-value labels for organization and selection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "scan_time": { "type": "string", "description": "Configuration parameter for scan time", "title": "Time when the anomaly detection scan was last run.\nx-displayName: \"Scan time\"\nx-example: \"2021-01-22 15:46:23.767649\"", "format": "date-time", "x-displayname": "Scan time", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "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 } }, "total_data_transferred": { "type": "string", "title": "Total data transferred in bytes\nx-displayName: \"Total Data Transferred\"", "format": "int64", "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "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": "Anomaly Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "x-f5xc-description-medium": "Anomaly Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowAnomalyData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flowAnomalyLevel": { "type": "string", "title": "- LOW_ANOMALY_LEVEL: x-displayName: \"Low\"\nLow anomaly level\n - MEDIUM_ANOMALY_LEVEL: x-displayName: \"Medium\"\nMedium anomaly level\n - HIGH_ANOMALY_LEVEL: x-displayName: \"High\"\nHigh anomaly level", "enum": [ "LOW_ANOMALY_LEVEL", "MEDIUM_ANOMALY_LEVEL", "HIGH_ANOMALY_LEVEL" ], "default": "LOW_ANOMALY_LEVEL", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.flow.AnomalyLevel", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowAnomalyLevel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"LOW_ANOMALY_LEVEL\"", "example_yaml": "LOW_ANOMALY_LEVEL\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "observability", "multi_tenant_pattern": "none" } } }, "flowFieldData": { "type": "object", "description": "Field Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "title": "Field Data", "x-displayname": "Field Data.", "x-ves-proto-message": "ves.io.schema.flow.FieldData", "properties": { "labels": { "type": "object", "description": "Labels contains the name/value pair.\n\"name\" is the label defined in Labels.", "title": "Labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Labels contains the name/value pair. \"name\" is the label defined in Labels.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "array", "description": "List of metric values.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 15, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Field Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "x-f5xc-description-medium": "Field Data contains key/value pairs that uniquely identifies the group_by labels specified in the request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFieldData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFieldSelector": { "type": "string", "description": "Field selector for flow data\n\nx-unit: \"bytes\"\nx-unit: \"packets\"\nx-unit: \"packets\"\nx-unit: \"bytes\"\nx-unit: \"packets\"\nx-unit: \"packets\"\nx-unit: \"count\"", "title": "FieldSelector", "enum": [ "BYTES", "PACKETS", "DROPPED_PACKETS", "TX_BYTES", "TX_PACKETS", "TX_DROPPED_PACKETS", "FLOW_COUNT" ], "default": "BYTES", "x-displayname": "Field selector.", "x-ves-proto-enum": "ves.io.schema.flow.FieldSelector", "x-f5xc-description-short": "Field selector for flow data x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"count\".", "x-f5xc-description-medium": "Field selector for flow data x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"bytes\" x-unit: \"packets\" x-unit: \"packets\" x-unit: \"count\".", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"BYTES\"", "example_yaml": "BYTES\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlowAnomalyData": { "type": "object", "title": "FlowAnomalyData wraps the response data for top flow anomalies.\nx-displayName: \"FlowAnomalyData\"", "x-displayname": "FlowAnomalyData.", "x-ves-proto-message": "ves.io.schema.flow.FlowAnomalyData", "properties": { "anomaly_data": { "type": "array", "title": "x-displayName: \"AnomalyData\"\nAnomaly Data", "items": { "$ref": "#/components/schemas/flowAnomalyData" }, "description": "Data or content configuration", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/flowFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowFlowAnomalyData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowFlowData": { "type": "object", "description": "FlowData wraps all the response data.", "title": "FlowData", "x-displayname": "FlowData", "x-ves-proto-message": "ves.io.schema.flow.FlowData", "properties": { "data": { "type": "array", "description": "Flows data.", "title": "Data", "items": { "$ref": "#/components/schemas/flowFieldData" }, "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/flowFieldSelector" } ], "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-minimum-configuration": { "description": "Minimum configuration for flowFlowData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSortBy": { "type": "object", "description": "Sorting for data by given fields.", "title": "SortBy", "x-displayname": "Sort By", "x-ves-proto-message": "ves.io.schema.flow.SortBy", "properties": { "sort_direction": { "allOf": [ { "$ref": "#/components/schemas/flowSortDirection" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sort_label": { "allOf": [ { "$ref": "#/components/schemas/flowSortLabel" } ], "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 flowSortBy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSortDirection": { "type": "string", "description": "Sort Direction for sorting data\n\nSort Direction Desc\nby default data is sorted in descending direction\nSort Direction Asc.", "title": "Sort Direction", "enum": [ "SORT_DIRECTION_DESC", "SORT_DIRECTION_ASC" ], "default": "SORT_DIRECTION_DESC", "x-displayname": "Sort Direction.", "x-ves-proto-enum": "ves.io.schema.flow.SortDirection", "x-f5xc-description-short": "Sort Direction for sorting data Sort Direction Desc by default data is sorted in descending direction Sort Direction Asc.", "x-f5xc-description-medium": "Sort Direction for sorting data Sort Direction Desc by default data is sorted in descending direction Sort Direction Asc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowSortDirection", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SORT_DIRECTION_DESC\"", "example_yaml": "SORT_DIRECTION_DESC\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSortLabel": { "type": "string", "description": "Sort Labels for sorting data\n\nSort Label None\nSort Label Bytes\nSort Label Flow Count\nSort Label Anomaly level\nSort Label Anomaly Duration.", "title": "Sort Label", "enum": [ "SORT_LABEL_NONE", "SORT_LABEL_BYTES", "SORT_LABEL_FLOW_COUNT", "SORT_LABEL_ANOMALY_LEVEL", "SORT_LABEL_ANOMALY_DURATION" ], "default": "SORT_LABEL_NONE", "x-displayname": "Sort Label.", "x-ves-proto-enum": "ves.io.schema.flow.SortLabel", "x-f5xc-description-short": "Sort Labels for sorting data Sort Label None Sort Label Bytes Sort Label Flow Count Sort Label Anomaly level Sort Label Anomaly Duration.", "x-f5xc-description-medium": "Sort Labels for sorting data Sort Label None Sort Label Bytes Sort Label Flow Count Sort Label Anomaly level Sort Label Anomaly Duration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowSortLabel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SORT_LABEL_NONE\"", "example_yaml": "SORT_LABEL_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSubscribeRequest": { "type": "object", "description": "Request to subscribe to Flow Collection.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.flow.SubscribeRequest", "properties": { "service_type": { "allOf": [ { "$ref": "#/components/schemas/schemaflowServiceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request to subscribe to Flow Collection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSubscribeResponse": { "type": "object", "description": "Response of subscribe to Flow Collection.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.flow.SubscribeResponse", "properties": { "flow_anomaly_detection_last_enabled_time": { "type": "string", "description": "Last Enabled Time for flow anomaly detection subscription request.", "title": "Last Enabled Time", "format": "date-time", "x-displayname": "Last Enabled Time.", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "x-f5xc-description-short": "Last Enabled Time for flow anomaly detection subscription request.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_enabled_time": { "type": "string", "description": "Last Enabled Time for flow collection subscription request.", "title": "Last Enabled Time", "format": "date-time", "x-displayname": "Last Enabled Time.", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "x-f5xc-description-short": "Last Enabled Time for flow collection subscription request.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response of subscribe to Flow Collection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowSubscriptionStatusResponse": { "type": "object", "description": "Response of subscription status for Flow Collection.", "title": "SubscriptionStatusResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.flow.SubscriptionStatusResponse", "properties": { "flow_anomaly_detection_last_enabled_time": { "type": "string", "description": "Last Enabled Time for flow anomaly detection subscription request.", "title": "Last Enabled Time", "format": "date-time", "x-displayname": "Last Enabled Time.", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "x-f5xc-description-short": "Last Enabled Time for flow anomaly detection subscription request.", "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 } }, "flow_anomaly_detection_result": { "allOf": [ { "$ref": "#/components/schemas/schemaAddonServiceState" } ], "x-f5xc-description-short": "Configuration parameter for flow anomaly detection result.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "last_enabled_time": { "type": "string", "description": "Last Enabled Time for flow collection subscription request.", "title": "Last Enabled Time", "format": "date-time", "x-displayname": "Last Enabled Time.", "x-ves-example": "2021-01-22 15:46:23.767649.", "x-f5xc-example": "2021-01-22 15:46:23.767649", "x-f5xc-description-short": "Last Enabled Time for flow collection subscription request.", "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 } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaAddonServiceState" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response of subscription status for Flow Collection.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for flowSubscriptionStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Alert policies are namespace-scoped monitoring configurations" }, "classification": { "category": "observability", "multi_tenant_pattern": "per-tenant" } } }, "flowTopFlowAnomaliesRequest": { "type": "object", "title": "Top flow anomalies request", "x-displayname": "Top flow anomalies request.", "x-ves-proto-message": "ves.io.schema.flow.TopFlowAnomaliesRequest", "properties": { "end_time": { "type": "string", "description": "End time of flow collection\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 flow collection Format: unix_timestamp|RFC 3339 Optional: If not specified, then the end_time will be evaluated to start_time+10m If...", "x-f5xc-description-medium": "End time of flow collection 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.", "title": "Field Selector", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/flowFieldSelector" }, "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-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": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[]}\n :=