{ "openapi": "3.0.3", "info": { "title": "Cloud Infrastructure", "description": "Hyperscaler integration supporting Amazon Web Services, Microsoft Azure, and Google Cloud Platform environments. Virtual network attachment workflows enable elastic compute provisioning with automatic reattachment capabilities. Edge authentication secrets for provider access. Segment telemetry and cross-region link reapplication for distributed deployments. Autonomous path synchronization across peered networks with real-time topology updates.", "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": "Hyperscaler integration supporting Amazon Web Services, Microsoft Azure, and Google Cloud Platform environments. Virtual network attachment workflows enable elastic compute provisioning with automatic reattachment capabilities. Edge authentication secrets for provider access. Segment telemetry and cross-region link reapplication for distributed deployments. Autonomous path synchronization across peered networks with real-time topology updates.", "x-f5xc-summary": "Multi-cloud provider connections with gateway peering and network path configuration. Credential vault integration and subnet enumeration.", "x-f5xc-cli-domain": "cloud_infrastructure", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/site-management/create-cloud-credentials", "description": "F5 XC Documentation - Cloud Infrastructure" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Invalid request body", "resolution": "Validate JSON structure and required fields before submission", "prevention": "Use schema validation from OpenAPI spec" }, { "code": 401, "message": "Authentication failed", "resolution": "Verify API token is valid and not expired", "prevention": "Use environment variables for token management" }, { "code": 403, "message": "Permission denied", "resolution": "Check user role and namespace permissions", "prevention": "Verify RBAC policies before operations" }, { "code": 404, "message": "Resource not found", "resolution": "Verify resource name and namespace exist", "prevention": "List resources before attempting operations" }, { "code": 409, "message": "Resource already exists", "resolution": "Use unique name or delete existing resource", "prevention": "Check existence before creation" }, { "code": 429, "message": "Rate limit exceeded", "resolution": "Implement exponential backoff and retry logic", "prevention": "Batch operations and add delays between requests" } ], "security_notes": [ "Always use HTTPS for all API communications", "Store API tokens securely, never in source code", "Rotate API tokens regularly following security policies" ], "performance_tips": [ "Use pagination for large result sets", "Batch related operations when possible", "Cache read-only responses appropriately" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "config" }, { "name": "data" }, { "name": "sync-cloud-data" } ], "paths": { "/api/config/namespaces/{namespace}/certified_hardwares": { "get": { "summary": "List Certified Hardware.", "description": "List the set of certified_hardware in a namespace.", "operationId": "ves.io.schema.certified_hardware.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certified_hardwareListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 certified_hardware.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.certified_hardware.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "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-discovered-response-time-ms": 164.25, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 164.25, "p95_ms": 328.5, "p99_ms": 492.75, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Certified Hardware.", "x-ves-proto-service": "ves.io.schema.certified_hardware.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/certified_hardwares/{name}": { "get": { "summary": "GET Certified Hardware.", "description": "GET Certified Hardware object.", "operationId": "ves.io.schema.certified_hardware.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certified_hardwareGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.certified_hardware.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "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": "Certified Hardware.", "x-ves-proto-service": "ves.io.schema.certified_hardware.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/sync-cloud-data/namespaces/system/cloud_connect_reapply_vpc_attachment": { "post": { "summary": "ReApplyVPCAttachment.", "description": "RE-applies VPC attachment in a cloud connect config.", "operationId": "ves.io.schema.cloud_connect.CloudDataCustomAPI.ReApplyVPCAttachment", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectReApplyVPCAttachmentResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectReApplyVPCAttachmentRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CloudDataCustomAPI.ReApplyVPCAttachment", "tags": [ "sync-cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Cloud-connect-reapply-vpc-attachment resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-connect-reapply-vpc-attachment" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-connect-reapply-vpc-attachment" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CloudDataCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/cloud_connects/metrics": { "post": { "summary": "All Cloud Connect Metrics.", "description": "Cloud Connect APIs are used to GET the data for cloud connect.", "operationId": "ves.io.schema.cloud_connect.CustomAPI.ListMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectListMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectListMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CustomAPI.ListMetrics", "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": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/cloud_connects/segment_metrics": { "post": { "summary": "All Cloud Connect Segment Metrics.", "description": "Cloud Connect APIs are used to GET the segment data for cloud connect.", "operationId": "ves.io.schema.cloud_connect.CustomAPI.ListSegmentMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectListSegmentMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectListSegmentMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CustomAPI.ListSegmentMetrics", "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": [ "Segment-metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "segment-metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "segment-metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/cloud_connects/{name}/metrics": { "post": { "summary": "Cloud Connect Metrics.", "description": "Cloud Connect Metrics queries metrics for a specified cloud connect.", "operationId": "ves.io.schema.cloud_connect.CustomAPI.GetMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectGetMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nCloud Connect name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "cloud_connect-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectGetMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CustomAPI.GetMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/sync-cloud-data/namespaces/system/discover_vpc": { "post": { "summary": "Cloud Connect VPC Discovery.", "description": "Returns all the vpcs for a specified cloud provider, region and cred.\nFor AWS it returns all the vpcs which are not attached to any transit gateway in that region.", "operationId": "ves.io.schema.cloud_connect.CloudDataCustomAPI.DiscoverVPC", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectDiscoverVPCResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectDiscoverVPCRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CloudDataCustomAPI.DiscoverVPC", "tags": [ "sync-cloud-data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Discover-vpc resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "discover-vpc" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "discover-vpc" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CloudDataCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/edge_credentials": { "post": { "summary": "Cloud Credential.", "description": "Returns the cloud credential for the matching edge type.", "operationId": "ves.io.schema.cloud_connect.ConfigCustomAPI.EdgeCredentials", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectCredentialsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectCredentialsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.ConfigCustomAPI.EdgeCredentials", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Edge-credential resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "edge-credential" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "edge-credential" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.ConfigCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/system/edge_list": { "get": { "summary": "Edge List", "description": "Returns the online edge sites (Both Customer Edge and Cloud Edge)", "operationId": "ves.io.schema.cloud_connect.ConfigCustomAPI.EdgeList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectEdgeListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.ConfigCustomAPI.EdgeList", "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": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.ConfigCustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/system/top/cloud_connects": { "post": { "summary": "Top Cloud Connect.", "description": "Request to GET top cloud connect from the AWS Cloudwatch metrics.", "operationId": "ves.io.schema.cloud_connect.CustomAPI.TopCloudConnect", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectTopCloudConnectResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/cloud_connectTopCloudConnectRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.CustomAPI.TopCloudConnect", "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": [ "Cloud-connect resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-connect" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-connect" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_connects": { "post": { "summary": "Create Cloud Connect.", "description": "Shape of the Cloud Connect specification.", "operationId": "ves.io.schema.cloud_connect.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_connectCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.API.Create", "tags": [ "config" ], "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": [ "Cloud-connect resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-connect" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-connect" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_connects/{metadata.name}": { "put": { "summary": "Replace Cloud Connect.", "description": "Shape of the Cloud Connect specification.", "operationId": "ves.io.schema.cloud_connect.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_connectReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.API.Replace", "tags": [ "config" ], "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": [ "cloud-connect" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-connect" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_connects": { "get": { "summary": "List Cloud Connect.", "description": "List the set of cloud_connect in a namespace.", "operationId": "ves.io.schema.cloud_connect.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 cloud_connect.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.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": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_connects/{name}": { "get": { "summary": "GET Cloud Connect.", "description": "Shape of the Cloud Connect specification.", "operationId": "ves.io.schema.cloud_connect.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_connectGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.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" } }, "delete": { "summary": "DELETE Cloud Connect.", "description": "DELETE the specified cloud_connect.", "operationId": "ves.io.schema.cloud_connect.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/cloud_connectDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_connect.API.Delete", "tags": [ "config" ], "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": [ "cloud-connect", "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": [ "cloud-connect", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Connect.", "x-ves-proto-service": "ves.io.schema.cloud_connect.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_credentialss": { "post": { "summary": "Create Cloud Credentials.", "description": "API to create cloud_credentials object.", "operationId": "ves.io.schema.cloud_credentials.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_credentialsCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_credentialsCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_credentials.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Cloud-credentials resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-credentials" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-credentials" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Credentials.", "x-ves-proto-service": "ves.io.schema.cloud_credentials.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_credentialss/{metadata.name}": { "put": { "summary": "Replace Cloud Credentials.", "description": "API to replace cloud_credentials object.", "operationId": "ves.io.schema.cloud_credentials.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_credentialsReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_credentialsReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_credentials.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "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": [ "cloud-credentials" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-credentials" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Credentials.", "x-ves-proto-service": "ves.io.schema.cloud_credentials.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_credentialss": { "get": { "summary": "List Cloud Credentials.", "description": "List the set of cloud_credentials in a namespace.", "operationId": "ves.io.schema.cloud_credentials.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_credentialsListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 cloud_credentials.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_credentials.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "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-discovered-response-time-ms": 176.41, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 176.41, "p95_ms": 352.82, "p99_ms": 529.23, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Cloud Credentials.", "x-ves-proto-service": "ves.io.schema.cloud_credentials.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_credentialss/{name}": { "get": { "summary": "GET Cloud Credentials.", "description": "API to GET cloud_credentials object.", "operationId": "ves.io.schema.cloud_credentials.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_credentialsGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_credentials.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "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 Cloud Credentials.", "description": "DELETE the specified cloud_credentials.", "operationId": "ves.io.schema.cloud_credentials.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/cloud_credentialsDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_credentials.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "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": [ "cloud-credentials", "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": [ "cloud-credentials", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Credentials.", "x-ves-proto-service": "ves.io.schema.cloud_credentials.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/system/cloud_elastic_ip/{name}/force-delete": { "post": { "summary": "Force DELETE Cloud Elastic IP.", "description": "Force DELETE Cloud Elastic IP.", "operationId": "ves.io.schema.cloud_elastic_ip.CustomAPI.ForceDeleteCloudElasticIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipForceDeleteCloudElasticIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nName of the Cloud Elastic IP object to be force deleted.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "cloud-elastic-ip-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipForceDeleteCloudElasticIPRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.CustomAPI.ForceDeleteCloudElasticIP", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Force-delete resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "force-delete" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "force-delete" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Elastic IP.", "x-ves-proto-service": "ves.io.schema.cloud_elastic_ip.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_elastic_ips": { "post": { "summary": "Create Cloud Elastic IP.", "description": "Create Cloud Elastic IP creates Cloud Elastic IP object\nObject is attached to a site.", "operationId": "ves.io.schema.cloud_elastic_ip.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_elastic_ipCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.API.Create", "tags": [ "config" ], "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": [ "Cloud-elastic-ip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-elastic-ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "cloud-elastic-ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Elastic IP.", "x-ves-proto-service": "ves.io.schema.cloud_elastic_ip.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_elastic_ips/{metadata.name}": { "put": { "summary": "Replace Cloud Elastic IP.", "description": "Replace cloud elastic IP will replace cloud elastic IP object with new object.", "operationId": "ves.io.schema.cloud_elastic_ip.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_elastic_ipReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.API.Replace", "tags": [ "config" ], "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": [ "cloud-elastic-ip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "cloud-elastic-ip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Elastic IP.", "x-ves-proto-service": "ves.io.schema.cloud_elastic_ip.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_elastic_ips": { "get": { "summary": "List Cloud Elastic IP.", "description": "List the set of cloud_elastic_ip in a namespace.", "operationId": "ves.io.schema.cloud_elastic_ip.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 cloud_elastic_ip.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.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": "Cloud Elastic IP.", "x-ves-proto-service": "ves.io.schema.cloud_elastic_ip.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_elastic_ips/{name}": { "get": { "summary": "GET Cloud Elastic IP.", "description": "GET cloud elastic IP will GET the object from the storage backend for namespace metadata.namespace.", "operationId": "ves.io.schema.cloud_elastic_ip.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_elastic_ipGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.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" } }, "delete": { "summary": "DELETE Cloud Elastic IP.", "description": "DELETE the specified cloud_elastic_ip.", "operationId": "ves.io.schema.cloud_elastic_ip.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/cloud_elastic_ipDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_elastic_ip.API.Delete", "tags": [ "config" ], "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": [ "cloud-elastic-ip", "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": [ "cloud-elastic-ip", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Elastic IP.", "x-ves-proto-service": "ves.io.schema.cloud_elastic_ip.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_regions/{metadata.name}": { "put": { "summary": "Replace Cloud Region.", "description": "Shape of the cloud RE specification.", "operationId": "ves.io.schema.cloud_region.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_regionReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_regionReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_region.API.Replace", "tags": [ "config" ], "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": [ "cloud-region" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-region" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Cloud Region.", "x-ves-proto-service": "ves.io.schema.cloud_region.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_regions": { "get": { "summary": "List Cloud Region.", "description": "List the set of cloud_region in a namespace.", "operationId": "ves.io.schema.cloud_region.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_regionListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 cloud_region.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_region.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": "Cloud Region.", "x-ves-proto-service": "ves.io.schema.cloud_region.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_regions/{name}": { "get": { "summary": "GET Cloud Region.", "description": "Shape of the cloud RE specification.", "operationId": "ves.io.schema.cloud_region.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_regionGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referred by this object.", "in": "query", "required": false, "x-displayname": "Broken Referred Objects.", "schema": { "type": "string", "enum": [ "GET_RSP_FORMAT_DEFAULT", "GET_RSP_FORMAT_FOR_REPLACE", "GET_RSP_FORMAT_STATUS", "GET_RSP_FORMAT_READ", "GET_RSP_FORMAT_REFERRING_OBJECTS", "GET_RSP_FORMAT_BROKEN_REFERENCES" ], "default": "GET_RSP_FORMAT_DEFAULT" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_region.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": "Cloud Region.", "x-ves-proto-service": "ves.io.schema.cloud_region.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/system/cloud_links/{name}/reapply_config": { "post": { "summary": "CloudLink", "description": "Reapply CloudLink Config.", "operationId": "ves.io.schema.cloud_link.CustomDataAPI.ReapplyConfig", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkReapplyConfigResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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\nName of Cloud Link.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "aws-cloud-link-east" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkReapplyConfigRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.CustomDataAPI.ReapplyConfig", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Reapply-config resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "reapply-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.name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "reapply-config" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CloudLink", "x-ves-proto-service": "ves.io.schema.cloud_link.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_links": { "post": { "summary": "Create CloudLink.", "description": "Creates a new CloudLink with configured parameters.", "operationId": "ves.io.schema.cloud_link.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_linkCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.API.Create", "tags": [ "config" ], "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": [ "Cloud-link resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "cloud-link" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-link" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CloudLink", "x-ves-proto-service": "ves.io.schema.cloud_link.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/cloud_links/{metadata.name}": { "put": { "summary": "Replace CloudLink.", "description": "Replaces configured CloudLink with new set of parameters.", "operationId": "ves.io.schema.cloud_link.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/cloud_linkReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.API.Replace", "tags": [ "config" ], "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": [ "cloud-link" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "cloud-link" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CloudLink", "x-ves-proto-service": "ves.io.schema.cloud_link.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_links": { "get": { "summary": "List CloudLink.", "description": "List the set of cloud_link in a namespace.", "operationId": "ves.io.schema.cloud_link.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 cloud_link.", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.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": "CloudLink", "x-ves-proto-service": "ves.io.schema.cloud_link.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/cloud_links/{name}": { "get": { "summary": "GET CloudLink.", "description": "Gets CloudLink parameters.", "operationId": "ves.io.schema.cloud_link.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud_linkGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.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" } }, "delete": { "summary": "DELETE CloudLink.", "description": "DELETE the specified cloud_link.", "operationId": "ves.io.schema.cloud_link.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/cloud_linkDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/cloud_infrastructure/" }, "x-ves-proto-rpc": "ves.io.schema.cloud_link.API.Delete", "tags": [ "config" ], "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": [ "cloud-link", "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": [ "cloud-link", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CloudLink", "x-ves-proto-service": "ves.io.schema.cloud_link.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "certified_hardwareAws": { "type": "object", "description": "AWS specific information.", "title": "AWS", "x-displayname": "AWS", "x-ves-oneof-field-image": "[\"image_id\"]", "x-ves-proto-message": "ves.io.schema.certified_hardware.Aws", "properties": { "image_id": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareAwsImage" } ], "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 certified_hardwareAws", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareAwsImage": { "type": "object", "x-ves-proto-message": "ves.io.schema.certified_hardware.AwsImage", "properties": { "image_id": { "type": "string", "description": "AWS ami image.", "title": "ImageId", "x-displayname": "AWS ami image 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 }, "x-field-mutability": "read-only" }, "region": { "type": "string", "description": "AWS ami image region.", "title": "Region", "x-displayname": "AWS ami image region.", "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": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareAwsImage", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareAzure": { "type": "object", "description": "Azure specific information.", "title": "Azure", "x-displayname": "Azure", "x-ves-oneof-field-image": "[\"image_id\",\"marketplace\"]", "x-ves-proto-message": "ves.io.schema.certified_hardware.Azure", "properties": { "image_id": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareAzureImage" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "x-f5xc-conflicts-with": [ "marketplace" ] }, "marketplace": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareMarketplace" } ], "x-f5xc-description-short": "Configuration parameter for marketplace.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "image_id" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareAzure", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareAzureImage": { "type": "object", "x-ves-proto-message": "ves.io.schema.certified_hardware.AzureImage", "properties": { "image_id": { "type": "string", "description": "Azure image ID.", "title": "ImageId", "x-displayname": "Azure image ID info.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareAzureImage", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareCertifiedHardwareStatus": { "type": "object", "description": "Current status of Certified Hardware.", "title": "Certified Hardware Status", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.certified_hardware.CertifiedHardwareStatus", "properties": { "latest_version": { "type": "string", "description": "Latest version for the certified hardware.", "title": "Latest Version", "x-displayname": "Latest Version.", "x-f5xc-description-short": "Latest version for the certified hardware.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 certified_hardwareCertifiedHardwareStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareDeviceType": { "type": "object", "description": "Different type of devices supported by Certified Hardware.", "title": "Device Type", "x-displayname": "Device", "x-ves-proto-message": "ves.io.schema.certified_hardware.DeviceType", "properties": { "device_list": { "type": "array", "description": "In case of logical boot strap devices like LACP Link aggregation or RAID.", "title": "Device List", "items": { "type": "string" }, "x-displayname": "Device List.", "x-f5xc-description-short": "In case of logical boot strap devices like LACP Link aggregation or RAID.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "max_unit": { "type": "integer", "description": "Last unit number of the device supported in this certified hardware.", "title": "End unit number for device", "format": "int32", "x-displayname": "End Unit", "x-ves-example": "7", "x-f5xc-example": "7", "x-f5xc-description-short": "Last unit number of the device supported in this certified hardware.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "min_unit": { "type": "integer", "description": "First unit number of the device supported in this certified hardware.", "title": "Start unit number for device", "format": "int32", "x-displayname": "Start Unit.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "First unit number of the device supported in this certified hardware.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the device.", "title": "Name", "x-displayname": "Device", "x-ves-example": "Eth", "x-f5xc-example": "eth", "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])?$" }, "type": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareHardwareDeviceType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareHardwareDeviceInstanceUseType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Different type of devices supported by Certified Hardware.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareDeviceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareGcp": { "type": "object", "description": "GCP specific information.", "title": "GCP", "x-displayname": "GCP", "x-ves-oneof-field-image": "[\"image_id\"]", "x-ves-proto-message": "ves.io.schema.certified_hardware.Gcp", "properties": { "image_id": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareGcpImage" } ], "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 certified_hardwareGcp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareGcpImage": { "type": "object", "x-ves-proto-message": "ves.io.schema.certified_hardware.GcpImage", "properties": { "image_id": { "type": "string", "description": "GCP image", "title": "ImageId", "x-displayname": "GCP image 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 }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareGcpImage", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read certified_hardware", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.certified_hardware.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/schemacertified_hardwareGetSpecType" } ], "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/certified_hardwareStatusObject" }, "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 certified_hardwareGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareHardwareDeviceInstanceUseType": { "type": "string", "description": "Defines how the device instance must be used\n\nIf the device is owned by F5 Distributed Cloud software, it is available for users to configure as required\nDevice reserved for internal use by F5 Distributed Cloud Node\nIf the Network device is owned by VER, it is available for users to configure as required\nNetworking device available for internal use by VER\nNetworking device to be used for Management access\nNetworking device to be used as member of outside network as part of bootstrap\nNetworking device to be used as member of inside network as part of bootstrap\nLAG device to be used as member of outside network\nLAG device to be used as member of inside network\nNetwork device to be used as member of another LAG device\nNetwork device to be used exclusive for storage networks\nNetworking device to be used for fallback Management access.", "title": "Hardware Device Instance Use", "enum": [ "HARDWARE_DEVICE_USE_REGULAR", "HARDWARE_DEVICE_USE_INTERNAL", "HARDWARE_NETWORK_DEVICE_USE_REGULAR", "HARDWARE_NETWORK_DEVICE_USE_INTERNAL", "HARDWARE_NETWORK_DEVICE_USE_MANAGEMENT", "HARDWARE_NETWORK_DEVICE_USE_OUTSIDE", "HARDWARE_NETWORK_DEVICE_USE_INSIDE", "HARDWARE_NETWORK_DEVICE_USE_OUTSIDE_LAG", "HARDWARE_NETWORK_DEVICE_USE_INSIDE_LAG", "HARDWARE_NETWORK_DEVICE_USE_LAG_MEMBER", "HARDWARE_NETWORK_DEVICE_USE_STORAGE", "HARDWARE_NETWORK_DEVICE_USE_FALLBACK_MANAGEMENT" ], "default": "HARDWARE_DEVICE_USE_REGULAR", "x-displayname": "Device Use.", "x-ves-proto-enum": "ves.io.schema.certified_hardware.HardwareDeviceInstanceUseType", "x-f5xc-description-short": "Defines how the device instance must be used If the device is owned by F5 Distributed Cloud software, it is available for users to configure as...", "x-f5xc-description-medium": "Defines how the device instance must be used If the device is owned by F5 Distributed Cloud software, it is available for users to configure as required Device reserved for internal use by F5 Distributed Cloud Node If the Network device is owned by VER, it is available for users to configure as...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareHardwareDeviceInstanceUseType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HARDWARE_DEVICE_USE_REGULAR\"", "example_yaml": "HARDWARE_DEVICE_USE_REGULAR\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareHardwareDeviceType": { "type": "string", "description": "Different type of devices supported\n\nInvalid device or device that's not supported\nEthernet device\nVIRTIO device\nTUNTAP device\nLACP based bond interface\nExternal iSCSI devices supported\nNvidia GPU device used for machine learning.", "title": "Hardware Device Types", "enum": [ "HARDWARE_DEVICE_INVALID", "HARDWARE_DEVICE_ETHERNET", "HARDWARE_DEVICE_VIRTIO", "HARDWARE_DEVICE_TUNTAP", "HARDWARE_DEVICE_BOND", "HARDWARE_DEVICE_EXTERNAL_ISCSI_STORTAGE", "HARDWARE_DEVICE_NVIDIA_GPU" ], "default": "HARDWARE_DEVICE_INVALID", "x-displayname": "Device Types.", "x-ves-proto-enum": "ves.io.schema.certified_hardware.HardwareDeviceType", "x-f5xc-description-short": "Different type of devices supported Invalid device or device that's not supported Ethernet device VIRTIO device TUNTAP device LACP based bond...", "x-f5xc-description-medium": "Different type of devices supported Invalid device or device that's not supported Ethernet device VIRTIO device TUNTAP device LACP based bond interface External iSCSI devices supported Nvidia GPU device used for machine learning.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareHardwareDeviceType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HARDWARE_DEVICE_INVALID\"", "example_yaml": "HARDWARE_DEVICE_INVALID\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareHardwareType": { "type": "string", "description": "Different type of certified HW for billing rate.", "title": "Certified Hardware Types", "enum": [ "VOLTMESH", "VOLTSTACK_COMBO", "CLOUD_MARKET_PLACE" ], "default": "VOLTMESH", "x-displayname": "Certified Hardware Types.", "x-ves-proto-enum": "ves.io.schema.certified_hardware.HardwareType", "x-f5xc-description-short": "Different type of certified HW for billing rate.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareHardwareType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"VOLTMESH\"", "example_yaml": "VOLTMESH\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareHardwareVendorModel": { "type": "object", "description": "Gives vendor and model for the hardware device.", "title": "Vendor and Model", "x-displayname": "Vendor and Model.", "x-ves-proto-message": "ves.io.schema.certified_hardware.HardwareVendorModel", "properties": { "model": { "type": "string", "description": "Hw Model or instance type from cloud provider like number of interfaces, vCPUs, memory.", "title": "Model", "x-displayname": "Model", "x-f5xc-description-short": "Hw Model or instance type from cloud provider like number of interfaces, vCPUs, memory.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor": { "type": "string", "description": "Vendor could be F5 Distributed Cloud, Dell, Cloud provider like AWS or Azure.", "title": "Vendor", "x-displayname": "Vendor", "x-f5xc-description-short": "Vendor could be F5 Distributed Cloud, Dell, Cloud provider like AWS or Azure.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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": "Gives vendor and model for the hardware device.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareHardwareVendorModel", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareImageType": { "type": "object", "description": "Describes the image to be used for this certified hardware.", "title": "Image Type", "x-displayname": "Image Type.", "x-ves-oneof-field-cloud_provider": "[\"aws\",\"azure\",\"gcp\"]", "x-ves-proto-message": "ves.io.schema.certified_hardware.ImageType", "properties": { "aws": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareAws" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "azure", "gcp" ] }, "azure": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareAzure" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "gcp" ] }, "gcp": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareGcp" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws", "azure" ] }, "name": { "type": "string", "description": "Image name to use for this hardware.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Ami-0f99d090261d2acd5.", "x-f5xc-example": "ami-0f99d090261d2acd5", "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])?$" }, "provider": { "type": "string", "description": "Image provider F5 Distributed Cloud, Cloud provider like AWS or Azure.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "F5 Distributed Cloud.", "x-f5xc-example": "F5 Distributed Cloud", "x-f5xc-description-short": "Image provider F5 Distributed Cloud, Cloud provider like AWS or Azure.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Describes the image to be used for this certified hardware.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareImageType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of certified_hardware", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.certified_hardware.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/certified_hardwareListResponseItem" }, "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 certified_hardwareListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareListResponseItem": { "type": "object", "description": "By default a summary of certified_hardware 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 certified_hardware", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.certified_hardware.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this certified_hardware.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this certified_hardware.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this certified_hardware.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this certified_hardware.", "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 certified_hardware is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates certified_hardware is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemacertified_hardwareGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this certified_hardware.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this certified_hardware.", "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 certified_hardware.", "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/certified_hardwareStatusObject" }, "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 certified_hardware.", "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 certified_hardware.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 certified_hardware 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 certified_hardware 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 certified_hardwareListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareMarketplace": { "type": "object", "description": "Azure Marketplace image information.", "title": "Marketplace", "x-displayname": "Azure Marketplace image info.", "x-ves-proto-message": "ves.io.schema.certified_hardware.Marketplace", "properties": { "name": { "type": "string", "description": "Azure Marketplace Name.", "title": "Name", "x-displayname": "Azure Marketplace Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "offer": { "type": "string", "description": "Azure Marketplace offer.", "title": "Offer", "x-displayname": "Azure Marketplace offer.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "publisher": { "type": "string", "description": "Azure Marketplace Publisher.", "title": "Publisher", "x-displayname": "Azure Marketplace Publisher.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sku": { "type": "string", "description": "Azure Marketplace SKU.", "title": "SKU", "x-displayname": "Azure Marketplace SKU.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "version": { "type": "string", "description": "Azure Marketplace Version.", "title": "Version", "x-displayname": "Azure Marketplace Version.", "x-f5xc-example": "v1.2.3", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareMarketplace", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareMemPageSize": { "type": "string", "description": "Memory for packets buffers etc are allocated in blocks of pages. Size of each memory page is defined here.\n\nInvalid Page size\nPage size of 4KB\nPage size of 2MB\nPage size of 1GB.", "title": "Memory Page Size", "enum": [ "HARDWARE_MEM_PAGE_SIZE_INVALID", "HARDWARE_MEM_PAGE_SIZE_4KB", "HARDWARE_MEM_PAGE_SIZE_2MB", "HARDWARE_MEM_PAGE_SIZE_1GB" ], "default": "HARDWARE_MEM_PAGE_SIZE_INVALID", "x-displayname": "Memory Page Size.", "x-ves-proto-enum": "ves.io.schema.certified_hardware.MemPageSize", "x-f5xc-description-short": "Memory for packets buffers etc are allocated in blocks of pages. Size of each memory page is defined here.", "x-f5xc-description-medium": "Memory for packets buffers etc are allocated in blocks of pages. Size of each memory page is defined here. Invalid Page size Page size of 4KB Page size of 2MB Page size of 1GB.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareMemPageSize", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HARDWARE_MEM_PAGE_SIZE_INVALID\"", "example_yaml": "HARDWARE_MEM_PAGE_SIZE_INVALID\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareNumaMem": { "type": "object", "description": "Defines amount of memory (in MB) allocated for a NUMA node.", "title": "NUMA Memory Specification", "x-displayname": "NUMA Memory Specification.", "x-ves-proto-message": "ves.io.schema.certified_hardware.NumaMem", "properties": { "memory": { "type": "integer", "description": "The number of MB of instance memory to map to instance NUMA node N.", "title": "Memory Size", "format": "int32", "x-displayname": "Memory Size.", "x-ves-example": "1024", "x-f5xc-example": "1024", "x-f5xc-description-short": "The number of MB of instance memory to map to instance NUMA node N.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "type": "integer", "description": "NUMA node instance with mapped memory.", "title": "Node", "format": "int32", "x-displayname": "Node", "x-ves-example": "1", "x-f5xc-example": "1", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines amount of memory (in MB) allocated for a NUMA node.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareNumaMem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "certified_hardwareStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Certified Hardware Status", "x-displayname": "Status Object.", "x-ves-proto-message": "ves.io.schema.certified_hardware.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various components of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various components of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareCertifiedHardwareStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certified_hardwareStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ioschemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemacertified_hardwareGetSpecType": { "type": "object", "description": "GET Certified Hardware object.", "title": "Get certified hardware", "x-displayname": "GET Certified Hardware.", "x-ves-proto-message": "ves.io.schema.certified_hardware.GetSpecType", "properties": { "certified_hardware_type": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareHardwareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "devices": { "type": "array", "description": "List of supported devices in this model.", "items": { "$ref": "#/components/schemas/certified_hardwareDeviceType" }, "x-displayname": "Devices", "x-f5xc-description-short": "List of supported devices in this model.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "image_list": { "type": "array", "description": "List of image names with providers for this certified hardware, e.g. AWS ami-0f99d090261d2acd5.", "items": { "$ref": "#/components/schemas/certified_hardwareImageType" }, "x-displayname": "Image List.", "x-f5xc-description-short": "List of image names with providers for this certified hardware, e.g. AWS ami-0f99d090261d2acd5.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "internal_usb_device_rule": { "type": "array", "description": "List of internal USB device rules for server.", "items": { "$ref": "#/components/schemas/usb_policyRule" }, "x-displayname": "Internal USB device rules.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of internal USB device rules for server.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mem_page_number": { "type": "integer", "description": "Number of pages allocated in this certified hardware for Hugepages. Each page size is defined above in 'mem_page_size'\nTotal memory reserved for Hugepages is 'mem_page_size * mem_page_number'", "format": "int32", "x-displayname": "Number of pages.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "Number of pages allocated in this certified hardware for Hugepages.", "x-f5xc-description-medium": "Number of pages allocated in this certified hardware for Hugepages. Each page size is defined above in 'mem_page_size' Total memory reserved for Hugepages is 'mem_page_size * mem_page_number'.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mem_page_size": { "allOf": [ { "$ref": "#/components/schemas/certified_hardwareMemPageSize" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numa_mem": { "type": "array", "description": "List of Numa nodes with the number of MB of instance memory to map to node instance\nIf not specified, memory is evenly divided among available NUMA nodes.", "items": { "$ref": "#/components/schemas/certified_hardwareNumaMem" }, "x-displayname": "NUMA Memory.", "x-f5xc-description-short": "List of Numa nodes with the number of MB of instance memory to map to node instance If not specified, memory is evenly divided among available...", "x-f5xc-description-medium": "List of Numa nodes with the number of MB of instance memory to map to node instance If not specified, memory is evenly divided among available NUMA nodes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "numa_nodes": { "type": "integer", "description": "The number of host NUMA nodes used in certified hardware.", "format": "int32", "x-displayname": "NUMA Node Count.", "x-ves-example": "2", "x-f5xc-example": "2", "x-f5xc-description-short": "The number of host NUMA nodes used in certified hardware.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vendor_model_list": { "type": "array", "description": "List of supported hardware vendor and model for this certified hardware.", "items": { "$ref": "#/components/schemas/certified_hardwareHardwareVendorModel" }, "x-displayname": "Vendor and Model.", "x-f5xc-description-short": "List of supported hardware vendor and model for this certified hardware.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemacertified_hardwareGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "usb_policyRule": { "type": "object", "description": "USB Enablement Rule.", "title": "Rule", "x-displayname": "USB Enablement Rule.", "x-ves-proto-message": "ves.io.schema.usb_policy.Rule", "properties": { "b_device_class": { "type": "string", "description": "The class of this device.", "title": "b_device_class", "x-displayname": "Class", "x-ves-example": "Hub", "x-f5xc-example": "hub", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_device_protocol": { "type": "string", "description": "The protocol (within the sub-class) of this device.", "title": "b_device_protocol", "x-displayname": "Protocol", "x-ves-example": "0002", "x-f5xc-example": "0002", "x-f5xc-description-short": "The protocol (within the sub-class) of this device.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "b_device_sub_class": { "type": "string", "description": "The sub-class (within the class) of this device.", "title": "b_device_sub_class", "x-displayname": "Subclass", "x-ves-example": "Hub", "x-f5xc-example": "hub", "x-f5xc-description-short": "The sub-class (within the class) of this device.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "i_serial": { "type": "string", "description": "Index of Serial Number String Descriptor.", "title": "i_serial_number", "x-displayname": "ISerialNumber.", "x-ves-example": "0000:00:14.0.", "x-f5xc-example": "0000:00:14.0", "x-f5xc-description-short": "Index of Serial Number String Descriptor.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id_product": { "type": "string", "description": "Product ID (Assigned by Manufacturer) in hex.", "title": "id_product", "x-displayname": "Product ID.", "x-ves-example": "0x0002", "x-f5xc-example": "0x0002", "x-f5xc-description-short": "Product ID (Assigned by Manufacturer) in hex.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id_vendor": { "type": "string", "description": "Vendor ID (Assigned by USB Org) in hex.", "title": "id_vendor", "x-displayname": "Vendor ID", "x-ves-example": "0x1d6b", "x-f5xc-example": "0x1d6b", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 usb_policyRule", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ce_management", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "cloud_connectAWSAttachmentsListStatusType__ves_io_schema_cloud_connect": { "type": "object", "description": "AWS VPC Attachment List Status Type.", "title": "AWS VPC Attachment List Status Type", "x-displayname": "AWS VPC Attachment List Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSAttachmentsListStatusType", "properties": { "attachment_status": { "type": "array", "description": "AWS Attachment Status Type.", "title": "AWS VPC Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSAttachmentsStatusType" }, "x-displayname": "AWS VPC Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_attachment_status": { "type": "array", "description": "AWS Connect Attachment Status Type.", "title": "AWS Connect Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSConnectAttachmentStatusType" }, "x-displayname": "AWS Connect Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_route_table_status": { "type": "array", "description": "AWS Transit Gateway Route Table Status Type.", "title": "AWS Transit Gateway Route Table Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWRouteTableStatusType" }, "x-displayname": "AWS Transit Gateway Route Table Status.", "x-f5xc-description-short": "AWS Transit Gateway Route Table Status Type.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSTGWStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_resource_share_status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceShareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSAttachmentsListStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSAttachmentsStatusType": { "type": "object", "description": "AWS Attachment Status Type.", "title": "AWS VPC Attachment Status Type", "x-displayname": "AWS Attachment Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSAttachmentsStatusType", "properties": { "association_route_table_id": { "type": "string", "description": "Association route table ID.", "title": "Association route table ID", "x-displayname": "Associated Transit Gateway route table 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" }, "association_state": { "type": "string", "description": "Transit Gateway route table association state.", "title": "Association state", "x-displayname": "Transit Gateway route table association state.", "x-f5xc-description-short": "Transit Gateway route table association state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "creation_time": { "type": "string", "description": "Attachment Creation Time.", "title": "Attachment Creation Time", "format": "date-time", "x-displayname": "Attachment Creation Time.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional VPC attachment deployment status.", "title": "Additional VPC attachment deployment status", "x-displayname": "VPC attachment deployment status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional VPC attachment deployment 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 } }, "installed_routes": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSRouteTableListType" } ], "x-f5xc-description-short": "Configuration parameter for installed routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subnets": { "type": "array", "description": "Network Interfaces created along with the attachment.", "title": "Subnets", "items": { "$ref": "#/components/schemas/cloud_connectSubnetStatusType" }, "x-displayname": "Network Interfaces.", "x-f5xc-description-short": "Network Interfaces created along with the attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_attachment_id": { "type": "string", "description": "TGW Attachment ID.", "title": "TGW Attachment ID", "x-displayname": "TGW Attachment 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" }, "tgw_attachment_name": { "type": "string", "description": "TGW Attachment Name.", "title": "TGW Attachment Name", "x-displayname": "TGW Attachment Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_cidr": { "type": "string", "description": "VPC CIDR", "title": "VPC CIDR", "x-displayname": "VPC CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC 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" }, "vpc_name": { "type": "string", "description": "VPC Name", "title": "VPC Name", "x-displayname": "VPC Name", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vpc_owner_id": { "type": "string", "description": "VPC Owner Account.", "title": "VPC Owner Account", "x-displayname": "VPC Owner Account.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSAttachmentsStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSConnectAttachmentStatusType": { "type": "object", "description": "AWS Connect Attachment Status Type.", "title": "AWS Connect Attachment Status Type", "x-displayname": "AWS Connect Attachment Type Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSConnectAttachmentStatusType", "properties": { "association_route_table_id": { "type": "string", "description": "Association route table ID.", "title": "Association route table ID", "x-displayname": "Association route table 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" }, "association_state": { "type": "string", "description": "Transit Gateway route table association state.", "title": "Association state", "x-displayname": "Transit Gateway route table association state.", "x-f5xc-description-short": "Transit Gateway route table association state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional information related to the connect attachment deployment.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the connect attachment deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "f5xc_site_asn": { "type": "string", "description": "F5XC Site ASN.", "title": "F5XC Site ASN", "x-displayname": "F5XC Site ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peers": { "type": "array", "description": "Connect Peers.", "title": "Connect Peers", "items": { "$ref": "#/components/schemas/cloud_connectAWSConnectPeerStatusType" }, "x-displayname": "Connect Peers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol": { "type": "string", "description": "Connect protocol.", "title": "Connect protocol", "x-displayname": "Connect protocol.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_asn": { "type": "string", "description": "Transit Gateway ASN.", "title": "Transit Gateway ASN", "x-displayname": "Transit Gateway ASN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_attachment_id": { "type": "string", "description": "Transit Gateway Attachment ID.", "title": "Transit Gateway Attachment ID", "x-displayname": "Transit Gateway Attachment 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" }, "transit_gateway_attachment_name": { "type": "string", "description": "Transit Gateway Attachment Name.", "title": "Transit Gateway Attachment Name", "x-displayname": "Transit Gateway Attachment Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway 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" }, "transport_attachment_id": { "type": "string", "description": "Transport attachment ID.", "title": "Transport attachment ID", "x-displayname": "Transport attachment 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" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSConnectAttachmentStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSConnectPeerStatusType": { "type": "object", "description": "AWS Connect Peer Status Type.", "title": "AWS Connect Peer Status Type", "x-displayname": "AWS Connect Peer Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSConnectPeerStatusType", "properties": { "connect_attachment_id": { "type": "string", "description": "Connect attachment ID.", "title": "Connect attachment ID", "x-displayname": "Connect attachment 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" }, "connect_peer_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_peer_id": { "type": "string", "description": "Connect Peer ID.", "title": "Connect Peer ID", "x-displayname": "Connect Peer 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" }, "deployment_status": { "type": "string", "description": "Additional information related to the connect peer attachment deployment.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the connect peer attachment deployment.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Connect Peer Name.", "title": "Connect Peer Name", "x-displayname": "Connect Peer Name.", "x-f5xc-example": "example-resource", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "peer_gre_address": { "type": "string", "title": "Peer GRE Address", "x-displayname": "Peer GRE Address.", "description": "Network address or location", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Connect Peer Tags.", "title": "Connect Peer Tags", "x-displayname": "Connect Peer Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_gre_address": { "type": "string", "title": "Transit Gateway GRE Address", "x-displayname": "Transit Gateway GRE Address.", "description": "Network address or location", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 cloud_connectAWSConnectPeerStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSDefaultRoutesRouteTable": { "type": "object", "description": "AWS Route Table.", "title": "AWS Route Table", "x-displayname": "AWS Route Table.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSDefaultRoutesRouteTable", "properties": { "route_table_id": { "type": "array", "description": "Route table ID.", "title": "Route table ID", "items": { "type": "string", "maxLength": 64 }, "x-displayname": "Route table ID.", "x-ves-example": "Rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "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-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSDefaultRoutesRouteTable", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSProviderType": { "type": "object", "description": "Cloud Connect with AWS.", "title": "Cloud Connect with AWS", "x-displayname": "AWS", "x-ves-oneof-field-site_type": "[\"aws_tgw_site\",\"securemesh_site_v2\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSProviderType", "properties": { "aws_tgw_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSTGWSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "securemesh_site_v2" ] }, "securemesh_site_v2": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSSecureMeshSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aws_tgw_site" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSRouteTableListType": { "type": "object", "description": "AWS Route Table List.", "title": "AWS Route Table List", "x-displayname": "AWS Route Table List.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSRouteTableListType", "properties": { "route_tables": { "type": "array", "description": "Route Tables.", "title": "List of route tables", "minItems": 1, "maxItems": 200, "items": { "$ref": "#/components/schemas/cloud_connectAWSRouteTableType" }, "x-displayname": "List of route tables.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "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": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 200, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSRouteTableListType", "required_fields": [ "route_tables" ], "mutually_exclusive_groups": [], "example_json": "{\n \"route_tables\": [\n {\n \"static_routes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "route_tables:\n- static_routes:\n - value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSRouteTableType": { "type": "object", "description": "AWS Route Table.", "title": "AWS Route Table", "x-displayname": "AWS Route Table.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSRouteTableType", "properties": { "route_table_id": { "type": "string", "description": "Route table ID.", "title": "Route table ID", "maxLength": 64, "x-displayname": "Route table ID.", "x-ves-example": "Rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-example": "rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "64", "ves.io.schema.rules.string.pattern": "^(rtb-)([a-z0-9]{8}|[a-z0-9]{17})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "pattern": "^(rtb-)([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": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "static_routes": { "type": "array", "description": "List of Static Routes.", "title": "static_routes", "minItems": 1, "maxItems": 50, "items": { "type": "string" }, "x-displayname": "Static Routes.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 50, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSRouteTableType", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n \"value\"\n ]\n}", "example_yaml": "static_routes:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSSecureMeshSiteStatusType": { "type": "object", "title": "Cloud Connect Attached to AWS SecureMesh Site v2", "x-displayname": "Cloud Connect to AWS Secure Mesh Site v2.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSSecureMeshSiteStatusType", "properties": { "attachment_status": { "type": "array", "title": "VPC Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSAttachmentsStatusType" }, "x-displayname": "VPC Attachment Status.", "description": "Status or state information", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "connect_attachment_status": { "type": "array", "title": "Connect Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSConnectAttachmentStatusType" }, "x-displayname": "Connect Attachment Status.", "description": "Status or state information", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_route_table_status": { "type": "array", "title": "Transit Gateway Route Table Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWRouteTableStatusType" }, "x-displayname": "Transit Gateway Route Table Status.", "description": "Status or state information", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSTGWStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_resource_share_status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceShareType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSSecureMeshSiteStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSSecureMeshSiteType": { "type": "object", "description": "Cloud Connect AWS Secure Mesh Site Type.", "title": "Cloud Connect AWS Secure Mesh Site Type", "x-displayname": "AWS Secure Mesh Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSSecureMeshSiteType", "properties": { "cloud_user_account_ref": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for cloud user account ref.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "cloud_user_account_ref", "gated_by": null, "required": false, "cardinality": "single" } ] }, "peers": { "type": "array", "description": "Configuration parameter for peers", "title": "Peers", "items": { "$ref": "#/components/schemas/cloud_connectPeerType" }, "x-displayname": "Peers", "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" } ] }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Cloud Connect AWS Secure Mesh Site Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSSecureMeshSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWResourceReference": { "type": "object", "description": "AWS Transit Gateway Route Table Associations.", "title": "AWS Transit Gateway Route Table Associations", "x-displayname": "AWS Transit Gateway Route Table Associations.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWResourceReference", "properties": { "attachment_id": { "type": "string", "description": "Attachment ID.", "title": "Attachment ID", "x-displayname": "Attachment 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" }, "deployment_status": { "type": "string", "description": "Additional information related to the TGW routing.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the TGW routing.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_id": { "type": "string", "description": "Resource ID.", "title": "Resource ID", "x-displayname": "Resource ID.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_type": { "type": "string", "description": "Resource type.", "title": "Resource type", "x-displayname": "Resource type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "running", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AWS Transit Gateway Route Table Associations.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWResourceReference", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWResourceShareType": { "type": "object", "description": "AWS Resource Share Status Type.", "title": "AWS Resource Share Status Type", "x-displayname": "AWS Resource Share Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWResourceShareType", "properties": { "allow_external_principles": { "type": "boolean", "description": "Manage Sharing Outside AWS Organization.", "title": "Allow External Principles", "format": "boolean", "x-displayname": "Allow External Principles.", "x-f5xc-description-short": "Manage Sharing Outside AWS Organization.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Attachment Deployment Status.", "title": "Attachment Deployment Status", "x-displayname": "Attachment Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_account_id": { "type": "string", "description": "Resource Share Owner Account ID.", "title": "Resource Share Owner Account ID", "x-displayname": "Resource Share Owner Account 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" }, "receiver_account_id": { "type": "array", "description": "Resource Share Acceptor Account ID.", "title": "Resource Share Acceptor Account ID", "items": { "type": "string" }, "x-displayname": "Resource Share Acceptor Account ID.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "resource_share_arn": { "type": "string", "description": "Resource Share ARN.", "title": "Resource Share ARN", "x-displayname": "Resource Share ARN.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_share_name": { "type": "string", "description": "Resource Share Name.", "title": "Resource Share Name", "x-displayname": "Resource Share Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Resource Share State.", "title": "Resource Share State", "x-displayname": "Resource Share State.", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tags": { "type": "object", "description": "Resource Share Tags.", "title": "Resource Share Tags", "x-displayname": "Resource Share Tags.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway 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" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWResourceShareType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWRouteTableStatusType": { "type": "object", "description": "AWS Transit Gateway Route Table Status Type.", "title": "AWS Transit Gateway Route Table Status Type", "x-displayname": "AWS Transit Gateway Route Table Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWRouteTableStatusType", "properties": { "associations": { "type": "array", "description": "Associations.", "title": "Associations", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceReference" }, "x-displayname": "Associations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deployment_status": { "type": "string", "description": "Additional information related to the TGW routing.", "title": "Deployment Status", "x-displayname": "Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Additional information related to the TGW routing.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagations": { "type": "array", "description": "Propagations.", "title": "Propagations", "items": { "$ref": "#/components/schemas/cloud_connectAWSTGWResourceReference" }, "x-displayname": "Propagations.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tgw_rt_deployment_state": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectVPCStateType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transit_gateway_id": { "type": "string", "description": "Transit Gateway ID.", "title": "Transit Gateway ID", "x-displayname": "Transit Gateway 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" }, "transit_gateway_route_table_id": { "type": "string", "description": "Transit gateway route table ID.", "title": "Transit gateway route table ID", "x-displayname": "Transit gateway route table 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" }, "transit_gateway_route_table_name": { "type": "string", "description": "Transit gateway route table Name.", "title": "Transit gateway route table Name", "x-displayname": "Transit gateway route table Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "AWS Transit Gateway Route Table Status Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWRouteTableStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWSiteType": { "type": "object", "description": "Cloud Connect AWS TGW Site Type.", "title": "Cloud Connect AWS TGW Site Type", "x-displayname": "AWS TGW Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWSiteType", "properties": { "cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cred", "gated_by": null, "required": false, "cardinality": "single" } ] }, "peers": { "type": "array", "description": "Configuration parameter for peers", "title": "Peers", "items": { "$ref": "#/components/schemas/cloud_connectPeerType" }, "x-displayname": "Peers", "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" } ] }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSTGWSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSTGWStatusType": { "type": "object", "description": "AWS Transit Gateway Status Type.", "title": "AWS Transit Gateway Status Type", "x-displayname": "AWS Transit Gateway Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSTGWStatusType", "properties": { "amazon_asn": { "type": "string", "description": "AWS Side ASN of TGW.", "title": "AWS Side ASN of TGW", "format": "int64", "x-displayname": "AWS Side ASN.", "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 } }, "arn": { "type": "string", "description": "TGW ARN", "title": "TGW ARN", "x-displayname": "ARN", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "identifier", "maxLength": 1024, "minLength": 1, "pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-z0-9-/]+$", "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "association_default_route_table_id": { "type": "string", "description": "X-displayName \"Default Association Route Table ID\"\nAssociationDefaultRouteTableId.", "title": "AssociationDefaultRouteTableId", "x-f5xc-description-short": "X-displayName \"Default Association Route Table ID\" AssociationDefaultRouteTableId.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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" }, "auto_accept_shared_attachments": { "type": "boolean", "description": "X-displayName \"Auto Accept Shared Attachments\"\nAutoAcceptSharedAttachments.", "title": "AutoAcceptSharedAttachments", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Auto Accept Shared Attachments\" AutoAcceptSharedAttachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cidrs": { "type": "array", "description": "X-displayName \"CIDRs\"\nTGW CIDRs.", "title": "TGW CIDRs", "items": { "type": "string" }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_route_table_association": { "type": "boolean", "description": "X-displayName \"Default Route Table Association\"\nDefaultRouteTableAssociation.", "title": "DefaultRouteTableAssociation", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Default Route Table Association\" DefaultRouteTableAssociation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "default_route_table_propagation": { "type": "boolean", "description": "X-displayName \"Default Route Table Propagation\"\nDefaultRouteTablePropagation.", "title": "DefaultRouteTablePropagation", "format": "boolean", "x-f5xc-description-short": "X-displayName \"Default Route Table Propagation\" DefaultRouteTablePropagation.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "TGW ID", "title": "TGW ID", "x-displayname": "ID", "x-f5xc-example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "owner_account": { "type": "string", "description": "TGW Owner Account.", "title": "TGW Owner", "x-displayname": "Owner Account.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "propagation_default_route_table_id": { "type": "string", "description": "X-displayName \"Default Propagation Route Table ID\"\nPropagationDefaultRouteTableId.", "title": "PropagationDefaultRouteTableId", "x-f5xc-description-short": "X-displayName \"Default Propagation Route Table ID\" PropagationDefaultRouteTableId.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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" }, "region": { "type": "string", "description": "TGW Region.", "title": "TGW Region", "x-displayname": "Region", "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": false, "create": false, "update": false, "read": false } }, "state": { "type": "string", "description": "TGW State", "title": "TGW State", "x-displayname": "State", "x-f5xc-example": "running", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_msg": { "type": "string", "description": "X-displayName \"Deployment Status\"\nTGW Deployment Status.", "title": "TGW Deployment Status", "x-f5xc-description-short": "X-displayName \"Deployment Status\" TGW Deployment 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 } }, "tags": { "type": "object", "description": "TGW Tags", "title": "TGW Tags", "x-displayname": "Tags", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "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 cloud_connectAWSTGWStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSVPCAttachmentListType": { "type": "object", "title": "VPC Attachments", "x-displayname": "VPC Attachments.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSVPCAttachmentListType", "properties": { "vpc_list": { "type": "array", "description": "Collection of items or values", "title": "vpc_list", "maxItems": 128, "items": { "$ref": "#/components/schemas/cloud_connectAWSVPCAttachmentType" }, "x-displayname": "VPC List", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAWSVPCAttachmentListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAWSVPCAttachmentType": { "type": "object", "title": "AWS VPC attachment", "x-displayname": "VPC Attachment.", "x-ves-oneof-field-routing_choice": "[\"custom_routing\",\"default_route\",\"manual_routing\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.AWSVPCAttachmentType", "properties": { "custom_routing": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSRouteTableListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_route", "manual_routing" ] }, "default_route": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectDefaultRoute" } ], "x-f5xc-description-short": "Configuration parameter for default route.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_routing", "manual_routing" ] }, "labels": { "type": "object", "description": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "title": "Labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "x-f5xc-description-medium": "Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_routing", "default_route" ] }, "vpc_id": { "type": "string", "description": "Enter the VPC ID of the VPC to be attached.", "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-description-short": "Enter the VPC ID of the VPC to be attached.", "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 cloud_connectAWSVPCAttachmentType", "required_fields": [ "vpc_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"vpc_id\": \"vpc-12345678901234567\"\n}", "example_yaml": "vpc_id: vpc-12345678901234567" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureAttachmentsListStatusType": { "type": "object", "description": "Azure VEspokeNT Attachment List Status Type.", "title": "Azure spoke Attachment List Status Type", "x-displayname": "Azure spoke Attachment List Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureAttachmentsListStatusType", "properties": { "attachment_status": { "type": "array", "description": "Azure spoke Attachment Status Type.", "title": "Azure spoke Attachment Status Type", "items": { "$ref": "#/components/schemas/cloud_connectAzureAttachmentsStatusType" }, "x-displayname": "Azure spoke Attachment Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Azure VEspokeNT Attachment List Status Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureAttachmentsListStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureAttachmentsStatusType": { "type": "object", "description": "Azure Attachment Status Type.", "title": "Azure Attachment Status Type", "x-displayname": "Azure Attachment Status Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureAttachmentsStatusType", "properties": { "deployment_status": { "type": "string", "description": "Attachment Deployment Status.", "title": "Attachment Deployment Status", "x-displayname": "Attachment Deployment Status.", "x-f5xc-example": "{\"key\": \"value\"}", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_owner_subscriptionid": { "type": "string", "description": "Hub Owner Subscription.", "title": "Hub Owner subscription", "x-displayname": "Hub Owner Subscription.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_vnet_name": { "type": "string", "description": "Hub VNet Name.", "title": "Hub VNET Name", "x-displayname": "Hub VNet Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "hub_vnet_resource_group": { "type": "string", "description": "Hub VNet Resource Group.", "title": "Hub VNET Resource Group", "x-displayname": "Hub VNet Resource Group.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "installed_routes": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureRouteTableWithStaticRouteListType" } ], "x-f5xc-description-short": "Configuration parameter for installed routes.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_state": { "type": "string", "description": "Hub VNet Peering state.", "title": "Hub VNET Peering state", "x-displayname": "Hub VNet Peering state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peering_sync_level": { "type": "string", "description": "Hub VNet peering sync level.", "title": "Hub VNET peering sync level", "x-displayname": "Hub VNet peering sync level.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "provisioning_state": { "type": "string", "description": "Hub VNet Provisioning state.", "title": "Hub VNET Provisioning state", "x-displayname": "Hub VNet Provisioning state.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spoke_subscription_id": { "type": "string", "description": "VNet Subscription.", "title": "VNET subscription", "x-displayname": "VNet Subscription.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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" }, "spoke_vnet_id": { "type": "string", "description": "Spoke VNet ID.", "title": "Spoke VNET ID", "x-displayname": "Spoke VNet 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" }, "subnets": { "type": "array", "description": "Network Interfaces created along with the attachment.", "title": "Subnets", "items": { "$ref": "#/components/schemas/cloud_connectSubnetStatusType" }, "x-displayname": "Network Interfaces.", "x-f5xc-description-short": "Network Interfaces created along with the attachment.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tags": { "type": "object", "description": "Attachment Tags.", "title": "Attachment Tags", "x-displayname": "Attachment Tags.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "127", "ves.io.schema.rules.map.max_pairs": "20", "ves.io.schema.rules.map.values.string.max_len": "255" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vnet_attachment_id": { "type": "string", "description": "VNet Attachment ID.", "title": "VNET Attachment ID", "x-displayname": "VNet Attachment 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" }, "vnet_cidr": { "type": "string", "description": "VNet CIDR", "title": "VNET CIDR", "x-displayname": "VNet CIDR", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 cloud_connectAzureAttachmentsStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureDefaultRoute": { "type": "object", "description": "Select Override Default Route Choice.", "title": "Default Route Override Choice", "x-displayname": "Override Default Route Choice.", "x-ves-oneof-field-default_route_choice": "[\"all_route_tables\",\"selective_route_tables\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureDefaultRoute", "properties": { "all_route_tables": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for all route tables.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "selective_route_tables" ] }, "selective_route_tables": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureRouteTables" } ], "x-f5xc-description-short": "Configuration parameter for selective route tables.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_route_tables" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureDefaultRoute", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureRouteTableWithStaticRoute": { "type": "object", "description": "Azure Route Table with Static Route.", "title": "Azure Route Table", "x-displayname": "Azure Route Table with Static Route.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureRouteTableWithStaticRoute", "properties": { "route_table_id": { "type": "string", "description": "Route table ID in the format //", "title": "Route table ID", "maxLength": 256, "x-displayname": "Route table ID.", "x-ves-example": "/rg-1/rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$" }, "x-f5xc-example": "/rg-1/rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$" }, "x-f5xc-description-short": "Route table ID in the format //.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "pattern": "^\\\\/[-\\\\w\\\\._\\\\(\\\\)]+\\\\/[a-zA-Z0-9][a-zA-Z0-9-._]+[a-zA-Z0-9_]$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "static_routes": { "type": "array", "description": "List of Static Routes.", "title": "static_routes", "minItems": 1, "maxItems": 50, "items": { "type": "string" }, "x-displayname": "Static Routes.", "x-ves-example": "192.0.2.0/24.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "50", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 50, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureRouteTableWithStaticRoute", "required_fields": [ "static_routes" ], "mutually_exclusive_groups": [], "example_json": "{\n \"static_routes\": [\n \"value\"\n ]\n}", "example_yaml": "static_routes:\n- value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureRouteTableWithStaticRouteListType": { "type": "object", "description": "List Azure Route Table with Static Route.", "title": "List Azure Route Table with Static Route", "x-displayname": "List Azure Route Table with Static Route.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureRouteTableWithStaticRouteListType", "properties": { "route_tables": { "type": "array", "description": "Route Tables with static routes.", "title": "List of route tables with static routes", "minItems": 1, "maxItems": 200, "items": { "$ref": "#/components/schemas/cloud_connectAzureRouteTableWithStaticRoute" }, "x-displayname": "List of route tables with static routes.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "200", "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": "200", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 200, "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": "List Azure Route Table with Static Route.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureRouteTableWithStaticRouteListType", "required_fields": [ "route_tables" ], "mutually_exclusive_groups": [], "example_json": "{\n \"route_tables\": [\n {\n \"static_routes\": [\n \"value\"\n ]\n }\n ]\n}", "example_yaml": "route_tables:\n- static_routes:\n - value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureRouteTables": { "type": "object", "description": "Azure Route Table.", "title": "Azure Route Table", "x-displayname": "Azure Route Table.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureRouteTables", "properties": { "route_table_id": { "type": "array", "description": "Route table ID in the format //", "title": "Route table ID", "items": { "type": "string", "maxLength": 256 }, "x-displayname": "Route table ID.", "x-ves-example": "/rg-1/rtb-12345678901234567.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/rg-1/rtb-12345678901234567", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Route table ID in the format //.", "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-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureRouteTables", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureVNETAttachmentType": { "type": "object", "title": "Azure VNET attachment", "x-displayname": "Azure VNet Attachment.", "x-ves-oneof-field-routing_choice": "[\"custom_routing\",\"default_route\",\"manual_routing\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureVNETAttachmentType", "properties": { "custom_routing": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureRouteTableWithStaticRouteListType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_route", "manual_routing" ] }, "default_route": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureDefaultRoute" } ], "x-f5xc-description-short": "Configuration parameter for default route.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_routing", "manual_routing" ] }, "labels": { "type": "object", "description": "Add labels for the VNet attachments. These labels can then be used in policies such as enhanced firewall policies.", "title": "Labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Add labels for the VNet attachments. These labels can then be used in policies such as enhanced firewall policies.", "x-f5xc-description-medium": "Add labels for the VNet attachments. These labels can then be used in policies such as enhanced firewall policies.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual_routing": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_routing", "default_route" ] }, "subscription_id": { "type": "string", "description": "Enter the Subscription ID of the VNet to be attached.", "title": "Subscription ID", "maxLength": 64, "x-displayname": "Subscription ID.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "64" }, "x-f5xc-description-short": "Enter the Subscription ID of the VNet to be attached.", "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-field-mutability": "read-only" }, "vnet_id": { "type": "string", "description": "Enter the VNet ID of the VNet to be attached in format //", "title": "VNET ID", "maxLength": 256, "x-displayname": "VNet ID", "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": "Enter the VNet ID of the VNet to be attached in format //.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureVNETAttachmentType", "required_fields": [ "subscription_id", "vnet_id" ], "mutually_exclusive_groups": [], "example_json": "{\n \"subscription_id\": \"value\",\n \"vnet_id\": \"value\"\n}", "example_yaml": "subscription_id: value\nvnet_id: value" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureVNETSiteType": { "type": "object", "description": "Cloud Connect Azure VNet Site Type.", "title": "Cloud Connect Azure VNET Site Type", "x-displayname": "Azure VNet Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureVNETSiteType", "properties": { "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" } ] }, "vnet_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureVnetAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vnet attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureVNETSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectAzureVnetAttachmentListType": { "type": "object", "title": "VNET Attachments", "x-displayname": "VNet Attachments.", "x-ves-proto-message": "ves.io.schema.cloud_connect.AzureVnetAttachmentListType", "properties": { "vnet_list": { "type": "array", "description": "Collection of items or values", "title": "vnet_list", "maxItems": 128, "items": { "$ref": "#/components/schemas/cloud_connectAzureVNETAttachmentType" }, "x-displayname": "VNet List", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "128" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectAzureVnetAttachmentListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectData": { "type": "object", "description": "CloudConnectData wraps all the response data for a cloud connect.", "title": "Cloud Connect Data", "x-displayname": "Cloud Connect Data.", "x-ves-proto-message": "ves.io.schema.cloud_connect.CloudConnectData", "properties": { "data": { "type": "array", "description": "Metric values.", "title": "Data", "items": { "$ref": "#/components/schemas/cloud_connectMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "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 } } }, "x-f5xc-description-short": "CloudConnectData wraps all the response data for a cloud connect.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectProviderType": { "type": "string", "description": "Cloud Connect Provider Type\n\n- AWS: AWS\n\nCloud connects backed by AWS cloud\n- Azure: Azure\n\nCloud connects backed by Azure cloud\n- GCP: GCP\n\nCloud connects backed by GCP cloud.", "title": "Cloud Connect Provider", "enum": [ "AWS", "AZURE", "GCP" ], "default": "AWS", "x-displayname": "Cloud Connect Provider.", "x-ves-proto-enum": "ves.io.schema.cloud_connect.CloudConnectProviderType", "x-f5xc-description-short": "Cloud Connect Provider Type - AWS: AWS Cloud connects backed by AWS cloud - Azure: Azure Cloud connects backed by Azure cloud - GCP: GCP Cloud...", "x-f5xc-description-medium": "Cloud Connect Provider Type - AWS: AWS Cloud connects backed by AWS cloud - Azure: Azure Cloud connects backed by Azure cloud - GCP: GCP Cloud connects backed by GCP cloud.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"AWS\"", "example_yaml": "AWS\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectState": { "type": "string", "description": "State of the CloudConnect connections\n\n- DOWN: Down\n\nCloudConnect and their corresponding VPC attachments are down\n- DEGRADED: Degraded\n\nSome of VPC attachments with the CloudConnect are down\n- UP: Up\n\nCloudConnect and their corresponding VPC attachments are available and healthy.", "title": "CloudConnect State", "enum": [ "DOWN", "DEGRADED", "UP" ], "default": "DOWN", "x-displayname": "CloudConnect State.", "x-ves-proto-enum": "ves.io.schema.cloud_connect.CloudConnectState", "x-f5xc-description-short": "State of the CloudConnect connections - DOWN: Down CloudConnect and their corresponding VPC attachments are down - DEGRADED: Degraded Some of VPC...", "x-f5xc-description-medium": "State of the CloudConnect connections - DOWN: Down CloudConnect and their corresponding VPC attachments are down - DEGRADED: Degraded Some of VPC attachments with the CloudConnect are down - UP: Up CloudConnect and their corresponding VPC attachments are available and healthy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectState", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DOWN\"", "example_yaml": "DOWN\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectStatusType": { "type": "object", "description": "Cloud Connect Status.", "title": "Cloud Connect Status", "x-displayname": "Status", "x-ves-oneof-field-cloud_connect_deployment": "[\"cloud_connect_aws_securemesh_site\",\"cloud_connect_aws_site\",\"cloud_connect_azure_site\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.CloudConnectStatusType", "properties": { "cloud_connect_aws_securemesh_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSSecureMeshSiteStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_connect_aws_site", "cloud_connect_azure_site" ] }, "cloud_connect_aws_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSAttachmentsListStatusType__ves_io_schema_cloud_connect" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_connect_aws_securemesh_site", "cloud_connect_azure_site" ] }, "cloud_connect_azure_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureAttachmentsListStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_connect_aws_securemesh_site", "cloud_connect_aws_site" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCloudConnectVPCStateType": { "type": "string", "description": "Cloud Connect VPC State Type\n\n- AVAILABLE: Available\n\nCloud Connect VPC attachment is in available state.\n- PENDING: Pending\n\nCloud Connect VPC attachment is in flight.\n- FAILED: Failed\n\nCloud Connect VPC attachment has failed.\n- DELETED: Deleted\n\nCloud Connect VPC attachment has been deleted.\n- DELETING: Deleting\n\nCloud Connect VPC attachment is being deleted.\n- INITIATED: Initiated\n\nCloud Connect VPC attachment process has been initiated.", "title": "Cloud Connect VPC State", "enum": [ "AVAILABLE", "PENDING", "FAILED", "DELETED", "DELETING", "INITIATED" ], "default": "AVAILABLE", "x-displayname": "Cloud Connect VPC State.", "x-ves-proto-enum": "ves.io.schema.cloud_connect.CloudConnectVPCStateType", "x-f5xc-description-short": "Cloud Connect VPC State Type - AVAILABLE: Available Cloud Connect VPC attachment is in available state. - PENDING: Pending Cloud Connect VPC...", "x-f5xc-description-medium": "Cloud Connect VPC State Type - AVAILABLE: Available Cloud Connect VPC attachment is in available state. - PENDING: Pending Cloud Connect VPC attachment is in flight. - FAILED: Failed Cloud Connect VPC attachment has failed. - DELETED: Deleted Cloud Connect VPC attachment has been deleted. ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCloudConnectVPCStateType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"AVAILABLE\"", "example_yaml": "AVAILABLE\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCreateAWSProviderType": { "type": "object", "description": "Cloud Connect with AWS.", "title": "Cloud Connect with AWS", "x-displayname": "AWS", "x-ves-oneof-field-site_type": "[\"aws_tgw_site\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.CreateAWSProviderType", "properties": { "aws_tgw_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCreateAWSTGWSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCreateAWSProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCreateAWSTGWSiteType": { "type": "object", "description": "Cloud Connect AWS TGW Site Type.", "title": "Create Cloud Connect AWS TGW Site Type", "x-displayname": "AWS TGW Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.CreateAWSTGWSiteType", "properties": { "cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cred", "gated_by": null, "required": false, "cardinality": "single" } ] }, "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" } ] }, "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCreateAWSTGWSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of cloud_connect", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.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/schemacloud_connectCreateSpecType" } ], "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 cloud_connectCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.cloud_connect.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/schemacloud_connectGetSpecType" } ], "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 cloud_connectCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCredentialsRequest": { "type": "object", "description": "Request to return all the credentials for the matching cloud site type.", "title": "CredentialsRequest", "x-displayname": "Edge Credentials Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.CredentialsRequest", "properties": { "provider": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 8, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Request to return all the credentials for the matching cloud site type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCredentialsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCredentialsResponse": { "type": "object", "description": "Response that returns all the credentials for the matching provider.", "title": "CredentialsResponse", "x-displayname": "CredentialsResponse.", "x-ves-proto-message": "ves.io.schema.cloud_connect.CredentialsResponse", "properties": { "cred": { "type": "array", "description": "Cloud credentials.", "title": "Credentials", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Cloud Credentials.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response that returns all the credentials for the matching provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCredentialsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectCustomerEdge": { "type": "object", "description": "Customer Edge uniquely identifies customer edge i.e. Site.", "title": "Customer Edge", "x-displayname": "Customer Edge.", "x-ves-proto-message": "ves.io.schema.cloud_connect.CustomerEdge", "properties": { "name": { "type": "string", "description": "Name of the customer edge.", "title": "Customer Edge", "x-displayname": "Customer Edge.", "x-ves-example": "Customer Edge 1.", "x-f5xc-example": "Customer Edge 1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Customer Edge uniquely identifies customer edge i.e. Site.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectCustomerEdge", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectDefaultRoute": { "type": "object", "description": "Select Override Default Route Choice.", "title": "Default Route Override Choice", "x-displayname": "Override Default Route Choice.", "x-ves-oneof-field-default_route_choice": "[\"all_route_tables\",\"selective_route_tables\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.DefaultRoute", "properties": { "all_route_tables": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for all route tables.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "selective_route_tables" ] }, "selective_route_tables": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSDefaultRoutesRouteTable" } ], "x-f5xc-description-short": "Configuration parameter for selective route tables.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "all_route_tables" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectDefaultRoute", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a cloud_connect", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.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 cloud_connectDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectDiscoverVPCRequest": { "type": "object", "description": "Request body to discover vpcs for a given cloud provider, region and cred.", "title": "DiscoverVPCRequest", "x-displayname": "Cloud Connect VPC Discovery Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.DiscoverVPCRequest", "properties": { "cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cred", "gated_by": null, "required": false, "cardinality": "single" } ] }, "edge_site": { "allOf": [ { "$ref": "#/components/schemas/ioschemaObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "site", "field_path": "edge_site", "gated_by": null, "required": false, "cardinality": "single" } ] }, "provider": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 8, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "region": { "type": "string", "description": "Region.", "title": "Region", "x-displayname": "Region", "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": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Request body to discover vpcs for a given cloud provider, region and cred.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectDiscoverVPCRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectDiscoverVPCResponse": { "type": "object", "description": "VPC discovery response body for a cloud provider.", "title": "DiscoverVPCResponse", "x-displayname": "Cloud Connect VPC Discovery Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.DiscoverVPCResponse", "properties": { "discovered_vpc": { "type": "array", "description": "Discovered VPC.", "title": "Discovered VPC\nx-displayName: \"Discovered VPC\"\nDiscovered vpc", "items": { "$ref": "#/components/schemas/cloud_connectDiscoveredVPCType" }, "x-displayname": "Discovered VPC.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "VPC discovery response body for a cloud provider.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectDiscoverVPCResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectDiscoveredVPCType": { "type": "object", "description": "Discover VPC Type.", "title": "DiscoverVPC Type", "x-displayname": "Discover VPC.", "x-ves-proto-message": "ves.io.schema.cloud_connect.DiscoveredVPCType", "properties": { "cred": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_credentials", "field_path": "cred", "gated_by": null, "required": false, "cardinality": "single" } ] }, "provider": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 8, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "region": { "type": "string", "description": "Region", "title": "Region", "x-displayname": "Region", "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": false, "create": false, "update": false, "read": false } }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC 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" }, "vpc_name": { "type": "string", "description": "VPC Name", "title": "VPC Name", "x-displayname": "VPC Name", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectDiscoveredVPCType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectEdgeData": { "type": "object", "description": "EdgeData wraps all the response data for a customer edge.", "title": "Cloud Connect Edge Data", "x-displayname": "Cloud Connect Edge Data.", "x-ves-proto-message": "ves.io.schema.cloud_connect.EdgeData", "properties": { "ce": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCustomerEdge" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segments": { "type": "array", "description": "Metric data for the segments.", "title": "Metric", "items": { "$ref": "#/components/schemas/cloud_connectSegmentationData" }, "x-displayname": "Metric", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "EdgeData wraps all the response data for a customer edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectEdgeData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectEdgeListResponse": { "type": "object", "description": "Response body that returns online edge sites both customer edge and cloud edge.", "title": "EdgeListResponse", "x-displayname": "Edge List Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.EdgeListResponse", "properties": { "edge_site": { "type": "array", "description": "Reference to a edge site.", "title": "Edge Site", "items": { "$ref": "#/components/schemas/cloud_connectEdgeSite" }, "x-displayname": "Edge Site", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response body that returns online edge sites both customer edge and cloud edge.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectEdgeListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectEdgeSite": { "type": "object", "description": "Reference to a edge site.", "title": "Edge Site", "x-displayname": "Edge Site", "x-ves-proto-message": "ves.io.schema.cloud_connect.EdgeSite", "properties": { "coordinates": { "allOf": [ { "$ref": "#/components/schemas/siteCoordinates__ves_io_schema_cloud_connect" } ], "x-f5xc-description-short": "Configuration parameter for coordinates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "edge_site": { "allOf": [ { "$ref": "#/components/schemas/ioschemaObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "site", "field_path": "edge_site", "gated_by": null, "required": false, "cardinality": "single" } ] }, "provider": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 8, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "region": { "type": "string", "description": "Edge site region.", "title": "Region", "x-displayname": "Region", "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": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectEdgeSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectFieldData": { "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.cloud_connect.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 } }, "status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectStatus" } ], "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" }, "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 cloud_connectFieldData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectFieldSelector": { "type": "string", "description": "FieldSelector specifies the metrics that can be queried for cloud connect.\n\nIndicates field not being set\nx-unit: \"bytes per second (bps)\"\nThroughput of incoming traffic\nx-unit: \"bytes per second (bps)\"\nThroughput of outgoing traffic\nx-unit: \"bytes per second (bps)\"\nThroughput of outgoing traffic.", "title": "Cloud Connect Metric Type", "enum": [ "METRIC_TYPE_NONE", "METRIC_TYPE_IN_BYTES", "METRIC_TYPE_OUT_BYTES", "METRIC_TYPE_TOTAL_BYTES" ], "default": "METRIC_TYPE_NONE", "x-displayname": "Cloud Connect Metric Type.", "x-ves-proto-enum": "ves.io.schema.cloud_connect.FieldSelector", "x-f5xc-description-short": "FieldSelector specifies the metrics that can be queried for cloud connect.", "x-f5xc-description-medium": "FieldSelector specifies the metrics that can be queried for cloud connect. Indicates field not being set x-unit: \"bytes per second (bps)\" Throughput of incoming traffic x-unit: \"bytes per second (bps)\" Throughput of outgoing traffic x-unit: \"bytes per second (bps)\" Throughput of outgoing traffic.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectFieldSelector", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"METRIC_TYPE_NONE\"", "example_yaml": "METRIC_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectGetMetricsRequest": { "type": "object", "description": "Request to GET cloud connect data.", "title": "Get Metrics Request", "x-displayname": "GET Metrics Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.GetMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to fetch cloud connect data. 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.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.", "title": "field_selector", "items": { "$ref": "#/components/schemas/cloud_connectFieldSelector" }, "x-displayname": "Field Selector.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select fields to be returned in the response.", "x-f5xc-description-medium": "Select fields to be returned in the response. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.", "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 } }, "is_trend_request": { "type": "boolean", "description": "Trend value computation requested by the user\nOptional: default is false.", "format": "boolean", "x-displayname": "Trend calculation requested by the user.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Cloud Connect name.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Cloud_connect-1.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "cloud_connect-1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to fetch cloud connect data. 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-minimum-configuration": { "description": "Minimum configuration for cloud_connectGetMetricsRequest", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"cloud_connect-1\"\n}", "example_yaml": "name: cloud_connect-1" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectGetMetricsResponse": { "type": "object", "description": "GET Metrics Response.", "title": "Get Metrics Response", "x-displayname": "GET Metrics Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.GetMetricsResponse", "properties": { "data": { "type": "array", "description": "Metric data specified for the cloud connect.", "title": "Data", "items": { "$ref": "#/components/schemas/cloud_connectMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Metric data specified for the cloud connect.", "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-minimum-configuration": { "description": "Minimum configuration for cloud_connectGetMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read cloud_connect", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectReplaceRequest" } ], "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/schemacloud_connectGetSpecType" } ], "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/cloud_connectStatusObject" }, "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 cloud_connectGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectLabelFilter": { "type": "object", "description": "Metrics used in the cloud connect 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.cloud_connect.LabelFilter", "properties": { "label": { "allOf": [ { "$ref": "#/components/schemas/schemacloud_connectLabel" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "op": { "allOf": [ { "$ref": "#/components/schemas/schemaMetricLabelOp" } ], "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 cloud connect are tagged with labels listed in the enum Label.", "x-f5xc-description-medium": "Metrics used in the cloud connect 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 cloud_connectLabelFilter", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListMetricsRequest": { "type": "object", "description": "Cloud_connect API is used to GET the in/out throughput\nfor the tenant's customer edges.", "title": "List metrics Request", "x-displayname": "List Metrics Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ListMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to fetch cloud connect data. 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.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.", "title": "field_selector", "items": { "$ref": "#/components/schemas/cloud_connectFieldSelector" }, "x-displayname": "Field Selector.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select fields to be returned in the response.", "x-f5xc-description-medium": "Select fields to be returned in the response. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.", "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 } }, "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, cloud connect data for all sites will be returned in the response.", "title": "label_filter", "maxItems": 100, "items": { "$ref": "#/components/schemas/cloud_connectLabelFilter" }, "x-displayname": "Label Filter.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "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, cloud connect data for all sites will be returned in the response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 100, "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 } }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to fetch cloud connect data. 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": "Cloud_connect API is used to GET the in/out throughput for the tenant's customer edges.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectListMetricsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListMetricsResponse": { "type": "object", "description": "Response for cloud connect API contains list of customer edges & cloud connects associated with the customer edge.\nEach cloud connect contains throughput data for a given cloud connect.", "title": "List Metrics Response", "x-displayname": "List Metrics Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ListMetricsResponse", "properties": { "cloud_connect": { "type": "array", "description": "Metric data specified for the cloud connect.", "title": "Cloud Connect", "items": { "$ref": "#/components/schemas/cloud_connectCloudConnectData" }, "x-displayname": "Cloud Connect.", "x-f5xc-description-short": "Metric data specified for the cloud connect.", "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 cloud connect API contains list of customer edges & cloud connects associated with the customer edge.", "x-f5xc-description-medium": "Response for cloud connect API contains list of customer edges & cloud connects associated with the customer edge. Each cloud connect contains throughput data for a given cloud connect.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectListMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of cloud_connect", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.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/cloud_connectListResponseItem" }, "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 cloud_connectListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListResponseItem": { "type": "object", "description": "By default a summary of cloud_connect 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 cloud_connect", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.cloud_connect.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this cloud_connect.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this cloud_connect.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this cloud_connect.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this cloud_connect.", "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 cloud_connect is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates cloud_connect is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemacloud_connectGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this cloud_connect.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this cloud_connect.", "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 cloud_connect.", "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/cloud_connectStatusObject" }, "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 cloud_connect.", "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 cloud_connect 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 cloud_connect 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 cloud_connectListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListSegmentMetricsRequest": { "type": "object", "description": "Cloud_connect API is used to GET the in/out throughput\nfor the tenant's customer edges.", "title": "List Segment metrics Request", "x-displayname": "List Metrics Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ListSegmentMetricsRequest", "properties": { "end_time": { "type": "string", "description": "End time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "End time of metric collection from which data will be considered to fetch cloud connect data. 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.\nField_selector is used to specify the fields to be returned in the response, thereby limiting the\namount of data returned in the response.\n\nNote: Selecting many/all fields may impact the query latency.\n\nOptional: If not specified, only the following fields are returned in the response.\nMETRIC_TYPE_IN_BYTES, METRIC_TYPE_OUT_BYTES.", "title": "field_selector", "items": { "$ref": "#/components/schemas/cloud_connectFieldSelector" }, "x-displayname": "Field Selector.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Select fields to be returned in the response.", "x-f5xc-description-medium": "Select fields to be returned in the response. Field_selector is used to specify the fields to be returned in the response, thereby limiting the amount of data returned in the response.", "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 } }, "is_trend_request": { "type": "boolean", "description": "Trend value computation requested by the user\nOptional: default is false.", "format": "boolean", "x-displayname": "Trend calculation requested by the user.", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Trend value computation requested by the user Optional: default is false.", "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, cloud connect data for all sites will be returned in the response.", "title": "label_filter", "maxItems": 100, "items": { "$ref": "#/components/schemas/cloud_connectLabelFilter" }, "x-displayname": "Label Filter.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "100" }, "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, cloud connect data for all sites will be returned in the response.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 100, "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 } }, "start_time": { "type": "string", "description": "Start time of metric collection from which data will be considered to fetch cloud connect data.\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 fetch cloud connect data.", "x-f5xc-description-medium": "Start time of metric collection from which data will be considered to fetch cloud connect data. 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": "Cloud_connect API is used to GET the in/out throughput for the tenant's customer edges.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectListSegmentMetricsRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectListSegmentMetricsResponse": { "type": "object", "description": "Response for cloud connect API contains list of customer edges & cloud connects associated with the customer edge.\nEach cloud connect contains throughput data for a given cloud connect.", "title": "List Segment Metrics Response", "x-displayname": "List Metrics Response.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ListSegmentMetricsResponse", "properties": { "edges": { "type": "array", "description": "Cloud connect data for list of customer edges owned by a tenant.", "title": "Customer Edges", "items": { "$ref": "#/components/schemas/cloud_connectEdgeData" }, "x-displayname": "Customer Edges.", "x-f5xc-description-short": "Cloud connect data for list of customer edges owned by a tenant.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "segment": { "type": "array", "description": "Metric data for the given metric.", "items": { "$ref": "#/components/schemas/cloud_connectSegmentationData" }, "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 cloud connect API contains list of customer edges & cloud connects associated with the customer edge.", "x-f5xc-description-medium": "Response for cloud connect API contains list of customer edges & cloud connects associated with the customer edge. Each cloud connect contains throughput data for a given cloud connect.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectListSegmentMetricsResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectMetricData": { "type": "object", "description": "MetricData contains metric type and the corresponding value for a cloud connect.", "title": "Metric Data", "x-displayname": "Metric Data.", "x-ves-proto-message": "ves.io.schema.cloud_connect.MetricData", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectFieldSelector" } ], "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 } }, "values": { "type": "array", "description": "List of metric values. May contain more than one value if timeseries data is requested.", "title": "Value", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Value", "x-f5xc-description-short": "List of metric values. May contain more than one value if timeseries data is requested.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "MetricData contains metric type and the corresponding value for a cloud connect.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectMetricData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectPeerType": { "type": "object", "description": "List of peer node and GRE tunnel configuration.", "title": "Peer", "x-displayname": "Peer Nodes.", "x-ves-proto-message": "ves.io.schema.cloud_connect.PeerType", "properties": { "inside_gre_subnet": { "type": "string", "title": "Inside GRE Subnet", "x-displayname": "Inside GRE Subnet.", "description": "Configuration parameter for inside gre subnet", "x-f5xc-description-short": "Configuration parameter for inside gre subnet.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "node": { "allOf": [ { "$ref": "#/components/schemas/cloud_re_regionNodeType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "peer_asn": { "type": "string", "title": "Peer ASN", "format": "int64", "x-displayname": "Peer ASN", "description": "Configuration parameter for peer asn", "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 } }, "tgw_address": { "type": "string", "title": "TGW Address", "x-displayname": "TGW Address.", "description": "Network address or location", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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": "List of peer node and GRE tunnel configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectPeerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReApplyVPCAttachmentRequest": { "type": "object", "description": "Request of VPC attachment reapply event.", "title": "ReApplyVPCAttachmentRequest", "x-displayname": "ReApplyVPCAttachmentRequest.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReApplyVPCAttachmentRequest", "properties": { "cloud_connect": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for cloud connect.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "cloud_connect", "field_path": "cloud_connect", "gated_by": null, "required": false, "cardinality": "single" } ] }, "provider": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectProviderType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 8, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vpc_id": { "type": "string", "description": "VPC ID", "title": "VPC ID", "x-displayname": "VPC 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" } }, "x-f5xc-description-short": "Request of VPC attachment reapply event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReApplyVPCAttachmentRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReApplyVPCAttachmentResponse": { "type": "object", "description": "Response of VPC attachment reapply event.", "title": "ReApplyVPCAttachmentResponse", "x-displayname": "ReApplyVPCAttachmentResponse.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReApplyVPCAttachmentResponse", "x-f5xc-description-short": "Response of VPC attachment reapply event.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReApplyVPCAttachmentResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReplaceAWSProviderType": { "type": "object", "description": "Cloud Connect with AWS.", "title": "Cloud Connect with AWS", "x-displayname": "AWS", "x-ves-oneof-field-site_type": "[\"aws_tgw_site\"]", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReplaceAWSProviderType", "properties": { "aws_tgw_site": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectReplaceAWSTGWSiteType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReplaceAWSProviderType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReplaceAWSTGWSiteType": { "type": "object", "description": "Cloud Connect AWS TGW Site Type.", "title": "Replace Cloud Connect AWS TGW Site Type", "x-displayname": "AWS TGW Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReplaceAWSTGWSiteType", "properties": { "vpc_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAWSVPCAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vpc attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReplaceAWSTGWSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReplaceAzureVNETSiteType": { "type": "object", "description": "Cloud Connect Azure VNet Site Type.", "title": "Replace Cloud Connect Azure Vnet Site Type", "x-displayname": "Azure VNet Site Type.", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReplaceAzureVNETSiteType", "properties": { "vnet_attachments": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectAzureVnetAttachmentListType" } ], "x-f5xc-description-short": "Configuration parameter for vnet attachments.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReplaceAzureVNETSiteType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a cloud_connect", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.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/schemacloud_connectReplaceSpecType" } ], "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 cloud_connectReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.cloud_connect.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectSegmentationData": { "type": "object", "description": "SegmentationData contains metric type and the corresponding value for a cloud connect.", "title": "Cloud Connect Segmentation Data", "x-displayname": "Cloud Connect Segmentation Data.", "x-ves-proto-message": "ves.io.schema.cloud_connect.SegmentationData", "properties": { "data": { "type": "array", "description": "List of metric values. May contain more than one value if timeseries data is requested.", "title": "Data", "items": { "$ref": "#/components/schemas/cloud_connectMetricData" }, "x-displayname": "Data", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "List of metric values. May contain more than one value if timeseries data is requested.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "type": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectTrafficType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "SegmentationData contains metric type and the corresponding value for a cloud connect.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectSegmentationData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectStatus": { "type": "string", "description": "Enumerates Status of CloudConnect\n\n- STATUS_UNKNOWN: Unknown\n\n- STATUS_DOWN: Down\n\n- STATUS_DEGRADED: Degraded\n\n- STATUS_UP: Up.", "title": "Status", "enum": [ "STATUS_UNKNOWN", "STATUS_DOWN", "STATUS_DEGRADED", "STATUS_UP" ], "default": "STATUS_UNKNOWN", "x-displayname": "Status", "x-ves-proto-enum": "ves.io.schema.cloud_connect.Status", "x-f5xc-description-short": "Enumerates Status of CloudConnect - STATUS_UNKNOWN: Unknown - STATUS_DOWN: Down - STATUS_DEGRADED: Degraded - STATUS_UP: Up.", "x-f5xc-description-medium": "Enumerates Status of CloudConnect - STATUS_UNKNOWN: Unknown - STATUS_DOWN: Down - STATUS_DEGRADED: Degraded - STATUS_UP: Up.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_UNKNOWN\"", "example_yaml": "STATUS_UNKNOWN\n..." }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for Cloud Connect", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.cloud_connect.StatusObject", "properties": { "cloud_connect_status": { "allOf": [ { "$ref": "#/components/schemas/cloud_connectCloudConnectStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "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 cloud_connectStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectSubnetStatusType": { "type": "object", "description": "Network Interface Status.", "title": "SubnetStatusType for AWS VPC Attachment", "x-displayname": "Network Interface Status.", "x-ves-proto-message": "ves.io.schema.cloud_connect.SubnetStatusType", "properties": { "availability_zone": { "type": "string", "description": "Availability Zone.", "title": "Availability Zone\nx-displayName: \"Availability Zone\"", "x-displayname": "Availability Zone.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "interface_type": { "type": "string", "description": "Interface Type.", "title": "Interface Type\nx-displayName: \"Interface Type\"", "x-displayname": "Interface Type.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network_interface_id": { "type": "string", "description": "Network Interface ID.", "title": "Network Interface ID", "x-displayname": "Network Interface 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" }, "private_ipv4_address": { "type": "string", "description": "Private IPv4 Address.", "title": "Private IPV4 Address\nx-displayName: \"Private IPV4 Address\"", "x-displayname": "Private IPv4 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": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status", "title": "Status\nx-displayName: \"Status\"", "x-displayname": "Status", "x-f5xc-example": "active", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "subnet_id": { "type": "string", "description": "Subnet ID", "title": "Subnet ID\nx-displayName: \"Subnet ID\"", "x-displayname": "Subnet 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" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectSubnetStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectTopCloudConnectData": { "type": "object", "description": "TopCloudConnectData wraps all the response data.", "title": "TopCloudConnectData", "x-displayname": "TopCloudConnectData.", "x-ves-proto-message": "ves.io.schema.cloud_connect.TopCloudConnectData", "properties": { "data": { "type": "array", "description": "Flows data.", "title": "Data", "items": { "$ref": "#/components/schemas/cloud_connectFieldData" }, "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/cloud_connectFieldSelector" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "TopCloudConnectData wraps all the response data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for cloud_connectTopCloudConnectData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "cloud_infrastructure", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Cloud connect is platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "cloud_connectTopCloudConnectRequest": { "type": "object", "title": "Top Cloud Connect Request", "x-displayname": "Top Cloud Connect Request.", "x-ves-proto-message": "ves.io.schema.cloud_connect.TopCloudConnectRequest", "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": "Metric fields to be returned in the response. If no metric fields are specified in the request,\nthen the response will not contain any metric data.", "title": "Metric Selector", "items": { "$ref": "#/components/schemas/cloud_connectFieldSelector" }, "x-displayname": "Metric Selector.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Metric fields to be returned in the response. If no metric fields are specified in the request, then the response will not contain any metric data.", "x-f5xc-description-medium": "Metric fields to be returned in the response. If no metric fields are specified in the request, then the response will not contain any metric data.", "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 } }, "filter": { "type": "string", "description": "\\site-1\",\\\"site-2\\\")}\"\nfilter is used to specify the list of matchers\nsyntax for filter := {[]}\n :=