{ "openapi": "3.0.3", "info": { "title": "Dns", "description": "Name infrastructure with authoritative zones, A/AAAA/CNAME record types, and zone management. Supports zone transfers, security extensions, health-based routing, and delegation. Enables reliable name resolution, geographic load balancing, and name-based traffic steering across distributed environments.", "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": "Name infrastructure with authoritative zones, A/AAAA/CNAME record types, and zone management. Supports zone transfers, security extensions, health-based routing, and delegation. Enables reliable name resolution, geographic load balancing, and name-based traffic steering across distributed environments.", "x-f5xc-summary": "Name resolution with zone transfers and health checks. Record types and delegation support.", "x-f5xc-cli-domain": "dns", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/app-networking/dns-load-balancer", "description": "F5 XC Documentation - DNS Load Balancing" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Invalid DNS record format", "resolution": "Validate record syntax (e.g., IP format for A records)", "prevention": "Use DNS record validation before submission" }, { "code": 409, "message": "DNS zone already exists", "resolution": "Use existing zone or delete before recreation", "prevention": "Check zone existence before creation" }, { "code": 400, "message": "DNSSEC signing failed", "resolution": "Verify DNSSEC key configuration and chain", "prevention": "Test DNSSEC in staging before production" } ], "security_notes": [ "Enable DNSSEC for zone authentication", "Use CAA records to restrict certificate issuance", "Configure DNS query logging for security monitoring", "Implement rate limiting on DNS responses" ], "performance_tips": [ "Set appropriate TTL values based on change frequency", "Use GeoDNS for global load distribution", "Configure health-based failover for high availability", "Enable DNS prefetching hints for faster resolution" ] }, "x-f5xc-guided-workflows": [ { "id": "configure_dns_zone", "name": "Configure DNS Zone", "description": "Set up authoritative DNS zone with records", "complexity": "low", "estimated_steps": 4, "prerequisites": [ "Domain name ownership", "NS delegation configured at registrar" ], "steps": [ { "order": 1, "action": "create_dns_zone", "name": "Create DNS Zone", "description": "Create authoritative zone for domain", "resource": "dns_zone", "required_fields": [ "name", "domain" ] }, { "order": 2, "action": "add_dns_records", "name": "Add DNS Records", "description": "Create A, CNAME, and other records", "resource": "dns_record", "depends_on": [ 1 ], "tips": [ "Use appropriate TTL values", "Add MX records for email" ] }, { "order": 3, "action": "enable_dnssec", "name": "Enable DNSSEC", "description": "Configure DNS security extensions", "optional": true, "depends_on": [ 1 ] }, { "order": 4, "action": "verify_resolution", "name": "Verify DNS Resolution", "description": "Test DNS queries", "verification": [ "Query records from public DNS", "Verify propagation" ] } ] } ], "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "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" } ], "paths": { "/api/config/namespaces/{metadata.namespace}/dns_compliance_checkss": { "post": { "summary": "Create DNS Compliance Checks.", "description": "Create DNS Compliance Checks Specification in a given namespace. If one already exists it will give an error.", "operationId": "ves.io.schema.dns_compliance_checks.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_compliance_checksCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_compliance_checksCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_compliance_checks.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-compliance-checks resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-compliance-checks" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "dns-compliance-checks" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Compliance Checks.", "x-ves-proto-service": "ves.io.schema.dns_compliance_checks.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/dns_compliance_checkss/{metadata.name}": { "put": { "summary": "Replace DNS Compliance Checks.", "description": "Replace DNS Compliance Checks specification in a given namespace.", "operationId": "ves.io.schema.dns_compliance_checks.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_compliance_checksReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_compliance_checksReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_compliance_checks.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-compliance-checks" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "dns-compliance-checks" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Compliance Checks.", "x-ves-proto-service": "ves.io.schema.dns_compliance_checks.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_compliance_checkss": { "get": { "summary": "List Configure DNS Compliance Checks.", "description": "List the set of dns_compliance_checks in a namespace.", "operationId": "ves.io.schema.dns_compliance_checks.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_compliance_checksListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_compliance_checks.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_compliance_checks.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": "Configure DNS Compliance Checks.", "x-ves-proto-service": "ves.io.schema.dns_compliance_checks.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_compliance_checkss/{name}": { "get": { "summary": "GET DNS Compliance Checks.", "description": "GET DNS Compliance Checks details.", "operationId": "ves.io.schema.dns_compliance_checks.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_compliance_checksGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_compliance_checks.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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 Configure DNS Compliance Checks.", "description": "DELETE the specified dns_compliance_checks.", "operationId": "ves.io.schema.dns_compliance_checks.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/dns_compliance_checksDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_compliance_checks.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-compliance-checks", "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": [ "dns-compliance-checks", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Compliance Checks.", "x-ves-proto-service": "ves.io.schema.dns_compliance_checks.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/dns_proxys": { "post": { "summary": "Create DNS Proxy.", "description": "Create DNS Proxy in a given namespace. If one already exists it will give an error.", "operationId": "ves.io.schema.dns_proxy.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_proxyCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_proxyCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_proxy.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-proxy resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-proxy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "dns-proxy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Proxy.", "x-ves-proto-service": "ves.io.schema.dns_proxy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/dns_proxys/{metadata.name}": { "put": { "summary": "Replace DNS Proxy.", "description": "Replace DNS Proxy in a given namespace.", "operationId": "ves.io.schema.dns_proxy.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_proxyReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_proxyReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_proxy.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-proxy" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "dns-proxy" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Proxy.", "x-ves-proto-service": "ves.io.schema.dns_proxy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_proxys": { "get": { "summary": "List Configure DNS Proxy.", "description": "List the set of dns_proxy in a namespace.", "operationId": "ves.io.schema.dns_proxy.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_proxyListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_proxy.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_proxy.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": "Configure DNS Proxy.", "x-ves-proto-service": "ves.io.schema.dns_proxy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_proxys/{name}": { "get": { "summary": "GET DNS Proxy.", "description": "GET DNS Proxy details.", "operationId": "ves.io.schema.dns_proxy.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_proxyGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_proxy.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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 Configure DNS Proxy.", "description": "DELETE the specified dns_proxy.", "operationId": "ves.io.schema.dns_proxy.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/dns_proxyDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_proxy.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-proxy", "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": [ "dns-proxy", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Configure DNS Proxy.", "x-ves-proto-service": "ves.io.schema.dns_proxy.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/dns_domains": { "post": { "summary": "Create DNS Domain.", "description": "Create DNS Domain in a given namespace. If one already exist it will give a error.", "operationId": "ves.io.schema.dns_domain.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "metadata.namespace", "description": "Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "staging" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dns-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Domain.", "x-ves-proto-service": "ves.io.schema.dns_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/dns_domains/{metadata.name}": { "put": { "summary": "Replace DNS Domain.", "description": "Replace DNS Domain in a given namespace.", "operationId": "ves.io.schema.dns_domain.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_domainReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "dns-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Domain.", "x-ves-proto-service": "ves.io.schema.dns_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_domain/{name}/verify": { "post": { "summary": "Verify DNS Domain.", "description": "Verify DNS Domain for a given dns_domain object.", "operationId": "ves.io.schema.dns_domain.CustomAPI.VerifyDnsDomain", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainVerifyDnsDomainResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_domain.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "name", "description": "Name\nName dns_domain object, which also domain name.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example.com" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainVerifyDnsDomainRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.CustomAPI.VerifyDnsDomain", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Verify resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "verify" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.name", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "verify" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Domain.", "x-ves-proto-service": "ves.io.schema.dns_domain.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_domains": { "get": { "summary": "List DNS Domain.", "description": "List the set of dns_domain in a namespace.", "operationId": "ves.io.schema.dns_domain.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace to scope the listing of dns_domain.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "label_filter", "description": "A LabelSelectorType expression that every item in list response will satisfy.", "in": "query", "required": false, "x-displayname": "Label Filter.", "schema": { "type": "string" }, "x-f5xc-example": "env in (staging, testing), tier in (web, db)" }, { "name": "report_fields", "description": "X-example: \"\"\nExtra fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "report_status_fields", "description": "X-example: \"\"\nExtra status fields to return along with summary fields.", "in": "query", "required": false, "x-displayname": "Report Status Fields.", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": "DNS Domain.", "x-ves-proto-service": "ves.io.schema.dns_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/dns_domains/{name}": { "get": { "summary": "GET DNS Domain.", "description": "GET network policy set in a given namespace.", "operationId": "ves.io.schema.dns_domain.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nThe namespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nThe name of the configuration object to be fetched.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" }, { "name": "response_format", "description": "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in 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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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 DNS Domain.", "description": "DELETE the specified dns_domain.", "operationId": "ves.io.schema.dns_domain.API.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace in which the configuration object is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the configuration object.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "name" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_domainDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_domain.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-domain", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "dns-domain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Domain.", "x-ves-proto-service": "ves.io.schema.dns_domain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/system/suggest-values": { "post": { "summary": "Suggest Values.", "description": "SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.", "operationId": "ves.io.schema.dns_load_balancer.CustomAPI.SuggestValues", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemadns_load_balancerSuggestValuesResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_load_balancerSuggestValuesReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomAPI.SuggestValues", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Suggest-value resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "suggest-value" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "suggest-value" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_load_balancers": { "post": { "summary": "Create DNS Load Balancer.", "description": "Create DNS Load Balancer in a given namespace. If one already exist it will give a error.", "operationId": "ves.io.schema.dns_load_balancer.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_load_balancerCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-load-balancer resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-load-balancer" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dns-load-balancer" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_load_balancers/{metadata.name}": { "put": { "summary": "Replace DNS Load Balancer.", "description": "Replace DNS Load Balancer in a given namespace.", "operationId": "ves.io.schema.dns_load_balancer.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_load_balancerReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-load-balancer" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "dns-load-balancer" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_load_balancers": { "get": { "summary": "List DNS Load Balancer.", "description": "List the set of dns_load_balancer in a namespace.", "operationId": "ves.io.schema.dns_load_balancer.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_load_balancer.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_load_balancers/health_status": { "get": { "summary": "DNS Load Balancer Health Status List.", "description": "GET Health Status of all DNS Load Balancers in a namespace.", "operationId": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBHealthStatusList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerDNSLBHealthStatusListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 DNS LB health status.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBHealthStatusList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_load_balancers/pool_members_health_status": { "get": { "summary": "DNS Load Balancer Pool Members Health Status List.", "description": "GET Health Status of all DNS Load Balancer Pool Members in a namespace.", "operationId": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolMemberHealthStatusList", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolMemberHealthStatusListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 DNS LB health status.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolMemberHealthStatusList", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "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": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/health_status": { "get": { "summary": "DNS Load Balancer Pool Health Status.", "description": "GET DNS Load Balancer Pool Health Status.", "operationId": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolHealthStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolHealthStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 DNS Load Balancer Pool is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "dns_lb_name", "description": "DNS Load Balancer Name\nName of the DNS Load Balancer.", "in": "path", "required": true, "x-displayname": "DNS Load Balancer Name.", "schema": { "type": "string" }, "x-f5xc-example": "dns_lb1" }, { "name": "dns_lb_pool_name", "description": "DNS Load Balancer Pool Name\nName of the DNS Load Balancer Pool.", "in": "path", "required": true, "x-displayname": "DNS Load Balancer Pool Name.", "schema": { "type": "string" }, "x-f5xc-example": "dns_lb_pool1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolHealthStatus", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.dns_lb_name", "path.dns_lb_pool_name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "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.dns_lb_name", "path.dns_lb_pool_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": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/pool_members/{pool_member_address}/health_status_change_events": { "get": { "summary": "DNS Load Balancer Pool Member Health Status Change Events.", "description": "GET DNS Load Balancer Pool Health Status Changes.", "operationId": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolMemberHealthStatusChangeEvents", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolMemberHealthStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nx-required\nNamespace in which the DNS Load Balancer Pool is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "dns_lb_name", "description": "DNS Load Balancer Name\nx-required\nName of the DNS Load Balancer.", "in": "path", "required": true, "x-displayname": "DNS Load Balancer Name.", "schema": { "type": "string" }, "x-f5xc-example": "dns_lb1" }, { "name": "dns_lb_pool_name", "description": "DNS Load Balancer Pool Name\nx-required\nName of the DNS Load Balancer Pool.", "in": "path", "required": true, "x-displayname": "DNS Load Balancer Pool Name.", "schema": { "type": "string" }, "x-f5xc-example": "dns_lb_pool1" }, { "name": "pool_member_address", "description": "DNS Load Balancer Pool Member Address\nx-required\nIP Address of the DNS Load Balancer Pool Member.", "in": "path", "required": true, "x-displayname": "DNS Load Balancer Pool Member Address.", "schema": { "type": "string" }, "x-f5xc-example": "192.0.2.246" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBPoolMemberHealthStatusChangeEvents", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.dns_lb_name", "path.dns_lb_pool_name", "path.namespace", "path.pool_member_address" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "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.dns_lb_name", "path.dns_lb_pool_name", "path.namespace", "path.pool_member_address" ], "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": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_load_balancers/{name}": { "get": { "summary": "GET DNS Load Balancer.", "description": "GET DNS Load Balancer details.", "operationId": "ves.io.schema.dns_load_balancer.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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 DNS Load Balancer.", "description": "DELETE the specified dns_load_balancer.", "operationId": "ves.io.schema.dns_load_balancer.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/dns_load_balancerDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "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": [ "dns-load-balancer", "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": [ "dns-load-balancer", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_load_balancers/{name}/health_status": { "get": { "summary": "DNS Load Balancer Health Status.", "description": "GET DNS Load Balancer Health status.", "operationId": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBHealthStatus", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_load_balancerDNSLBHealthStatusResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 DNS Load Balancer is present.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "ns1" }, { "name": "name", "description": "Name\nName of the DNS Load Balancer.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "dns_lb1" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_load_balancer.CustomDataAPI.DNSLBHealthStatus", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer.", "x-ves-proto-service": "ves.io.schema.dns_load_balancer.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_lb_health_checks": { "post": { "summary": "Create DNS Load Balancer Health Check.", "description": "Create DNS Load Balancer Health Check in a given namespace. If one already exist it will give a error.", "operationId": "ves.io.schema.dns_lb_health_check.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_health_checkCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_lb_health_checkCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_health_check.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-lb-health-check resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-lb-health-check" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dns-lb-health-check" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Health Check.", "x-ves-proto-service": "ves.io.schema.dns_lb_health_check.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_lb_health_checks/{metadata.name}": { "put": { "summary": "Replace DNS Load Balancer Health Check.", "description": "Replace DNS Load Balancer Health Check in a given namespace.", "operationId": "ves.io.schema.dns_lb_health_check.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_health_checkReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_lb_health_checkReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_health_check.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "dns-lb-health-check" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "dns-lb-health-check" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Health Check.", "x-ves-proto-service": "ves.io.schema.dns_lb_health_check.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks": { "get": { "summary": "List DNS Load Balancer Health Check.", "description": "List the set of dns_lb_health_check in a namespace.", "operationId": "ves.io.schema.dns_lb_health_check.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_health_checkListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_lb_health_check.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_health_check.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Health Check.", "x-ves-proto-service": "ves.io.schema.dns_lb_health_check.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name}": { "get": { "summary": "GET DNS Load Balancer Health Check.", "description": "GET DNS Load Balancer Health Check details.", "operationId": "ves.io.schema.dns_lb_health_check.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_health_checkGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_health_check.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE DNS Load Balancer Health Check.", "description": "DELETE the specified dns_lb_health_check.", "operationId": "ves.io.schema.dns_lb_health_check.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/dns_lb_health_checkDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_health_check.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Health monitoring configuration", "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": [ "dns-lb-health-check", "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": [ "dns-lb-health-check", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Health Check.", "x-ves-proto-service": "ves.io.schema.dns_lb_health_check.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_lb_pools": { "post": { "summary": "Create DNS Load Balancer Pool.", "description": "Create DNS Load Balancer Pool in a given namespace. If one already exist it will give a error.", "operationId": "ves.io.schema.dns_lb_pool.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_poolCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_lb_poolCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_pool.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "postconditions": [ "Dns-lb-pool resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-lb-pool" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "dns-lb-pool" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Pool.", "x-ves-proto-service": "ves.io.schema.dns_lb_pool.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_lb_pools/{metadata.name}": { "put": { "summary": "Replace DNS Load Balancer Pool.", "description": "Replace DNS Load Balancer Pool in a given namespace.", "operationId": "ves.io.schema.dns_lb_pool.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_poolReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_lb_poolReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_pool.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "dns-lb-pool" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "dns-lb-pool" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Pool.", "x-ves-proto-service": "ves.io.schema.dns_lb_pool.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_lb_pools": { "get": { "summary": "List DNS Load Balancer Pool.", "description": "List the set of dns_lb_pool in a namespace.", "operationId": "ves.io.schema.dns_lb_pool.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_poolListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_lb_pool.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_pool.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "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": "DNS Load Balancer Pool.", "x-ves-proto-service": "ves.io.schema.dns_lb_pool.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_lb_pools/{name}": { "get": { "summary": "GET DNS Load Balancer Pool.", "description": "GET DNS Load Balancer Pool details.", "operationId": "ves.io.schema.dns_lb_pool.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_lb_poolGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_pool.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "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 DNS Load Balancer Pool.", "description": "DELETE the specified dns_lb_pool.", "operationId": "ves.io.schema.dns_lb_pool.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/dns_lb_poolDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_lb_pool.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Backend server pool configuration", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Valid origin targets" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "dns-lb-pool", "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": [ "dns-lb-pool", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Load Balancer Pool.", "x-ves-proto-service": "ves.io.schema.dns_lb_pool.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/clone_from_dns_domain": { "post": { "summary": "Clone from DNSDomain.", "description": "Cloning DNS domain to DNSZone.", "operationId": "ves.io.schema.dns_zone.CustomAPI.CloneFromDNSDomain", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneCloneResp" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneCloneReq" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.CloneFromDNSDomain", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Clone-from-dns-domain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "clone-from-dns-domain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "clone-from-dns-domain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/import": { "post": { "summary": "Import F5 Cloud Services DNS Zone.", "description": "Import F5 Cloud Services DNS Zone.", "operationId": "ves.io.schema.dns_zone.CustomAPI.ImportF5CSZone", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneImportF5CSZoneResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneImportF5CSZoneRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.ImportF5CSZone", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Import resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "import" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "import" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/import_axfr": { "post": { "summary": "Import AXFR for Primary Zone.", "description": "Import DNS Zone via AXFR.", "operationId": "ves.io.schema.dns_zone.CustomAPI.ImportAXFR", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneImportAXFRResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneImportAXFRRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.ImportAXFR", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Import-axfr resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "import-axfr" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "import-axfr" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/import_bind_create": { "post": { "summary": "Import BIND Files.", "description": "Import BIND Files to Create DNS Zones.", "operationId": "ves.io.schema.dns_zone.CustomAPI.ImportBINDCreate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneImportBINDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneImportBINDCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.ImportBINDCreate", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Import-bind-create resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "import-bind-create" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "import-bind-create" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/import_bind_validate": { "post": { "summary": "Validate BIND Files.", "description": "Validate BIND Files for Import.", "operationId": "ves.io.schema.dns_zone.CustomAPI.ImportBINDValidate", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneImportBINDResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneImportBINDValidateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.ImportBINDValidate", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Import-bind-validate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "import-bind-validate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "import-bind-validate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zone/initiate_zone_transfer": { "post": { "summary": "Initiate Zone Transfer.", "description": "Initiate zone transfer for secondary zone.", "operationId": "ves.io.schema.dns_zone.CustomAPI.InitiateZoneTransfer", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneInitiateZoneTransferResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "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/dns_zoneInitiateZoneTransferRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.InitiateZoneTransfer", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Initiate-zone-transfer resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "initiate-zone-transfer" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "initiate-zone-transfer" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_zones": { "post": { "summary": "Create DNS Zone.", "description": "Create DNS Zone in a given namespace. If one already exist it will give a error.", "operationId": "ves.io.schema.dns_zone.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_zoneCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS zone for domain name management", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Dns-zone resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "dns-zone" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "dns-zone" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{metadata.namespace}/dns_zones/{metadata.name}": { "put": { "summary": "Replace DNS Zone.", "description": "Replace DNS Zone in a given namespace.", "operationId": "ves.io.schema.dns_zone.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/dns_zoneReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS zone for domain name management", "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": [ "dns-zone" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "dns-zone" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/local_zone_file": { "get": { "summary": "GET Local Zone File.", "description": "GET local zone file.", "operationId": "ves.io.schema.dns_zone.CustomAPI.GetLocalZoneFile", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneGetLocalZoneFileResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_zone.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "dns_zone_name", "description": "Name\nName dns_zone object which is also the DNS zone.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example.com" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.GetLocalZoneFile", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "path.dns_zone_name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.dns_zone_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": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/local_zone_record_names": { "get": { "summary": "GET Local Zone Record Names.", "description": "GET unique record names from local zone file.", "operationId": "ves.io.schema.dns_zone.CustomAPI.GetLocalZoneRecordNames", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneGetLocalZoneRecordNamesResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_zone.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "dns_zone_name", "description": "Name\nName dns_zone object which is also the DNS zone.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example.com" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.GetLocalZoneRecordNames", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "path.dns_zone_name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.dns_zone_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": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/remote_zone_file": { "get": { "summary": "GET Remote Zone File.", "description": "GET remote zone file.", "operationId": "ves.io.schema.dns_zone.CustomAPI.GetRemoteZoneFile", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneGetRemoteZoneFileResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_zone.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "dns_zone_name", "description": "Name\nName dns_zone object which is also the DNS zone.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example.com" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.GetRemoteZoneFile", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS configuration for name resolution", "required_fields": [ "path.dns_zone_name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.dns_zone_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": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/zone_file/export": { "get": { "summary": "Export Zone File.", "description": "Export Zone File.", "operationId": "ves.io.schema.dns_zone.CustomAPI.ExportZoneFile", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneExportZoneFileResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_zone.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" }, { "name": "dns_zone_name", "description": "Name\nName dns_zone object which is also the DNS zone.", "in": "path", "required": true, "x-displayname": "Name", "schema": { "type": "string" }, "x-f5xc-example": "example.com" } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomAPI.ExportZoneFile", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.dns_zone_name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.dns_zone_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": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zones": { "get": { "summary": "List DNS Zone.", "description": "List the set of dns_zone in a namespace.", "operationId": "ves.io.schema.dns_zone.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 dns_zone.", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS zone for domain name 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-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_zones/metrics": { "post": { "summary": "DNS Zone Metrics.", "description": "Request to GET DNS zone metrics data.", "operationId": "ves.io.schema.dns_zone.CustomDataAPI.DnsZoneMetrics", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneDnsZoneMetricsResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace is always system for dns_zone.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneDnsZoneMetricsRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomDataAPI.DnsZoneMetrics", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Metric resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "metric" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "metric" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/data/namespaces/{namespace}/dns_zones/request_logs": { "post": { "summary": "GET DNS Zone Request Logs.", "description": "Retrieve DNS Zone Request Logs.", "operationId": "ves.io.schema.dns_zone.CustomDataAPI.DnsZoneRequestLogs", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneDnsZoneRequestLogResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nfetch request logs for a given namespace.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "value" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneDnsZoneRequestLogRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.CustomDataAPI.DnsZoneRequestLogs", "tags": [ "data" ], "x-f5xc-operation-metadata": { "purpose": "Logging configuration for audit and analysis", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Request-log resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "request-log" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "request-log" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.CustomDataAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/{namespace}/dns_zones/{name}": { "get": { "summary": "GET DNS Zone.", "description": "GET DNS Zone details.", "operationId": "ves.io.schema.dns_zone.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_zoneGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS zone for domain name 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" } }, "delete": { "summary": "DELETE DNS Zone.", "description": "DELETE the specified dns_zone.", "operationId": "ves.io.schema.dns_zone.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/dns_zoneDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "DNS zone for domain name management", "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": [ "dns-zone", "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": [ "dns-zone", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "DNS Zone", "x-ves-proto-service": "ves.io.schema.dns_zone.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}": { "post": { "summary": "Create", "operationId": "ves.io.schema.dns_zone.rrset.CustomAPI.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dns_zone_name", "description": "Dns_zone_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "DNS zone name.", "schema": { "type": "string" } }, { "name": "group_name", "description": "Group_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Group name.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.rrset.CustomAPI.Create", "tags": [ "config" ], "description": "Create rrsets.", "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.dns_zone_name", "path.group_name" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Rrset resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "rrset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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.dns_zone_name", "path.group_name" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "rrset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "F5XC DNS Management RRSet API.", "x-ves-proto-service": "ves.io.schema.dns_zone.rrset.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type}": { "get": { "summary": "GET", "operationId": "ves.io.schema.dns_zone.rrset.CustomAPI.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dns_zone_name", "description": "Dns_zone_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "DNS zone name.", "schema": { "type": "string" } }, { "name": "group_name", "description": "Group_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Group name.", "schema": { "type": "string" } }, { "name": "record_name", "description": "Record_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Record name.", "schema": { "type": "string" } }, { "name": "type", "description": "Type\n\nx-required.", "in": "path", "required": true, "x-displayname": "Type", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.rrset.CustomAPI.Get", "tags": [ "config" ], "description": "GET rrsets.", "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "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.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "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", "operationId": "ves.io.schema.dns_zone.rrset.CustomAPI.Delete", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dns_zone_name", "description": "Dns_zone_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "DNS zone name.", "schema": { "type": "string" } }, { "name": "group_name", "description": "Group_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Group name.", "schema": { "type": "string" } }, { "name": "record_name", "description": "Record_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Record name.", "schema": { "type": "string" } }, { "name": "type", "description": "Type\n\nx-required.", "in": "path", "required": true, "x-displayname": "Type", "schema": { "type": "string" } } ], "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.rrset.CustomAPI.Delete", "tags": [ "config" ], "description": "DELETE rrsets.", "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "rrset", "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.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "rrset", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "put": { "summary": "Replace", "operationId": "ves.io.schema.dns_zone.rrset.CustomAPI.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "dns_zone_name", "description": "Dns_zone_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "DNS zone name.", "schema": { "type": "string" } }, { "name": "group_name", "description": "Group_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Group name.", "schema": { "type": "string" } }, { "name": "record_name", "description": "Record_name\n\nx-required.", "in": "path", "required": true, "x-displayname": "Record name.", "schema": { "type": "string" } }, { "name": "type", "description": "Type\n\nx-required.", "in": "path", "required": true, "x-displayname": "Type", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rrsetReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.rrset.CustomAPI.Replace", "tags": [ "config" ], "description": "Replace rrsets.", "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "rrset" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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.dns_zone_name", "path.group_name", "path.record_name", "path.type" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "rrset" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "F5XC DNS Management RRSet API.", "x-ves-proto-service": "ves.io.schema.dns_zone.rrset.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_management/addon/subscribe": { "post": { "summary": "Subscribe to DNS Management.", "description": "Subscribe to DNS Management.", "operationId": "ves.io.schema.dns_zone.subscription.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_dns_zone_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_dns_zone_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.subscription.CustomAPI.Subscribe", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "F5XC DNS Management Subscription API.", "x-ves-proto-service": "ves.io.schema.dns_zone.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/config/dns/namespaces/system/dns_management/addon/unsubscribe": { "post": { "summary": "Unsubscribe to DNS Management.", "description": "Unsubscribe to DNS Management.", "operationId": "ves.io.schema.dns_zone.subscription.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_dns_zone_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_dns_zone_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/dns/" }, "x-ves-proto-rpc": "ves.io.schema.dns_zone.subscription.CustomAPI.Unsubscribe", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "F5XC DNS Management Subscription API.", "x-ves-proto-service": "ves.io.schema.dns_zone.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "dns_compliance_checksCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_compliance_checks", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.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/dns_compliance_checksCreateSpecType" } ], "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 dns_compliance_checksCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.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/dns_compliance_checksGetSpecType" } ], "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 dns_compliance_checksCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksCreateSpecType": { "type": "object", "description": "Create DNS Compliance Checks Specification in a given namespace. If one already exists it will give an error.", "title": "Create DNS Compliance Checks", "x-displayname": "Create DNS Compliance Checks.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.CreateSpecType", "properties": { "disallowed_query_type_list": { "type": "array", "description": "Disallowed Query Type Values.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedQueryType" }, "x-displayname": "Disallowed Query Type Values.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disallowed_resource_record_type_list": { "type": "array", "description": "Disallowed Resource Record Type List.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedResourceRecordType" }, "x-displayname": "Disallowed Resource Record Types.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_denylist": { "type": "array", "description": "List of domains to be denied by configuration object.", "maxItems": 30, "items": { "type": "string" }, "x-displayname": "Domain Deny list.", "x-ves-example": "www.f5.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-example": "www.f5.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-description-short": "List of domains to be denied by configuration object.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 30, "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": "Create DNS Compliance Checks Specification in a given namespace. If one already exists it will give an error.", "x-f5xc-description-medium": "Create DNS Compliance Checks Specification in a given namespace. If one already exists it will give an error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksCreateSpecType", "required_fields": [ "domain_denylist" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain_denylist\": [\n \"value\"\n ]\n}", "example_yaml": "domain_denylist:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksDNSComplianceChecksDeploymentStatus": { "type": "string", "description": "Deployment Status of DNS Compliance Checks\n\nDNS Compliance Checks is successfully deployed and active\nDeployment of DNS Compliance Checks is pending\nDNS Compliance Checks has been disabled.\nDNS Compliance Checks deployment encountered an error.", "title": "DNS Compliance Checks Deployment Status", "enum": [ "dns_compliance_checks_CONFIG_ACTIVE", "dns_compliance_checks_CONFIG_PENDING", "dns_compliance_checks_CONFIG_DISABLED", "dns_compliance_checks_CONFIG_FAILED" ], "default": "dns_compliance_checks_CONFIG_ACTIVE", "x-displayname": "DNS Compliance Checks Deployment Status.", "x-ves-proto-enum": "ves.io.schema.dns_compliance_checks.DNSComplianceChecksDeploymentStatus", "x-f5xc-description-short": "Deployment Status of DNS Compliance Checks DNS Compliance Checks is successfully deployed and active Deployment of DNS Compliance Checks is...", "x-f5xc-description-medium": "Deployment Status of DNS Compliance Checks DNS Compliance Checks is successfully deployed and active Deployment of DNS Compliance Checks is pending DNS Compliance Checks has been disabled. DNS Compliance Checks deployment encountered an error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksDNSComplianceChecksDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"dns_compliance_checks_CONFIG_ACTIVE\"", "example_yaml": "dns_compliance_checks_CONFIG_ACTIVE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksDNSComplianceChecksStatus": { "type": "object", "description": "Status DNS Compliance Checks.", "title": "DNS Compliance Checks Status", "x-displayname": "DNS Compliance Checks Status.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.DNSComplianceChecksStatus", "properties": { "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/dns_compliance_checksDNSComplianceChecksDeploymentStatus" } ], "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 dns_compliance_checksDNSComplianceChecksStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_compliance_checks", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.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 dns_compliance_checksDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksDisallowedQueryType": { "type": "string", "description": "Disallowed Query Type\n\n- QUERY: QUERY\n\n- IQUERY: IQUERY\n\n- STATUS: STATUS\n\n- NOTIFY: NOTIFY\n\n- UPDATE: UPDATE.", "title": "Disallowed Query Type", "enum": [ "QUERY", "IQUERY", "STATUS", "NOTIFY", "UPDATE" ], "default": "QUERY", "x-displayname": "Disallowed Query Type.", "x-ves-proto-enum": "ves.io.schema.dns_compliance_checks.DisallowedQueryType", "x-f5xc-description-short": "Disallowed Query Type - QUERY: QUERY - IQUERY: IQUERY - STATUS: STATUS - NOTIFY: NOTIFY - UPDATE: UPDATE.", "x-f5xc-description-medium": "Disallowed Query Type - QUERY: QUERY - IQUERY: IQUERY - STATUS: STATUS - NOTIFY: NOTIFY - UPDATE: UPDATE.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksDisallowedQueryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"QUERY\"", "example_yaml": "QUERY\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksDisallowedResourceRecordType": { "type": "string", "description": "Disallowed Resource Record\n\n- T: T\n\n- A: A\n\n- NS: NS\n\n- MD: MD\n\n- MF: MF\n\n- CNAME: CNAME\n\n- SOA: SOA\n\n- MB: MB\n\n- MG: MG\n\n- MR: MR\n\n- NULL: NULL\n\n- WKS: WKS\n\n- PTR: PTR\n\n- HINFO: HINFO\n\n- MINFO: MINFO\n\n- MX: MX\n\n- TXT: TXT\n\n- RP: RP\n\n- AFSDB: AFSDB\n\n- X25: X25\n\n- ISDN: ISDN\n\n- RT: RT\n\n- NSAP: NSAP\n\n- NSAP_PTR: NSAP-PTR\n\n- SIG: SIG\n\n- KEY: KEY\n\n- PX: PX\n\n- GPOS: GPOS\n\n- AAAA: AAAA\n\n- LOC: LOC\n\n- NXT: NXT\n\n- EID: EID\n\n- NIMLOC: NIMLOC\n\n- SRV: SRV\n\n- ATMA: ATMA\n\n- NAPTR: NAPTR\n\n- KX: KX\n\n- CERT: CERT\n\n- A6: A6\n\n- DNAME: DNAME\n\n- SINK: SINK\n\n- OPT: OPT\n\n- APL: APL\n\n- DS: DS\n\n- SSHFP: SSHFP\n\n- IPSECKEY: IPSECKEY\n\n- RRSIG: RRSIG\n\n- NSEC: NSEC\n\n- DNSKEY: DNSKEY\n\n- DHCID: DHCID\n\n- NSEC3: NSEC3\n\n- NSEC3PARAM: NSEC3PARAM\n\n- TLSA: TLSA\n\n- SMIMEA: SMIMEA\n\n- HIP: HIP\n\n- NINFO: NINFO\n\n- RKEY: RKEY\n\n- TALINK: TALINK\n\n- CDS: CDS\n\n- CDNSKEY: CDNSKEY\n\n- OPENPGPKEY: OPENPGPKEY\n\n- CSYNC: CSYNC\n\n- SPF: SPF\n\n- UINFO: UINFO\n\n- UID: UID\n\n- GID: GID\n\n- UNSPEC: UNSPEC\n\n- NID: NID\n\n- L32: L32\n\n- L64: L64\n\n- LP: LP\n\n- EUI48: EUI48\n\n- EUI64: EUI64\n\n- TKEY: TKEY\n\n- TSIG: TSIG\n\n- IXFR: IXFR\n\n- AXFR: AXFR\n\n- MAILB: MAILB\n\n- MAILA: MAILA\n\n- URI: URI\n\n- CAA: CAA\n\n- TA: TA\n\n- DLV: DLV.", "title": "DisallowedResourceRecord", "enum": [ "T", "A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "URI", "CAA", "TA", "DLV" ], "default": "T", "x-displayname": "Disallowed Resource Record.", "x-ves-proto-enum": "ves.io.schema.dns_compliance_checks.DisallowedResourceRecordType", "x-f5xc-description-short": "Disallowed Resource Record - T: T - A: A - NS: NS - MD: MD - MF: MF - CNAME: CNAME - SOA: SOA - MB: MB - MG: MG - MR: MR - NULL: NULL - WKS: WKS ...", "x-f5xc-description-medium": "Disallowed Resource Record - T: T - A: A - NS: NS - MD: MD - MF: MF - CNAME: CNAME - SOA: SOA - MB: MB - MG: MG - MR: MR - NULL: NULL - WKS: WKS - PTR: PTR - HINFO: HINFO - MINFO: MINFO - MX: MX - TXT: TXT - RP: RP - AFSDB: AFSDB - X25: X25 - ISDN: ISDN - RT: RT - NSAP: NSAP - NSAP_PTR: NSAP-PTR...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksDisallowedResourceRecordType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"T\"", "example_yaml": "T\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_compliance_checks", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_compliance_checksCreateRequest" } ], "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/dns_compliance_checksReplaceRequest" } ], "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/dns_compliance_checksGetSpecType" } ], "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/dns_compliance_checksStatusObject" }, "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 dns_compliance_checksGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksGetSpecType": { "type": "object", "description": "GET DNS Compliance Checks details.", "title": "Get DNS Compliance Checks", "x-displayname": "GET DNS Compliance Checks.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.GetSpecType", "properties": { "disallowed_query_type_list": { "type": "array", "description": "Disallowed Query Type Values.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedQueryType" }, "x-displayname": "Disallowed Query Type Values.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disallowed_resource_record_type_list": { "type": "array", "description": "Disallowed Resource Record Type List.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedResourceRecordType" }, "x-displayname": "Disallowed Resource Record Types.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_denylist": { "type": "array", "description": "List of domains to be denied by configuration object.", "maxItems": 30, "items": { "type": "string" }, "x-displayname": "Domain Deny list.", "x-ves-example": "www.f5.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-example": "www.f5.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-description-short": "List of domains to be denied by configuration object.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 30, "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 } }, "protocol_inspection": { "type": "array", "description": "A list of protocol inspection configs using DNS compliance checks.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Protocol Inspection Config.", "x-f5xc-description-short": "List of protocol inspection configs using DNS compliance checks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksGetSpecType", "required_fields": [ "domain_denylist" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain_denylist\": [\n \"value\"\n ]\n}", "example_yaml": "domain_denylist:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_compliance_checks", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.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/dns_compliance_checksListResponseItem" }, "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 dns_compliance_checksListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksListResponseItem": { "type": "object", "description": "By default a summary of dns_compliance_checks 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 dns_compliance_checks", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_compliance_checks.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_compliance_checks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_compliance_checks.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this dns_compliance_checks.", "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 dns_compliance_checks is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_compliance_checks is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/dns_compliance_checksGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_compliance_checks.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_compliance_checks.", "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 dns_compliance_checks.", "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/dns_compliance_checksStatusObject" }, "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 dns_compliance_checks.", "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 dns_compliance_checks.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 dns_compliance_checks is returned in 'List'.", "x-f5xc-description-medium": "By default a summary of dns_compliance_checks 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 dns_compliance_checksListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_compliance_checks", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.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/dns_compliance_checksReplaceSpecType" } ], "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 dns_compliance_checksReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksReplaceSpecType": { "type": "object", "description": "Replace DNS Compliance Checks specification in a given namespace.", "title": "Replace DNS Compliance Checks", "x-displayname": "Replace DNS Compliance Checks.", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.ReplaceSpecType", "properties": { "disallowed_query_type_list": { "type": "array", "description": "Disallowed Query Type Values.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedQueryType" }, "x-displayname": "Disallowed Query Type Values.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disallowed_resource_record_type_list": { "type": "array", "description": "Disallowed Resource Record Type List.", "maxItems": 8, "items": { "$ref": "#/components/schemas/dns_compliance_checksDisallowedResourceRecordType" }, "x-displayname": "Disallowed Resource Record Types.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_denylist": { "type": "array", "description": "List of domains to be denied by configuration object.", "maxItems": 30, "items": { "type": "string" }, "x-displayname": "Domain Deny list.", "x-ves-example": "www.f5.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-example": "www.f5.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "30", "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.etld_plus_one": "true" }, "x-f5xc-description-short": "List of domains to be denied by configuration object.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 30, "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": "Replace DNS Compliance Checks specification in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_compliance_checksReplaceSpecType", "required_fields": [ "domain_denylist" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain_denylist\": [\n \"value\"\n ]\n}", "example_yaml": "domain_denylist:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_compliance_checksStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of DNS Compliance Checks", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.dns_compliance_checks.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Reference to object for current status.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "verification_status": { "allOf": [ { "$ref": "#/components/schemas/dns_compliance_checksDNSComplianceChecksStatus" } ], "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 dns_compliance_checksStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "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": true }, "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": true }, "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": true }, "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": true }, "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": true }, "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": true }, "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": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "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": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "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": true }, "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": true }, "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": true }, "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": true }, "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": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaviewsObjectRefType": { "type": "object", "description": "This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name.", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.views.ObjectRefType", "properties": { "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "minLength": 1, "maxLength": 128, "x-displayname": "Name", "x-ves-example": "Contacts-route.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "contacts-route", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "dns_proxyCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_proxy", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_proxy.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/schemadns_proxyCreateSpecType" } ], "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 dns_proxyCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_proxy.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/schemadns_proxyGetSpecType" } ], "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 dns_proxyCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyDNSProxyDeploymentStatus": { "type": "string", "description": "Deployment Status of DNS Proxy\n\nDNS Proxy is successfully deployed and active\nDeployment of DNS Proxy is pending\nDNS Proxy has been disabled.\nDNS Proxy deployment encountered an error.", "title": "DNS PROXY Deployment Status", "enum": [ "DNS_PROXY_CONFIG_ACTIVE", "DNS_PROXY_CONFIG_PENDING", "DNS_PROXY_CONFIG_DISABLED", "DNS_PROXY_CONFIG_FAILED" ], "default": "DNS_PROXY_CONFIG_ACTIVE", "x-displayname": "DNS Proxy Deployment Status.", "x-ves-proto-enum": "ves.io.schema.dns_proxy.DNSProxyDeploymentStatus", "x-f5xc-description-short": "Deployment Status of DNS Proxy DNS Proxy is successfully deployed and active Deployment of DNS Proxy is pending DNS Proxy has been disabled.", "x-f5xc-description-medium": "Deployment Status of DNS Proxy DNS Proxy is successfully deployed and active Deployment of DNS Proxy is pending DNS Proxy has been disabled. DNS Proxy deployment encountered an error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyDNSProxyDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_PROXY_CONFIG_ACTIVE\"", "example_yaml": "DNS_PROXY_CONFIG_ACTIVE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyDNSProxyStatus": { "type": "object", "description": "Status DNS Proxy.", "title": "DNS Proxy Status", "x-displayname": "DNS Proxy Status.", "x-ves-proto-message": "ves.io.schema.dns_proxy.DNSProxyStatus", "properties": { "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyDNSProxyDeploymentStatus" } ], "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 dns_proxyDNSProxyStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_proxy", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_proxy.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 dns_proxyDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_proxy", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_proxy.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyCreateRequest" } ], "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/dns_proxyReplaceRequest" } ], "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/schemadns_proxyGetSpecType" } ], "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/dns_proxyStatusObject" }, "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 dns_proxyGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyHealthCheckType": { "type": "object", "description": "Server Health Check.", "title": "Server Health Check", "x-displayname": "Server Health Check.", "x-ves-oneof-field-choice": "[\"dns_health_check\",\"icmp_health_check\",\"tcp_health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_proxy.HealthCheckType", "properties": { "dns_health_check": { "allOf": [ { "$ref": "#/components/schemas/healthcheckDnsHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for dns health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "icmp_health_check", "tcp_health_check" ] }, "icmp_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for icmp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dns_health_check", "tcp_health_check" ] }, "tcp_health_check": { "allOf": [ { "$ref": "#/components/schemas/healthcheckDnsProxyTcpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dns_health_check", "icmp_health_check" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyHealthCheckType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyHealthChecks": { "type": "object", "description": "Origin Server Health Checks.", "title": "Origin Server Health Checks", "x-displayname": "Health Checks.", "x-ves-proto-message": "ves.io.schema.dns_proxy.HealthChecks", "properties": { "health_check": { "type": "array", "description": "List of Health Checks.", "title": "List of Health Checks", "maxItems": 4, "items": { "$ref": "#/components/schemas/dns_proxyHealthCheckType" }, "x-displayname": "List of Health Checks.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "0", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4", "ves.io.schema.rules.repeated.min_items": "0", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "minItems": 0, "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 } }, "healthy_threshold": { "type": "integer", "description": "Number of successful responses before declaring healthy. In other words, this is\nthe number of healthy health checks required before a host is marked\nhealthy. Note that during startup, only a single successful health check is\nrequired to mark a host healthy.", "title": "healthy threshold", "format": "int64", "x-displayname": "Healthy Threshold.", "x-ves-example": "2", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "2", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "Number of successful responses before declaring healthy.", "x-f5xc-description-medium": "Number of successful responses before declaring healthy. In other words, this is the number of healthy health checks required before a host is marked healthy. Note that during startup, only a single successful health check is required to mark a host healthy.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "interval": { "type": "integer", "description": "Time interval in seconds between two healthcheck requests.", "title": "interval", "format": "int64", "x-displayname": "Interval", "x-ves-example": "10", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "600" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "600" }, "x-f5xc-description-short": "Time interval in seconds between two healthcheck requests.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 600, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "timeout": { "type": "integer", "description": "Timeout in seconds to wait for successful response. In other words, it is\nthe time to wait for a health check response. If the timeout is reached the\nhealth check attempt will be considered a failure.", "title": "timeout", "format": "int64", "x-displayname": "Timeout", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "600" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "600" }, "x-f5xc-description-short": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response.", "x-f5xc-description-medium": "Timeout in seconds to wait for successful response. In other words, it is the time to wait for a health check response. If the timeout is reached the health check attempt will be considered a failure.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 600, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "unhealthy_threshold": { "type": "integer", "description": "Number of failed responses before declaring unhealthy. In other words, this is\nthe number of unhealthy health checks required before a host is marked\nunhealthy. Note that for HTTP health checking if a host responds with 503\nthis threshold is ignored and the host is considered unhealthy immediately.", "title": "unhealthy threshold", "format": "int64", "x-displayname": "Unhealthy Threshold.", "x-ves-example": "5", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-example": "5", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "16" }, "x-f5xc-description-short": "Number of failed responses before declaring unhealthy.", "x-f5xc-description-medium": "Number of failed responses before declaring unhealthy. In other words, this is the number of unhealthy health checks required before a host is marked unhealthy. Note that for HTTP health checking if a host responds with 503 this threshold is ignored and the host is considered unhealthy immediately.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 16, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyHealthChecks", "required_fields": [ "health_check", "healthy_threshold", "interval", "timeout", "unhealthy_threshold" ], "mutually_exclusive_groups": [], "example_json": "{\n \"health_check\": [\n {}\n ],\n \"healthy_threshold\": 1,\n \"interval\": 1,\n \"timeout\": 1,\n \"unhealthy_threshold\": 1\n}", "example_yaml": "health_check:\n- {}\nhealthy_threshold: 1\ninterval: 1\ntimeout: 1\nunhealthy_threshold: 1" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyLBAlgorithmType": { "type": "object", "description": "Load Balancing Algorithm Type.", "title": "Load Balancing Algorithm Type", "x-displayname": "Load Balancing Algorithm Type.", "x-ves-oneof-field-lb_algorithm_choice": "[\"round_robin\"]", "x-ves-proto-message": "ves.io.schema.dns_proxy.LBAlgorithmType", "properties": { "round_robin": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for round robin.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyLBAlgorithmType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_proxy", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_proxy.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/dns_proxyListResponseItem" }, "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 dns_proxyListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyListResponseItem": { "type": "object", "description": "By default a summary of dns_proxy 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 dns_proxy", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_proxy.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_proxy.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_proxy.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_proxy.", "title": "description", "x-displayname": "Description.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates dns_proxy is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_proxy is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemadns_proxyGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_proxy.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_proxy.", "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 dns_proxy.", "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/dns_proxyStatusObject" }, "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 dns_proxy.", "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 dns_proxy 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 dns_proxy 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 dns_proxyListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyOriginServers": { "type": "object", "description": "List of origin Servers for the DNS proxy.", "title": "OriginServers", "x-displayname": "Origin Servers.", "x-ves-proto-message": "ves.io.schema.dns_proxy.OriginServers", "properties": { "health_checks": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyHealthChecks" } ], "x-f5xc-description-short": "Configuration parameter for health checks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_servers": { "type": "array", "description": "List of origin servers for Proxy.", "title": "List of Origin Servers", "minItems": 1, "maxItems": 8, "items": { "$ref": "#/components/schemas/schemadns_proxyOriginServerType" }, "x-displayname": "List Of Origin Servers.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "8", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 8, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "List of origin Servers for the DNS proxy.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyOriginServers", "required_fields": [ "origin_servers" ], "mutually_exclusive_groups": [], "example_json": "{\n \"origin_servers\": [\n {}\n ]\n}", "example_yaml": "origin_servers:\n- {}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyProxyAdvertisementType": { "type": "object", "description": "Proxy Advertisement Type.", "title": "Proxy Advertisement Type", "x-displayname": "Proxy Advertisement Type.", "x-ves-oneof-field-advertise_choice": "[\"advertise_custom\",\"advertise_on_public\",\"advertise_on_public_default_vip\",\"do_not_advertise\"]", "x-ves-proto-message": "ves.io.schema.dns_proxy.ProxyAdvertisementType", "properties": { "advertise_custom": { "allOf": [ { "$ref": "#/components/schemas/viewsAdvertiseCustom__ves_io_schema_views_bigip_http_proxy" } ], "x-f5xc-description-short": "Configuration parameter for advertise custom.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "advertise_on_public_default_vip", "do_not_advertise" ] }, "advertise_on_public": { "allOf": [ { "$ref": "#/components/schemas/viewsAdvertisePublic" } ], "x-f5xc-description-short": "Configuration parameter for advertise on public.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_custom", "advertise_on_public_default_vip", "do_not_advertise" ] }, "advertise_on_public_default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_custom", "advertise_on_public", "do_not_advertise" ] }, "do_not_advertise": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for do not advertise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_custom", "advertise_on_public", "advertise_on_public_default_vip" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyProxyAdvertisementType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_proxy", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_proxy.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/schemadns_proxyReplaceSpecType" } ], "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 dns_proxyReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_proxy.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of DNS PROXY", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.dns_proxy.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Reference to object for current status.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "verification_status": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyDNSProxyStatus" } ], "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 dns_proxyStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_proxyTransportType": { "type": "string", "description": "Transport Type\n\n- UDP: UDP\n\n- TCP: TCP\n\n- BothTCPAndUDP: Both TCP and UDP.", "title": "Transport Type", "enum": [ "UDP", "TCP", "BothTCPAndUDP" ], "default": "UDP", "x-displayname": "Transport Type.", "x-ves-proto-enum": "ves.io.schema.dns_proxy.TransportType", "x-f5xc-description-short": "Transport Type - UDP: UDP - TCP: TCP - BothTCPAndUDP: Both TCP and UDP.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_proxyTransportType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UDP\"", "example_yaml": "UDP\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "healthcheckDNSQueryType": { "type": "string", "description": "DNS Query Type\n\n- DNS_QTYPE_A: Query Type A\n\n- DNS_QTYPE_AAAA: Query Type AAAA.", "title": "DNS Query Type", "enum": [ "DNS_QTYPE_A", "DNS_QTYPE_AAAA" ], "default": "DNS_QTYPE_A", "x-displayname": "DNS Query Type.", "x-ves-proto-enum": "ves.io.schema.healthcheck.DNSQueryType", "x-f5xc-description-short": "DNS Query Type - DNS_QTYPE_A: Query Type A - DNS_QTYPE_AAAA: Query Type AAAA.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for healthcheckDNSQueryType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_QTYPE_A\"", "example_yaml": "DNS_QTYPE_A\n..." }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "healthcheckDNSResponseRcodeType": { "type": "string", "description": "Expected DNS Response Rcode Type\n\n- DNS_RES_RCODE_NOERROR: Rcode NOERROR\n\n- DNS_RES_RCODE_ANY: RCODE ANY.", "title": "Expected DNS Response Rcode Type", "enum": [ "DNS_RES_RCODE_NOERROR", "DNS_RES_RCODE_ANY" ], "default": "DNS_RES_RCODE_NOERROR", "x-displayname": "DNS Response Rcode Type.", "x-ves-proto-enum": "ves.io.schema.healthcheck.DNSResponseRcodeType", "x-f5xc-description-short": "Expected DNS Response Rcode Type - DNS_RES_RCODE_NOERROR: Rcode NOERROR - DNS_RES_RCODE_ANY: RCODE ANY.", "x-f5xc-description-medium": "Expected DNS Response Rcode Type - DNS_RES_RCODE_NOERROR: Rcode NOERROR - DNS_RES_RCODE_ANY: RCODE ANY.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for healthcheckDNSResponseRcodeType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_RES_RCODE_NOERROR\"", "example_yaml": "DNS_RES_RCODE_NOERROR\n..." }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "healthcheckDNSResponseRecordType": { "type": "string", "description": "DNS Response Record Type\n\n- DNS_REQUESTED_QUERY_TYPE: Requested Query Type\n\n- DNS_RES_RECORD_TYPE_ANY: Any Record Type.", "title": "DNS Response Record Type", "enum": [ "DNS_REQUESTED_QUERY_TYPE", "DNS_RES_RECORD_TYPE_ANY" ], "default": "DNS_REQUESTED_QUERY_TYPE", "x-displayname": "DNS Response Record Type.", "x-ves-proto-enum": "ves.io.schema.healthcheck.DNSResponseRecordType", "x-f5xc-description-short": "DNS Response Record Type - DNS_REQUESTED_QUERY_TYPE: Requested Query Type - DNS_RES_RECORD_TYPE_ANY: Any Record Type.", "x-f5xc-description-medium": "DNS Response Record Type - DNS_REQUESTED_QUERY_TYPE: Requested Query Type - DNS_RES_RECORD_TYPE_ANY: Any Record Type.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for healthcheckDNSResponseRecordType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_REQUESTED_QUERY_TYPE\"", "example_yaml": "DNS_REQUESTED_QUERY_TYPE\n..." }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "healthcheckDnsHealthCheck": { "type": "object", "description": "DNS health check reports healthy if DNS query is successful and response header and answer matches the given value.", "title": "DNS Health Check", "x-displayname": "DNS Health Check.", "x-ves-displayorder": "2,3,4,5,6,7", "x-ves-proto-message": "ves.io.schema.healthcheck.DnsHealthCheck", "properties": { "expected_rcode": { "allOf": [ { "$ref": "#/components/schemas/healthcheckDNSResponseRcodeType" } ], "x-f5xc-description-short": "Configuration parameter for expected rcode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expected_record_type": { "allOf": [ { "$ref": "#/components/schemas/healthcheckDNSResponseRecordType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expected_response": { "type": "string", "description": "Specifies an IPv4 or IPv6 address in the answer section of DNS Response.", "title": "Expected Response Content", "maxLength": 1024, "x-displayname": "Expected Response Content.", "x-ves-example": "192.0.2.246.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "192.0.2.246", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "Specifies an IPv4 or IPv6 address in the answer section of DNS Response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "query_name": { "type": "string", "description": "The query name that the monitor sends a DNS query for.", "title": "Query Name", "minLength": 1, "maxLength": 255, "x-displayname": "Query Name.", "x-ves-example": "www.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "255", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-description-short": "The query name that the monitor sends a DNS query for.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 255, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "query_type": { "allOf": [ { "$ref": "#/components/schemas/healthcheckDNSQueryType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reverse": { "type": "boolean", "description": "Enable the monitor operation in reverse mode.\nWhen the monitor is in reverse mode, a successful receive\nstring match marks the monitored object down instead of up.", "title": "Use Reverse mode", "format": "boolean", "x-displayname": "Use Reverse mode.", "x-f5xc-example": "false", "x-f5xc-description-short": "Enable the monitor operation in reverse mode.", "x-f5xc-description-medium": "Enable the monitor operation in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "DNS health check reports healthy if DNS query is successful and response header and answer matches the given value.", "x-f5xc-description-medium": "DNS health check reports healthy if DNS query is successful and response header and answer matches the given value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for healthcheckDnsHealthCheck", "required_fields": [ "expected_response", "query_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"expected_response\": \"192.0.2.246\",\n \"query_name\": \"www.example.com\"\n}", "example_yaml": "expected_response: 192.0.2.246\nquery_name: www.example.com" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "healthcheckDnsProxyTcpHealthCheck": { "type": "object", "description": "Monitor reports healthy status if UDP connection is successful and response payload matches expected response pattern.", "title": "DnsProxyTcpHealthCheck", "x-displayname": "TCP Health Check.", "x-ves-proto-message": "ves.io.schema.healthcheck.DnsProxyTcpHealthCheck", "properties": { "expected_response": { "type": "string", "description": "Specifies a regular expression pattern which will be matched against response payload.", "title": "expected response", "maxLength": 2048, "x-displayname": "Expected Response pattern.", "x-ves-example": ".*", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": ".*", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-description-short": "Specifies a regular expression pattern which will be matched against response payload.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "send_payload": { "type": "string", "description": "Text string sent in the request.", "title": "send string", "maxLength": 2048, "x-displayname": "Send string.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Monitor reports healthy status if UDP connection is successful and response payload matches expected response pattern.", "x-f5xc-description-medium": "Monitor reports healthy status if UDP connection is successful and response payload matches expected response pattern.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for healthcheckDnsProxyTcpHealthCheck", "required_fields": [ "expected_response", "send_payload" ], "mutually_exclusive_groups": [], "example_json": "{\n \"expected_response\": \".*\",\n \"send_payload\": \"\\\"\\\"\"\n}", "example_yaml": "expected_response: .*\nsend_payload: '\"\"'" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "ioschemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "origin_poolOriginServerK8SService": { "type": "object", "description": "Specify origin server with K8s service name and site information.", "title": "OriginServerK8SService", "x-displayname": "K8s Service Name on given Sites.", "x-ves-displayorder": "10,12,2,3", "x-ves-oneof-field-network_choice": "[\"inside_network\",\"outside_network\",\"vk8s_networks\"]", "x-ves-oneof-field-service_info": "[\"service_name\"]", "x-ves-proto-message": "ves.io.schema.views.origin_pool.OriginServerK8SService", "properties": { "inside_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for inside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "outside_network", "vk8s_networks" ] }, "outside_network": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for outside network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_network", "vk8s_networks" ] }, "protocol": { "allOf": [ { "$ref": "#/components/schemas/origin_poolProtocolType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "service_name": { "type": "string", "description": "Exclusive with []\nK8s service name of the origin server will be listed, including the namespace and cluster-ID.\nFor vK8s services, you need to enter a string with the format servicename.namespace:example-namespace\"frontend\",\nnamespace is \"speedtest\" and cluster-ID is \"prod\", then you will enter \"frontend.speedtest:prod\".\nBoth namespace and cluster-ID are optional.", "title": "Service Name", "x-displayname": "Service Name.", "x-ves-example": "matching.default:production.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ves_service_namespace_name": "true" }, "x-f5xc-example": "matching.default:production", "x-validation-rules": { "ves.io.schema.rules.string.ves_service_namespace_name": "true" }, "x-f5xc-description-short": "Exclusive with [] K8s service name of the origin server will be listed, including the namespace and cluster-ID.", "x-f5xc-description-medium": "Exclusive with [] K8s service name of the origin server will be listed, including the namespace and cluster-ID. For vK8s services, you need to enter a string with the format servicename.namespace:example-namespace\"frontend\", namespace is \"speedtest\" and cluster-ID is \"prod\", then you will enter...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site_locator": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteLocator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "snat_pool": { "allOf": [ { "$ref": "#/components/schemas/viewsSnatPoolConfiguration" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "vk8s_networks": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for vk8s networks.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "inside_network", "outside_network" ] } }, "x-f5xc-description-short": "Specify origin server with K8s service name and site information.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for origin_poolOriginServerK8SService", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "origin_poolOriginServerPublicIP": { "type": "object", "description": "Specify origin server with public IP address.", "title": "OriginServerPublicIP", "x-displayname": "Public IP", "x-ves-displayorder": "2", "x-ves-oneof-field-public_ip_choice": "[\"ip\"]", "x-ves-proto-message": "ves.io.schema.views.origin_pool.OriginServerPublicIP", "properties": { "ip": { "type": "string", "description": "Exclusive with []\nPublic IPv4 address.", "title": "IP", "x-displayname": "Public IPv4.", "x-ves-example": "192.0.2.132.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Specify origin server with public IP address.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for origin_poolOriginServerPublicIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "origin_poolOriginServerPublicName": { "type": "object", "description": "Specify origin server with public DNS name.", "title": "OriginServerPublicName", "x-displayname": "Public DNS Name.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.origin_pool.OriginServerPublicName", "properties": { "dns_name": { "type": "string", "description": "DNS Name", "title": "DNS name", "minLength": 1, "maxLength": 256, "x-displayname": "DNS Name", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "256", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 256, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9.-]", "description": "Dot-separated DNS labels" }, "format": "hostname", "formatDescription": "RFC 1123 FQDN: lowercase, dot-separated labels, max 253 chars total", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$" }, "refresh_interval": { "type": "integer", "description": "Interval for DNS refresh in seconds.\nMax value is 7 days as per https://datatracker.ietf.org/doc/HTML/rfc8767.", "title": "refresh_interval", "format": "int64", "x-displayname": "DNS Refresh Interval.", "x-ves-example": "20", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,10-604800" }, "x-f5xc-example": "20", "x-validation-rules": { "ves.io.schema.rules.uint32.ranges": "0,10-604800" }, "x-f5xc-description-short": "Interval for DNS refresh in seconds. Max value is 7 days as per https://datatracker.ietf.org/doc/HTML/rfc8767.", "x-f5xc-description-medium": "Interval for DNS refresh in seconds. Max value is 7 days as per https://datatracker.ietf.org/doc/HTML/rfc8767.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 604800, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Specify origin server with public DNS name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for origin_poolOriginServerPublicName", "required_fields": [ "dns_name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"dns_name\": \"value\"\n}", "example_yaml": "dns_name: value" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "origin_poolProtocolType": { "type": "string", "description": "Type of protocol\n\n- PROTOCOL_TCP: TCP\n\n- PROTOCOL_UDP: UDP.", "title": "Protocol Type", "enum": [ "PROTOCOL_TCP", "PROTOCOL_UDP" ], "default": "PROTOCOL_TCP", "x-displayname": "Protocol Type.", "x-ves-proto-enum": "ves.io.schema.views.origin_pool.ProtocolType", "x-f5xc-description-short": "Type of protocol - PROTOCOL_TCP: TCP - PROTOCOL_UDP: UDP.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for origin_poolProtocolType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"PROTOCOL_TCP\"", "example_yaml": "PROTOCOL_TCP\n..." }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "networking", "multi_tenant_pattern": "per-tenant" } } }, "schemadns_proxyCreateSpecType": { "type": "object", "description": "Create DNS Proxy in a given namespace. If one already exists it will give an error.", "title": "Create DNS Proxy", "x-displayname": "Create DNS Proxy.", "x-ves-proto-message": "ves.io.schema.dns_proxy.CreateSpecType", "properties": { "cache_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSCacheProfile" } ], "x-f5xc-description-short": "Configuration parameter for cache profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSDDoSProfile" } ], "x-f5xc-description-short": "Configuration parameter for ddos profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "irules": { "type": "array", "description": "OPTIONS for attaching iRules to DNS proxy.", "maxItems": 16, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "IRules Ref.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "OPTIONS for attaching iRules to DNS proxy.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lb_algorithm": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyLBAlgorithmType" } ], "x-f5xc-description-short": "Configuration parameter for lb algorithm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_servers": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyOriginServers" } ], "x-f5xc-description-short": "Configuration parameter for origin servers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol_inspection": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "protocol_inspection", "field_path": "protocol_inspection", "gated_by": null, "required": false, "cardinality": "single" } ] }, "proxy_advertisement": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyProxyAdvertisementType" } ], "x-f5xc-description-short": "Configuration parameter for proxy advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transport_type": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyTransportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Create DNS Proxy in a given namespace. If one already exists it will give an error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_proxyCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_proxyGetSpecType": { "type": "object", "description": "GET DNS Proxy details.", "title": "Get DNS Proxy", "x-displayname": "GET DNS Proxy.", "x-ves-proto-message": "ves.io.schema.dns_proxy.GetSpecType", "properties": { "cache_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSCacheProfile" } ], "x-f5xc-description-short": "Configuration parameter for cache profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSDDoSProfile" } ], "x-f5xc-description-short": "Configuration parameter for ddos profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "irules": { "type": "array", "description": "OPTIONS for attaching iRules to DNS proxy.", "maxItems": 16, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "IRules Ref.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "OPTIONS for attaching iRules to DNS proxy.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lb_algorithm": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyLBAlgorithmType" } ], "x-f5xc-description-short": "Configuration parameter for lb algorithm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_servers": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyOriginServers" } ], "x-f5xc-description-short": "Configuration parameter for origin servers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol_inspection": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "protocol_inspection", "field_path": "protocol_inspection", "gated_by": null, "required": false, "cardinality": "single" } ] }, "proxy_advertisement": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyProxyAdvertisementType" } ], "x-f5xc-description-short": "Configuration parameter for proxy advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transport_type": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyTransportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_proxyGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_proxyOriginServerType": { "type": "object", "description": "Origin Server.", "title": "Origin Server", "x-displayname": "Origin Server.", "x-ves-oneof-field-choice": "[\"k8s_service\",\"public_ip\",\"public_name\"]", "x-ves-oneof-field-proximity_choice": "[\"no_preference\",\"site_preferences\"]", "x-ves-proto-message": "ves.io.schema.dns_proxy.OriginServerType", "properties": { "k8s_service": { "allOf": [ { "$ref": "#/components/schemas/origin_poolOriginServerK8SService" } ], "x-f5xc-description-short": "Configuration parameter for k8s service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "public_ip", "public_name" ] }, "no_preference": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no preference.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site_preferences" ] }, "public_ip": { "allOf": [ { "$ref": "#/components/schemas/origin_poolOriginServerPublicIP" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_service", "public_name" ] }, "public_name": { "allOf": [ { "$ref": "#/components/schemas/origin_poolOriginServerPublicName" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "k8s_service", "public_ip" ] }, "site_preferences": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsSiteReferenceListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_preference" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_proxyOriginServerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_proxyReplaceSpecType": { "type": "object", "description": "Replace DNS Proxy in a given namespace.", "title": "Replace DNS Proxy", "x-displayname": "Replace DNS Proxy.", "x-ves-proto-message": "ves.io.schema.dns_proxy.ReplaceSpecType", "properties": { "cache_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSCacheProfile" } ], "x-f5xc-description-short": "Configuration parameter for cache profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ddos_profile": { "allOf": [ { "$ref": "#/components/schemas/virtual_hostDNSDDoSProfile" } ], "x-f5xc-description-short": "Configuration parameter for ddos profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "irules": { "type": "array", "description": "OPTIONS for attaching iRules to DNS proxy.", "maxItems": 16, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "IRules Ref.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "OPTIONS for attaching iRules to DNS proxy.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "lb_algorithm": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyLBAlgorithmType" } ], "x-f5xc-description-short": "Configuration parameter for lb algorithm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "origin_servers": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyOriginServers" } ], "x-f5xc-description-short": "Configuration parameter for origin servers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "protocol_inspection": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "protocol_inspection", "field_path": "protocol_inspection", "gated_by": null, "required": false, "cardinality": "single" } ] }, "proxy_advertisement": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyProxyAdvertisementType" } ], "x-f5xc-description-short": "Configuration parameter for proxy advertisement.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "transport_type": { "allOf": [ { "$ref": "#/components/schemas/dns_proxyTransportType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_proxyReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS proxy is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemaviewsSiteReferenceListType": { "type": "object", "description": "Carries the references to one or more sites.", "title": "SiteReferenceListType", "x-displayname": "List of sites.", "x-ves-proto-message": "ves.io.schema.views.SiteReferenceListType", "properties": { "refs": { "type": "array", "description": "Reference to one or more sites.", "title": "Site References", "maxItems": 64, "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "Site References.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "64" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 64, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Carries the references to one or more sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsSiteReferenceListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsAdvertiseCustom__ves_io_schema_views_bigip_http_proxy": { "type": "object", "description": "This defines a way to advertise a VIP on specific sites.", "title": "AdvertiseWhere", "x-displayname": "Advertise Custom.", "x-ves-proto-message": "ves.io.schema.views.AdvertiseCustom", "properties": { "advertise_where": { "type": "array", "description": "Where should this load balancer be available.", "title": "Advertise Where", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/viewsWhereType__ves_io_schema_views_bigip_http_proxy" }, "x-displayname": "List of Sites to Advertise.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Where should this load balancer be available.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Defines a way to advertise a VIP on specific sites.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAdvertiseCustom", "required_fields": [ "advertise_where" ], "mutually_exclusive_groups": [], "example_json": "{\n \"advertise_where\": [\n {}\n ]\n}", "example_yaml": "advertise_where:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsAdvertisePublic": { "type": "object", "description": "This defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.", "title": "AdvertisePublic", "x-displayname": "Advertise Public.", "x-ves-proto-message": "ves.io.schema.views.AdvertisePublic", "properties": { "public_ip": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "public_ip", "field_path": "public_ip", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a way to advertise a load balancer on public.", "x-f5xc-description-medium": "Defines a way to advertise a load balancer on public. If optional public_ip is provided, it will only be advertised on RE sites where that public_ip is available.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsAdvertisePublic", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsPrefixStringListType": { "type": "object", "description": "List of IPv4 prefixes that represent an endpoint.", "title": "ipv4 prefix list", "x-displayname": "IPv4 Prefix List.", "x-ves-proto-message": "ves.io.schema.views.PrefixStringListType", "properties": { "prefixes": { "type": "array", "description": "List of IPv4 prefixes that represent an endpoint.", "title": "ipv4 prefix list", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "IPv4 Prefix List.", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "List of IPv4 prefixes that represent an endpoint.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-example": "192.0.2.0/24", "x-f5xc-description-short": "List of IPv4 prefixes that represent an endpoint.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsPrefixStringListType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsSiteLocator": { "type": "object", "description": "This message defines a reference to a site or virtual site object.", "title": "SiteLocator", "x-displayname": "Site or Virtual Site.", "x-ves-oneof-field-choice": "[\"site\",\"virtual_site\"]", "x-ves-proto-message": "ves.io.schema.views.SiteLocator", "properties": { "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "virtual_site" ], "x-f5xc-references": [ { "resource_kind": "site", "field_path": "site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Message defines a reference to a site or virtual site object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteLocator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteNetwork": { "type": "string", "description": "This defines network types to be used on site\n\nAll inside and outside networks.\nAll inside and outside networks with internet VIP support.\nAll inside networks.\nAll outside networks.\nAll outside networks with internet VIP support.\nVK8s service network.\n- SITE_NETWORK_IP_FABRIC: VER IP Fabric network for the site\n\nThis Virtual network type is used for exposing virtual host on IP Fabric network on the VER site or\nfor endpoint in IP Fabric network.", "title": "SiteNetwork", "enum": [ "SITE_NETWORK_INSIDE_AND_OUTSIDE", "SITE_NETWORK_INSIDE", "SITE_NETWORK_OUTSIDE", "SITE_NETWORK_SERVICE", "SITE_NETWORK_OUTSIDE_WITH_INTERNET_VIP", "SITE_NETWORK_INSIDE_AND_OUTSIDE_WITH_INTERNET_VIP", "SITE_NETWORK_IP_FABRIC" ], "default": "SITE_NETWORK_INSIDE_AND_OUTSIDE", "x-displayname": "Site Network.", "x-ves-proto-enum": "ves.io.schema.views.SiteNetwork", "x-f5xc-description-short": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support.", "x-f5xc-description-medium": "Defines network types to be used on site All inside and outside networks. All inside and outside networks with internet VIP support. All inside networks.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_NETWORK_INSIDE_AND_OUTSIDE\"", "example_yaml": "SITE_NETWORK_INSIDE_AND_OUTSIDE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSiteNetworkSpecifiedVIP": { "type": "string", "description": "This defines network types to be used on virtual-site with specified VIP\n\nAll outside networks.\nAll inside networks.", "title": "SiteNetworkSpecifiedVIP", "enum": [ "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE", "SITE_NETWORK_SPECIFIED_VIP_INSIDE" ], "default": "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE", "x-displayname": "Site Network.", "x-ves-proto-enum": "ves.io.schema.views.SiteNetworkSpecifiedVIP", "x-f5xc-description-short": "Defines network types to be used on virtual-site with specified VIP All outside networks.", "x-f5xc-description-medium": "Defines network types to be used on virtual-site with specified VIP All outside networks. All inside networks.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSiteNetworkSpecifiedVIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SITE_NETWORK_SPECIFIED_VIP_OUTSIDE\"", "example_yaml": "SITE_NETWORK_SPECIFIED_VIP_OUTSIDE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "viewsSnatPoolConfiguration": { "type": "object", "description": "SNAT Pool configuration.", "title": "SnatPoolConfiguration", "x-displayname": "SNAT Pool", "x-ves-oneof-field-snat_pool_choice": "[\"no_snat_pool\",\"snat_pool\"]", "x-ves-proto-message": "ves.io.schema.views.SnatPoolConfiguration", "properties": { "no_snat_pool": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for no snat pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "snat_pool" ] }, "snat_pool": { "allOf": [ { "$ref": "#/components/schemas/viewsPrefixStringListType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "no_snat_pool" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsSnatPoolConfiguration", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereSite": { "type": "object", "description": "This defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "title": "WhereSite", "x-displayname": "Site", "x-ves-displayorder": "1,2,3", "x-ves-proto-message": "ves.io.schema.views.WhereSite", "properties": { "ip": { "type": "string", "description": "Use given IP address as VIP on the site.", "title": "IP address on the site", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.132.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Use given IP address as VIP on the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetwork" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "site", "field_path": "site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a CE site along with network type and an optional IP address where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereType__ves_io_schema_views_bigip_http_proxy": { "type": "object", "description": "This defines various OPTIONS where a Loadbalancer could be advertised.", "title": "WhereType", "x-displayname": "Select Where to Advertise.", "x-ves-displayorder": "4,5", "x-ves-oneof-field-choice": "[\"advertise_on_public\",\"cloud_edge_segment\",\"segment\",\"site\",\"site_segment\",\"virtual_network\",\"virtual_site\",\"virtual_site_segment\",\"virtual_site_with_vip\",\"vk8s_service\"]", "x-ves-oneof-field-port_choice": "[\"port\",\"port_ranges\",\"use_default_port\"]", "x-ves-proto-message": "ves.io.schema.views.WhereType", "properties": { "advertise_on_public": { "allOf": [ { "$ref": "#/components/schemas/viewsAdvertisePublic" } ], "x-f5xc-description-short": "Configuration parameter for advertise on public.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "port": { "type": "integer", "description": "Exclusive with [port_ranges use_default_port]\nPort to Listen.", "title": "Port to listen", "format": "int64", "x-displayname": "Listen Port.", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "8080", "x-f5xc-description-short": "Exclusive with [port_ranges use_default_port] Port to Listen.", "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port_ranges", "use_default_port" ] }, "port_ranges": { "type": "string", "description": "Exclusive with [port use_default_port]\nA string containing a comma separated list of port ranges.\nEach port range consists of a single port or two ports separated by \"-\".", "title": "Port ranges to listen", "minLength": 1, "maxLength": 512, "x-displayname": "Listen Port Ranges.", "x-ves-example": "80,443,8080-8191,9080.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-example": "80,443,8080-8191,9080", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512", "ves.io.schema.rules.string.max_ports": "64", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.unique_port_range_list": "true" }, "x-f5xc-description-short": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges.", "x-f5xc-description-medium": "Exclusive with [port use_default_port] A string containing a comma separated list of port ranges. Each port range consists of a single port or two ports separated by \"-\".", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 512, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port", "use_default_port" ] }, "site": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "use_default_port": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "port", "port_ranges" ] }, "virtual_network": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVirtualNetwork" } ], "x-f5xc-description-short": "Configuration parameter for virtual network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_site", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVirtualSite" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site_segment", "virtual_site_with_vip", "vk8s_service" ] }, "virtual_site_with_vip": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVirtualSiteSpecifiedVIP" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "vk8s_service" ] }, "vk8s_service": { "allOf": [ { "$ref": "#/components/schemas/viewsWhereVK8SService" } ], "x-f5xc-description-short": "Configuration parameter for vk8s service.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "advertise_on_public", "cloud_edge_segment", "segment", "site", "site_segment", "virtual_network", "virtual_site", "virtual_site_segment", "virtual_site_with_vip" ] } }, "x-f5xc-description-short": "Defines various OPTIONS where a Loadbalancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVK8SService": { "type": "object", "description": "This defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "title": "WhereVK8SService", "x-displayname": "VK8s Services on RE.", "x-ves-displayorder": "3", "x-ves-oneof-field-choice": "[\"site\",\"virtual_site\"]", "x-ves-proto-message": "ves.io.schema.views.WhereVK8SService", "properties": { "site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "virtual_site" ], "x-f5xc-references": [ { "resource_kind": "site", "field_path": "site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "site" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": { "choice": "choice" }, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "x-f5xc-description-medium": "Defines a reference to a RE site or virtual site where a load balancer could be advertised in the vK8s service network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVK8SService", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVirtualNetwork": { "type": "object", "description": "Parameters to advertise on a given virtual network.", "title": "WhereVirtualNetwork", "x-displayname": "Virtual Network.", "x-ves-displayorder": "1,2,10", "x-ves-oneof-field-v6_vip_choice": "[\"default_v6_vip\",\"specific_v6_vip\"]", "x-ves-oneof-field-vip_choice": "[\"default_vip\",\"specific_vip\"]", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualNetwork", "properties": { "default_v6_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "specific_v6_vip" ] }, "default_vip": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "specific_vip" ] }, "specific_v6_vip": { "type": "string", "description": "Exclusive with [default_v6_vip]\nUse given IPv6 address as VIP on virtual Network.", "title": "Specific V6 VIP", "x-displayname": "Specific V6 VIP.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv6": "true" }, "x-f5xc-description-short": "Exclusive with [default_v6_vip] Use given IPv6 address as VIP on virtual Network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv6", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_v6_vip" ] }, "specific_vip": { "type": "string", "description": "Exclusive with [default_vip]\nUse given IPv4 address as VIP on virtual Network.", "title": "Specific VIP", "x-displayname": "Specific V4 VIP.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Exclusive with [default_vip] Use given IPv4 address as VIP on virtual Network.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_vip" ] }, "virtual_network": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for virtual network.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_network", "field_path": "virtual_network", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Parameters to advertise on a given virtual network.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVirtualNetwork", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVirtualSite": { "type": "object", "description": "This defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "title": "WhereVirtualSite", "x-displayname": "Virtual Site.", "x-ves-displayorder": "1,2", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualSite", "properties": { "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetwork" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVirtualSite", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "viewsWhereVirtualSiteSpecifiedVIP": { "type": "object", "description": "This defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "title": "WhereVirtualSiteSpecifiedVIP", "x-displayname": "Virtual Site with Specified VIP.", "x-ves-proto-message": "ves.io.schema.views.WhereVirtualSiteSpecifiedVIP", "properties": { "ip": { "type": "string", "description": "Use given IP address as VIP on the site.", "title": "IP address on the site", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.132.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.string.ipv4": "true" }, "x-f5xc-description-short": "Use given IP address as VIP on the site.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ipv4", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "network": { "allOf": [ { "$ref": "#/components/schemas/viewsSiteNetworkSpecifiedVIP" } ], "x-f5xc-example": "192.0.2.0/24", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_site": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "virtual_site", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-description-short": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "x-f5xc-description-medium": "Defines a reference to a customer site virtual site along with network type and IP where a load balancer could be advertised.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for viewsWhereVirtualSiteSpecifiedVIP", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "virtual_hostDNSCacheProfile": { "type": "object", "description": "DNS Cache specifies cache configuration.", "title": "DNS Cache", "x-displayname": "DNS Cache", "x-ves-oneof-field-cache_profile_choice": "[\"cache_size\",\"disable_cache_profile\"]", "x-ves-proto-message": "ves.io.schema.virtual_host.DNSCacheProfile", "properties": { "cache_size": { "type": "integer", "description": "Exclusive with [disable_cache_profile]\ncache size.", "title": "Cache size", "format": "int64", "x-displayname": "Cache size.", "x-ves-example": "1000", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "10240" }, "x-f5xc-example": "1000", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "10240" }, "x-f5xc-description-short": "Exclusive with [disable_cache_profile] cache size.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 10240, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_cache_profile" ] }, "disable_cache_profile": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable cache profile.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "cache_size" ] } }, "x-f5xc-description-short": "DNS Cache specifies cache configuration.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_hostDNSCacheProfile", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual host configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "virtual_hostDNSDDoSProfile": { "type": "object", "description": "DDoS Protection Rule for DNS.", "title": "DDoS Protection", "x-displayname": "DDoS Protection.", "x-ves-oneof-field-ddos_mitigation_choice": "[\"disable_ddos_mitigation\",\"enable_ddos_mitigation\"]", "x-ves-proto-message": "ves.io.schema.virtual_host.DNSDDoSProfile", "properties": { "disable_ddos_mitigation": { "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": [ "enable_ddos_mitigation" ] }, "enable_ddos_mitigation": { "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": [ "disable_ddos_mitigation" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for virtual_hostDNSDDoSProfile", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Virtual host configuration is platform-level" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_domain", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_domain.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/dns_domainCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_domain.CreateResponse", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/dns_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainCreateSpecType": { "type": "object", "description": "Create DNS Domain in a given namespace. If one already exist it will give a error.", "title": "Create DNS Domain", "x-displayname": "Create DNS Domain.", "x-ves-oneof-field-domain_choice": "[\"volterra_managed\"]", "x-ves-proto-message": "ves.io.schema.dns_domain.CreateSpecType", "properties": { "dnssec_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSSECMode" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_managed": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for volterra managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Create DNS Domain in a given namespace. If one already exist it will give a error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainDNSDomainStatus": { "type": "object", "description": "Status DNS Domain.", "title": "DNS Domain Status", "x-displayname": "DNS Domain Status.", "x-ves-proto-message": "ves.io.schema.dns_domain.DNSDomainStatus", "properties": { "dnssec_status": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSSECStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain_verification": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSDomainVerificationType" } ], "x-f5xc-description-short": "Configuration parameter for domain verification.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_nameservers": { "type": "array", "description": "Status of DNS domain verification process.", "title": "F5XC Nameservers", "items": { "type": "string" }, "x-displayname": "F5XC Nameservers.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Status of DNS domain verification process.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainDNSDomainStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainDNSDomainVerificationType": { "type": "string", "description": "Verification Status of DNS Domain\n\nVerification Status of DNS Domain has not succeeded yet\nVerification Status of DNS Domain is successful, sub domain can be used now\nVerification Status of DNS Domain has failed and this domain cannot be used.", "title": "DNS Domain Verification Type", "enum": [ "DNS_DOMAIN_VERIFICATION_PENDING", "DNS_DOMAIN_VERIFICATION_SUCCESS", "DNS_DOMAIN_VERIFICATION_FAILED" ], "default": "DNS_DOMAIN_VERIFICATION_PENDING", "x-displayname": "DNS Domain Verification Type.", "x-ves-proto-enum": "ves.io.schema.dns_domain.DNSDomainVerificationType", "x-f5xc-description-short": "Verification Status of DNS Domain Verification Status of DNS Domain has not succeeded yet Verification Status of DNS Domain is successful, sub...", "x-f5xc-description-medium": "Verification Status of DNS Domain Verification Status of DNS Domain has not succeeded yet Verification Status of DNS Domain is successful, sub domain can be used now Verification Status of DNS Domain has failed and this domain cannot be used.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainDNSDomainVerificationType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_DOMAIN_VERIFICATION_PENDING\"", "example_yaml": "DNS_DOMAIN_VERIFICATION_PENDING\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainDNSSECMode": { "type": "string", "description": "Enable or disable DNSSEC on the DNS Domain\n\nDNSSEC is disabled\nDNSSEC is enabled.", "title": "DNSSEC Mode", "enum": [ "DNSSEC_DISABLE", "DNSSEC_ENABLE" ], "default": "DNSSEC_DISABLE", "x-displayname": "DNSSEC Mode.", "x-ves-proto-enum": "ves.io.schema.dns_domain.DNSSECMode", "x-f5xc-description-short": "Enable or disable DNSSEC on the DNS Domain DNSSEC is disabled DNSSEC is enabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainDNSSECMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNSSEC_DISABLE\"", "example_yaml": "DNSSEC_DISABLE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainDNSSECStatus": { "type": "object", "description": "Status of DNSSEC in DNS Domain.", "title": "DNSSEC Status", "x-displayname": "DNSSEC Status.", "x-ves-proto-message": "ves.io.schema.dns_domain.DNSSECStatus", "properties": { "algorithm": { "type": "string", "description": "Signing algorithm used.", "title": "Algorithm", "x-displayname": "Algorithm", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "digest": { "type": "string", "description": "DNSSEC Digest.", "title": "Digest", "x-displayname": "Digest", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "digest_type": { "type": "string", "description": "Type of DNSSEC digest that follows.", "title": "Digest Type", "x-displayname": "Digest 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 } }, "flags": { "type": "string", "description": "DNSSEC Flags.", "title": "Flags", "x-displayname": "Flags", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key_tag": { "type": "string", "description": "Key tag of DNSSEC, when enabled.", "title": "Key Tag", "x-displayname": "Key Tag", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mode": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSSECMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_key": { "type": "string", "description": "The zone's public key.", "title": "Public Key", "x-displayname": "Public Key.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "crypto", "maxLength": 1024, "minLength": 100, "pattern": "^-----BEGIN (RSA |EC |)?(PRIVATE |PUBLIC )?KEY-----\\n.*\\n-----END (RSA |EC |)?(PRIVATE |PUBLIC )?KEY-----$", "format": "pem", "byteLength": { "min": 100, "max": 5242880 }, "validation": { "standard": "PEM" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ttl": { "type": "integer", "description": "TTL value for DS record.", "title": "TTL", "format": "int64", "x-displayname": "TTL", "x-f5xc-example": "300", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainDNSSECStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_domain", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_domain.DeleteRequest", "properties": { "fail_if_referred": { "type": "boolean", "description": "Fail the DELETE operation if this object is being referred by other objects.", "title": "fail_if_referred", "format": "boolean", "x-displayname": "Fail-If-Referred.", "x-f5xc-description-short": "Fail the DELETE operation if this object is being referred by other objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the configuration object.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "Namespace in which the configuration object is present.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "Namespace in which the configuration object is present.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_domain", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_domain.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_domainCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/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/dns_domainReplaceRequest" } ], "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/dns_domainGetSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/dns_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "resource_version": { "type": "string", "x-f5xc-concurrency-token": { "server_assigned": true, "echo_on_operations": [ "replace" ] } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainGetSpecType": { "type": "object", "description": "GET network policy set in a given namespace.", "title": "Get DNS Domain", "x-displayname": "GET DNS Domain.", "x-ves-oneof-field-domain_choice": "[\"volterra_managed\"]", "x-ves-proto-message": "ves.io.schema.dns_domain.GetSpecType", "properties": { "dnssec_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSSECMode" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "domain": { "type": "string", "description": "Domain name for routing and identification", "x-f5xc-example": "example.com", "x-f5xc-description-short": "Domain name for routing and identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "txt_record": { "type": "string", "description": "Value of the TXT record, that is programmed in your DNS provided TXT record for this sub domain.", "x-displayname": "TXT Record.", "x-f5xc-description-short": "Value of the TXT record, that is programmed in your DNS provided TXT record for this sub domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_managed": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for volterra managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "GET network policy set in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_domain", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_domain.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" }, "x-displayname": "Errors", "x-f5xc-description-short": "Errors(if any) while listing items from collection.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Items represents the collection in response.", "title": "items", "items": { "$ref": "#/components/schemas/dns_domainListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Items represents the collection in response.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainListResponseItem": { "type": "object", "description": "By default a summary of dns_domain is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.", "title": "ListResponseItem is an individual item in a collection of dns_domain", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_domain.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_domain.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_domain.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this dns_domain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disabled": { "type": "boolean", "description": "A value of true indicates dns_domain is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_domain is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/dns_domainGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_domain.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_domain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "The name of this dns_domain.", "title": "name", "x-displayname": "Name", "x-ves-example": "Name", "x-f5xc-example": "name", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "The namespace this item belongs to.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "status_set": { "type": "array", "description": "The status reported by different services for this configuration object.", "title": "status", "items": { "$ref": "#/components/schemas/dns_domainStatusObject" }, "x-displayname": "Status", "x-f5xc-description-short": "The status reported by different services for this configuration object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "system_metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tenant": { "type": "string", "description": "The tenant this item belongs to.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "The unique uid of this dns_domain.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d36e055b3ea2.", "x-f5xc-example": "00000000-0000-4000-8000-d36e055b3ea2", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "By default a summary of dns_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-description-medium": "By default a summary of dns_domain is returned in 'List'. By setting 'report_fields' in the ListRequest more details of each item can be got.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_domain", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_domain.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/dns_domainReplaceSpecType" } ], "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 dns_domainReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_domain.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainReplaceSpecType": { "type": "object", "description": "Replace DNS Domain in a given namespace.", "title": "Replace DNS Domain", "x-displayname": "Replace DNS Domain.", "x-ves-oneof-field-domain_choice": "[\"volterra_managed\"]", "x-ves-proto-message": "ves.io.schema.dns_domain.ReplaceSpecType", "properties": { "dnssec_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSSECMode" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_managed": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for volterra managed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Replace DNS Domain in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status of DNS Domain", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.dns_domain.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "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 } }, "verification_status": { "allOf": [ { "$ref": "#/components/schemas/dns_domainDNSDomainStatus" } ], "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 dns_domainStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainVerifyDnsDomainRequest": { "type": "object", "description": "DNS domain request verification shape.", "title": "Verify DNS Domain Request", "x-displayname": "Verify DNS Domain.", "x-ves-proto-message": "ves.io.schema.dns_domain.VerifyDnsDomainRequest", "properties": { "name": { "type": "string", "description": "Name dns_domain object, which also domain name.", "title": "Name", "x-displayname": "Name", "x-ves-example": "example.com.", "x-f5xc-example": "example.com", "x-f5xc-description-short": "Name dns_domain object, which also domain 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 is always system for dns_domain.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "Namespace is always system for dns_domain.", "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 dns_domainVerifyDnsDomainRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_domainVerifyDnsDomainResponse": { "type": "object", "description": "Verify DNS domain Response.", "title": "Verify Response", "x-displayname": "Verify Response.", "x-ves-proto-message": "ves.io.schema.dns_domain.VerifyDnsDomainResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_domainVerifyDnsDomainResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS domain management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_load_balancer", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/schemadns_load_balancerCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "DNS-based load balancer for geolocation and health-aware DNS responses", "required_fields": [ "metadata.name", "metadata.namespace", "spec.rule_list", "spec.rule_list.rules" ], "mutually_exclusive_groups": [], "example_yaml": "metadata:\n name: example-dns-lb\n namespace: system\nspec:\n rule_list:\n rules:\n - pool:\n name: example-pool\n namespace: system\n score: 100\n ip_prefix_list:\n ip_prefixes:\n - \"0.0.0.0/0\"\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-dns-lb\",\n \"namespace\": \"system\"\n },\n \"spec\": {\n \"rule_list\": {\n \"rules\": [{\n \"pool\": {\"name\": \"example-pool\", \"namespace\": \"system\"},\n \"score\": 100,\n \"ip_prefix_list\": {\"ip_prefixes\": [\"0.0.0.0/0\"]}\n }]\n }\n }\n}\n" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.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/schemadns_load_balancerGetSpecType" } ], "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 dns_load_balancerCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBHealthStatusListResponse": { "type": "object", "description": "Response for DNS Load Balancer Health Status List Request.", "title": "DNSLBHealthStatusListResponse", "x-displayname": "DNS Load Balancer Health Status List Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBHealthStatusListResponse", "properties": { "dns_lb_pools_status_summary": { "type": "array", "description": "Summary of DNS Load Balancer Pools by Health Status.", "title": "DNS Load Balancer Pools Status Summary", "items": { "$ref": "#/components/schemas/dns_load_balancerHealthStatusSummary" }, "x-displayname": "DNS Load Balancer Pools Status Summary.", "x-f5xc-description-short": "Summary of DNS Load Balancer Pools by Health Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_load_balancer_status_summary": { "type": "array", "description": "Summary of DNS Load Balancers by Health Status.", "title": "DNS Load Balancer Status Summary", "items": { "$ref": "#/components/schemas/dns_load_balancerHealthStatusSummary" }, "x-displayname": "DNS Load Balancer Pools Summary.", "x-f5xc-description-short": "Summary of DNS Load Balancers by Health Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Collection of DNS Load Balancer Health status.", "title": "Items", "items": { "$ref": "#/components/schemas/dns_load_balancerDNSLBHealthStatusListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Collection of DNS Load Balancer Health status.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for DNS Load Balancer Health Status List Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBHealthStatusListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBHealthStatusListResponseItem": { "type": "object", "description": "Individual item in a collection of DNS Load Balancer.", "title": "DNSLBHealthStatusListResponseItem", "x-displayname": "DNS Load Balancer Health Status List Item.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBHealthStatusListResponseItem", "properties": { "dns_lb_pools_status_summary": { "type": "array", "description": "Summary of DNS Load Balancer Pools by Health Status.", "title": "DNS Load Balancer Pools Status Summary", "items": { "$ref": "#/components/schemas/dns_load_balancerHealthStatusSummary" }, "x-displayname": "DNS Load Balancer Pools Status Summary.", "x-f5xc-description-short": "Summary of DNS Load Balancer Pools by Health Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the DNS Load Balancer.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Dns_lb1", "x-f5xc-example": "dns_lb1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "type": "array", "description": "Health Status of DNS Load Balancer.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Individual item in a collection of DNS Load Balancer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBHealthStatusListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBHealthStatusResponse": { "type": "object", "description": "Response for DNS Load Balancer Health Status Request.", "title": "DNSLBHealthStatusResponse", "x-displayname": "DNS Load Balancer Health Status Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBHealthStatusResponse", "properties": { "dns_lb_pool_items": { "type": "array", "description": "Collection of DNS Load Balancer Pools.", "title": "DNS Load Balancer Pool Items", "items": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolHealthStatusListResponseItem" }, "x-displayname": "DNS Load Balancer Pool Items.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "Health Status of DNS Load Balancer.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Response for DNS Load Balancer Health Status Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBHealthStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolHealthStatusListResponseItem": { "type": "object", "description": "Individual item in a collection of DNS Load Balancer Pool.", "title": "DNSLBPoolHealthStatusListResponseItem", "x-displayname": "DNS Load Balancer Pool Health Status List Item.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolHealthStatusListResponseItem", "properties": { "dns_lb_pool_members_status_summary": { "type": "array", "description": "Summary of DNS Load Balancer Pool Members by Health Status.", "title": "DNS Load Balancer Pool Members Status Summary", "items": { "$ref": "#/components/schemas/dns_load_balancerHealthStatusSummary" }, "x-displayname": "DNS Load Balancer Pool Members Status Summary.", "x-f5xc-description-short": "Summary of DNS Load Balancer Pool Members by Health Status.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "health_check_type": { "type": "string", "description": "Health Check Type associated with the DNS Load Balancer Pool.", "title": "Health Check Type", "x-displayname": "Health Check Type.", "x-ves-example": "HTTP", "x-f5xc-example": "HTTP", "x-f5xc-description-short": "Health Check Type associated with the DNS Load Balancer Pool.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the DNS Load Balancer Pool.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Dns_lb_pool1.", "x-f5xc-example": "dns_lb_pool1", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "status": { "type": "array", "description": "Health Status of DNS Load Balancer Pool.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "Health Status of DNS Load Balancer Pool.", "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": "Individual item in a collection of DNS Load Balancer Pool.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolHealthStatusListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolHealthStatusResponse": { "type": "object", "description": "Response for DNS Load Balancer Pool Health Status Request.", "title": "DNSLBPoolHealthStatusResponse", "x-displayname": "DNS Load Balancer Pool Health Status Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolHealthStatusResponse", "properties": { "dns_lb_pool_member_items": { "type": "array", "description": "Collection of DNS Load Balancer Pool Members.", "title": "DNS Load Balancer Pool Members", "items": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolMemberHealthStatusListResponseItem" }, "x-displayname": "DNS Load Balancer Pool Member Items.", "x-f5xc-description-short": "Collection of DNS Load Balancer Pool Members.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "Health Status of DNS Load Balancer Pool.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "Health Status of DNS Load Balancer Pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Response for DNS Load Balancer Pool Health Status Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolHealthStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolMemberHealthStatusEvent": { "type": "object", "description": "Pool member health status change event data.", "title": "DNSLBPoolMemberHealthStatusEvent", "x-displayname": "DNS Load Balancer Pool Member Health Status Event.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolMemberHealthStatusEvent", "properties": { "error_code": { "allOf": [ { "$ref": "#/components/schemas/schemadns_load_balancerErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_description": { "type": "string", "description": "Error Description of DNS Load Balancer Pool Member health check failure.", "title": "Error Description", "x-displayname": "Error Description.", "x-ves-example": "Received string mismatch.", "x-f5xc-example": "received string mismatch", "x-f5xc-description-short": "Error Description of DNS Load Balancer Pool Member health check 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 } }, "pool_member_address": { "type": "string", "description": "Address of pool member.", "title": "Pool Member Address", "x-displayname": "Pool Member Address.", "x-ves-example": "192.0.2.246.", "x-f5xc-example": "192.0.2.246", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "array", "description": "Health status of pool member.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Pool member health status change event data.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolMemberHealthStatusEvent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolMemberHealthStatusListResponse": { "type": "object", "description": "Response for DNS Load Balancer Pool Member Health Status List Request.", "title": "DNSLBPoolMemberHealthStatusListResponse", "x-displayname": "DNS Load Balancer Pool Member Health Status List Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolMemberHealthStatusListResponse", "properties": { "items": { "type": "array", "description": "Collection of DNS Load Balancer Pool Member Health Status.", "title": "Items", "items": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolMemberHealthStatusListResponseItem" }, "x-displayname": "Items", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Collection of DNS Load Balancer Pool Member Health Status.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for DNS Load Balancer Pool Member Health Status List Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolMemberHealthStatusListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolMemberHealthStatusListResponseItem": { "type": "object", "description": "Individual item in a collection of DNS Load Balancer Pool Member.", "title": "DNSLBPoolMemberHealthStatusListResponseItem", "x-displayname": "DNS Load Balancer Pool Member Health Status List Item.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolMemberHealthStatusListResponseItem", "properties": { "dns_lb_name": { "type": "string", "description": "Name of the DNS Load Balancer containing the Pool Member.", "title": "DNS Load Balancer Name", "x-displayname": "DNS Load Balancer Name.", "x-ves-example": "Dns_lb1", "x-f5xc-example": "dns_lb1", "x-f5xc-description-short": "Name of the DNS Load Balancer containing the Pool Member.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dns_lb_pool_name": { "type": "string", "description": "Name of the DNS Load Balancer Pool.", "title": "DNS Load Balancer Pool Name", "x-displayname": "DNS Load Balancer Pool Name.", "x-ves-example": "Dns_lb_pool1.", "x-f5xc-example": "dns_lb_pool1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_code": { "allOf": [ { "$ref": "#/components/schemas/schemadns_load_balancerErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_description": { "type": "string", "description": "Error Description of DNS Load Balancer Pool Member health check failure.", "title": "Error Description", "x-displayname": "Error Description.", "x-ves-example": "Received string mismatch.", "x-f5xc-example": "received string mismatch", "x-f5xc-description-short": "Error Description of DNS Load Balancer Pool Member health check 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 } }, "health_check_type": { "type": "string", "description": "Health Check Type associated with the Pool Member.", "title": "Health Check Type", "x-displayname": "Health Check Type.", "x-ves-example": "HTTP", "x-f5xc-example": "HTTP", "x-f5xc-description-short": "Health Check Type associated with the Pool Member.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_status_code": { "allOf": [ { "$ref": "#/components/schemas/schemaHttpStatusCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Name of the DNS Load Balancer Pool Member.", "title": "Name", "x-displayname": "Name", "x-ves-example": "Dns_lb_pool_member1.", "x-f5xc-example": "dns_lb_pool_member1", "x-f5xc-description-short": "Name of the DNS Load Balancer Pool Member.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "ports": { "type": "array", "description": "Ports targeted for health check of the endpoint.", "title": "Port Number", "maxItems": 2, "items": { "type": "integer", "format": "int64" }, "x-displayname": "Port Number.", "x-ves-example": "8080", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "2" }, "x-f5xc-example": "8080", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "2" }, "x-f5xc-description-short": "Ports targeted for health check of the endpoint.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 2, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "array", "description": "Health Status of DNS Load Balancer Pool Member.", "title": "Status", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Status", "x-f5xc-example": "active", "x-f5xc-description-short": "Health Status of DNS Load Balancer Pool Member.", "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" }, "unhealthy_ports": { "type": "array", "description": "Ports which were either unreachable or failed health checks.", "title": "Unhealthy Ports", "maxItems": 2, "items": { "type": "integer", "format": "int64" }, "x-displayname": "Unhealthy Ports.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "2" }, "x-f5xc-example": "[80, 443]", "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "2" }, "x-f5xc-description-short": "Ports which were either unreachable or failed health checks.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 2, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Individual item in a collection of DNS Load Balancer Pool Member.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolMemberHealthStatusListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDNSLBPoolMemberHealthStatusResponse": { "type": "object", "description": "Response for DNS Load Balancer Pool Member Health Status Events Request.", "title": "DNSLBPoolMemberHealthStatusResponse", "x-displayname": "DNS Load Balancer Pool Member Health Status Events Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.DNSLBPoolMemberHealthStatusResponse", "properties": { "dns_lb_pool_member_events": { "type": "array", "description": "Collection of DNS Load Balancer Pool Members.", "title": "DNS Load Balancer Pool Members", "items": { "$ref": "#/components/schemas/dns_load_balancerDNSLBPoolMemberHealthStatusEvent" }, "x-displayname": "DNS Load Balancer Pool Member Items.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Collection of DNS Load Balancer Pool Members.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Response for DNS Load Balancer Pool Member Health Status Events Request.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerDNSLBPoolMemberHealthStatusResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_load_balancer", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.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 dns_load_balancerDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_load_balancer", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerCreateRequest" } ], "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/dns_load_balancerReplaceRequest" } ], "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/schemadns_load_balancerGetSpecType" } ], "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/schemadns_load_balancerStatusObject" }, "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 dns_load_balancerGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerHealthStatus": { "type": "string", "description": "Enumerates Health Status of DNS LB and associated objects\n\n- HEALTH_STATUS_UNHEALTHY: Unhealthy\n\n- HEALTH_STATUS_DEGRADED: Degraded\n\n- HEALTH_STATUS_HEALTHY: Healthy\n\n- HEALTH_STATUS_DISABLED: Disabled.", "title": "HealthStatus", "enum": [ "HEALTH_STATUS_UNHEALTHY", "HEALTH_STATUS_DEGRADED", "HEALTH_STATUS_HEALTHY", "HEALTH_STATUS_DISABLED" ], "default": "HEALTH_STATUS_UNHEALTHY", "x-displayname": "Health Status.", "x-ves-proto-enum": "ves.io.schema.dns_load_balancer.HealthStatus", "x-f5xc-description-short": "Enumerates Health Status of DNS LB and associated objects - HEALTH_STATUS_UNHEALTHY: Unhealthy - HEALTH_STATUS_DEGRADED: Degraded ...", "x-f5xc-description-medium": "Enumerates Health Status of DNS LB and associated objects - HEALTH_STATUS_UNHEALTHY: Unhealthy - HEALTH_STATUS_DEGRADED: Degraded - HEALTH_STATUS_HEALTHY: Healthy - HEALTH_STATUS_DISABLED: Disabled.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerHealthStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"HEALTH_STATUS_UNHEALTHY\"", "example_yaml": "HEALTH_STATUS_UNHEALTHY\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerHealthStatusSummary": { "type": "object", "description": "Health Status Summary.", "title": "HealthStatusSummary", "x-displayname": "Health Status Summary.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.HealthStatusSummary", "properties": { "count": { "type": "array", "description": "Number of objects.", "title": "Count", "items": { "$ref": "#/components/schemas/schemaMetricValue" }, "x-displayname": "Count", "x-f5xc-example": "42", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerHealthStatus" } ], "x-f5xc-example": "active", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 17, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerHealthStatusSummary", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_load_balancer", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ListResponse", "properties": { "errors": { "type": "array", "description": "Errors(if any) while listing items from collection.", "title": "errors", "items": { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_tenant_management_child_tenant" }, "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/dns_load_balancerListResponseItem" }, "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 dns_load_balancerListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerListResponseItem": { "type": "object", "description": "By default a summary of dns_load_balancer 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 dns_load_balancer", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_load_balancer.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_load_balancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_load_balancer.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this dns_load_balancer.", "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 dns_load_balancer is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_load_balancer is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/schemadns_load_balancerGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_load_balancer.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_load_balancer.", "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 dns_load_balancer.", "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/schemadns_load_balancerStatusObject" }, "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 dns_load_balancer.", "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 dns_load_balancer.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 dns_load_balancer 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 dns_load_balancer 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 dns_load_balancerListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerLoadBalancingRule": { "type": "object", "title": "DNS Load Balancing Rule", "x-displayname": "Load Balancing Rule.", "x-ves-oneof-field-action_choice": "[\"pool\"]", "x-ves-oneof-field-client_choice": "[\"asn_list\",\"asn_matcher\",\"geo_location_label_selector\",\"geo_location_set\",\"ip_prefix_list\",\"ip_prefix_set\"]", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.LoadBalancingRule", "properties": { "asn_list": { "allOf": [ { "$ref": "#/components/schemas/policyAsnMatchList" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_matcher", "geo_location_label_selector", "geo_location_set", "ip_prefix_list", "ip_prefix_set" ] }, "asn_matcher": { "allOf": [ { "$ref": "#/components/schemas/policyAsnMatcherType" } ], "x-f5xc-description-short": "Configuration parameter for asn matcher.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_list", "geo_location_label_selector", "geo_location_set", "ip_prefix_list", "ip_prefix_set" ] }, "geo_location_label_selector": { "allOf": [ { "$ref": "#/components/schemas/schemaLabelSelectorType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_list", "asn_matcher", "geo_location_set", "ip_prefix_list", "ip_prefix_set" ] }, "geo_location_set": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for geo location set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_list", "asn_matcher", "geo_location_label_selector", "ip_prefix_list", "ip_prefix_set" ], "x-f5xc-references": [ { "resource_kind": "geo_location_set", "field_path": "geo_location_set", "gated_by": { "choice": "client_choice" }, "required": false, "cardinality": "single" } ] }, "ip_prefix_list": { "allOf": [ { "$ref": "#/components/schemas/policyPrefixMatchList" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_list", "asn_matcher", "geo_location_label_selector", "geo_location_set", "ip_prefix_set" ] }, "ip_prefix_set": { "allOf": [ { "$ref": "#/components/schemas/policyIpMatcherType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "asn_list", "asn_matcher", "geo_location_label_selector", "geo_location_set", "ip_prefix_list" ] }, "pool": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "origin_pool", "field_path": "pool", "gated_by": { "choice": "action_choice" }, "required": false, "cardinality": "single" } ] }, "score": { "type": "integer", "description": "When multiple load balancing rules match a query, the one with the highest score is chosen.", "title": "Score", "format": "int64", "x-displayname": "Score", "x-ves-example": "50", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32767" }, "x-f5xc-example": "50", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32767" }, "x-f5xc-description-short": "When multiple load balancing rules match a query, the one with the highest score is chosen.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 32767, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerLoadBalancingRule", "required_fields": [ "score" ], "mutually_exclusive_groups": [], "example_json": "{\n \"score\": 1\n}", "example_yaml": "score: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerLoadBalancingRuleList": { "type": "object", "description": "List of the Load Balancing Rules.", "title": "Load Balancing Rule List", "x-displayname": "Load Balancing Rule List.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.LoadBalancingRuleList", "properties": { "rules": { "type": "array", "description": "Rules to perform load balancing.", "title": "Load Balancing Rules", "minItems": 1, "maxItems": 64, "items": { "$ref": "#/components/schemas/dns_load_balancerLoadBalancingRule" }, "x-displayname": "Load Balancing Rules.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "64", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 64, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerLoadBalancingRuleList", "required_fields": [ "rules" ], "mutually_exclusive_groups": [], "example_json": "{\n \"rules\": [\n {\n \"score\": 1\n }\n ]\n}", "example_yaml": "rules:\n- score: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_load_balancer", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.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/schemadns_load_balancerReplaceSpecType" } ], "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": "DNS-based load balancer for geolocation and health-aware DNS responses", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerResourceRecordType": { "type": "string", "description": "Resource Record Type\n\n- A: A\n\n- AAAA: AAAA\n\n- MX: MX\n\n- CNAME: CNAME\n\n- SRV: SRV.", "title": "Resource Record Type", "enum": [ "A", "AAAA", "MX", "CNAME", "SRV" ], "default": "A", "x-displayname": "Resource Record Type.", "x-ves-proto-enum": "ves.io.schema.dns_load_balancer.ResourceRecordType", "x-f5xc-description-short": "Resource Record Type - A: A - AAAA: AAAA - MX: MX - CNAME: CNAME - SRV: SRV.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerResourceRecordType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"A\"", "example_yaml": "A\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerResponseCache": { "type": "object", "description": "Response Cache\nx-required.", "title": "Response Cache", "x-displayname": "Response Cache.", "x-ves-oneof-field-response_cache_parameters_choice": "[\"default_response_cache_parameters\",\"disable\",\"response_cache_parameters\"]", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ResponseCache", "properties": { "default_response_cache_parameters": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for default response cache parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable", "response_cache_parameters" ] }, "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_response_cache_parameters", "response_cache_parameters" ] }, "response_cache_parameters": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResponseCacheParameters" } ], "x-f5xc-description-short": "Configuration parameter for response cache parameters.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "default_response_cache_parameters", "disable" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerResponseCache", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerResponseCacheParameters": { "type": "object", "title": "Response Cache Parameters", "x-displayname": "Response Cache Parameters.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ResponseCacheParameters", "properties": { "cache_cidr_ipv4": { "type": "integer", "description": "Length of CIDR masks used to group IPv4 clients.", "title": "Length of IPv4 CIDR masks", "format": "int64", "x-displayname": "Length of IPv4 CIDR masks.", "x-ves-example": "24", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "24", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Length of CIDR masks used to group IPv4 clients.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cache_cidr_ipv6": { "type": "integer", "description": "Length of CIDR masks used to group IPv6 clients.", "title": "Length of IPv6 CIDR masks", "format": "int64", "x-displayname": "Length of IPv6 CIDR masks.", "x-ves-example": "56", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "128" }, "x-f5xc-example": "56", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "128" }, "x-f5xc-description-short": "Length of CIDR masks used to group IPv6 clients.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 128, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "cache_ttl": { "type": "integer", "description": "TTL for response cache.", "title": "TTL", "format": "int64", "x-displayname": "TTL", "x-ves-example": "3600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0" }, "x-f5xc-example": "3600", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerResponseCacheParameters", "required_fields": [ "cache_cidr_ipv6" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cache_cidr_ipv6\": 1\n}", "example_yaml": "cache_cidr_ipv6: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_load_balancerSuggestValuesReq": { "type": "object", "description": "Request body of SuggestValues request.", "title": "SuggestValuesReq", "x-displayname": "Request for SuggestValues.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.SuggestValuesReq", "properties": { "field_path": { "type": "string", "description": "JSON path of the field for which the suggested values are being requested.", "title": "field_path", "maxLength": 1024, "x-displayname": "Field Path.", "x-ves-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-example": "spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024" }, "x-f5xc-description-short": "JSON path of the field for which the suggested values are being requested.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "match_value": { "type": "string", "description": "A substring that must be present in either the value or description of each SuggestedItem in the response.", "title": "match_value", "maxLength": 256, "x-displayname": "Match Value.", "x-ves-example": "Some-substring.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "some-substring", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-description-short": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-description-medium": "Substring that must be present in either the value or description of each SuggestedItem in the response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace in which the suggestions are scoped.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Foobar", "x-f5xc-example": "foobar", "x-f5xc-description-short": "Namespace in which the suggestions are scoped.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "request_body": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_load_balancerSuggestValuesReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "ioschemaErrorCode": { "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 ioschemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "policyAsnMatchList": { "type": "object", "description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.", "title": "Asn Match List", "x-displayname": "ASN Match List.", "x-ves-proto-message": "ves.io.schema.policy.AsnMatchList", "properties": { "as_numbers": { "type": "array", "description": "An unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.", "title": "as numbers", "minItems": 1, "maxItems": 16, "items": { "type": "integer", "format": "int64" }, "x-displayname": "AS Numbers.", "x-ves-example": "[713, 7932, 847325, 4683, 15269, 1000001]", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "[713, 7932, 847325, 4683, 15269, 1000001]", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "16", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy.", "x-f5xc-description-medium": "Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 16, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy.", "x-f5xc-description-medium": "Unordered set of RFC 6793 defined 4-byte AS numbers that can be used to create allow or deny lists for use in network policy or service policy. It can be used to create the allow list only for DNS Load Balancer.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for policyAsnMatchList", "required_fields": [ "as_numbers" ], "mutually_exclusive_groups": [], "example_json": "{\n \"as_numbers\": [\n 0\n ]\n}", "example_yaml": "as_numbers:\n- 0" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "policyAsnMatcherType": { "type": "object", "description": "Match any AS number contained in the list of bgp_asn_sets.", "title": "asn matcher type", "x-displayname": "ASN Matcher.", "x-ves-proto-message": "ves.io.schema.policy.AsnMatcherType", "properties": { "asn_sets": { "type": "array", "description": "A list of references to bgp_asn_set objects.", "title": "asn_sets", "maxItems": 4, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "BGP ASN Sets.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of references to bgp_asn_set objects.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Match any AS number contained in the list of bgp_asn_sets.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for policyAsnMatcherType", "required_fields": [ "asn_sets" ], "mutually_exclusive_groups": [], "example_json": "{\n \"asn_sets\": [\n {}\n ]\n}", "example_yaml": "asn_sets:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "policyIpMatcherType": { "type": "object", "description": "Match any IP prefix contained in the list of ip_prefix_sets.\nThe result of the match is inverted if invert_matcher is true.", "title": "ip matcher type", "x-displayname": "IP Prefix Matcher.", "x-ves-proto-message": "ves.io.schema.policy.IpMatcherType", "properties": { "invert_matcher": { "type": "boolean", "description": "Invert the match result.", "title": "invert_matcher", "format": "boolean", "x-displayname": "Invert IP Matcher.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "prefix_sets": { "type": "array", "description": "A list of references to ip_prefix_set objects.", "title": "prefix_sets", "maxItems": 4, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "IP Prefix Sets.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "4" }, "x-f5xc-description-short": "List of references to ip_prefix_set objects.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 4, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true.", "x-f5xc-description-medium": "Match any IP prefix contained in the list of ip_prefix_sets. The result of the match is inverted if invert_matcher is true.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for policyIpMatcherType", "required_fields": [ "prefix_sets" ], "mutually_exclusive_groups": [], "example_json": "{\n \"prefix_sets\": [\n {}\n ]\n}", "example_yaml": "prefix_sets:\n- {}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "policyPrefixMatchList": { "type": "object", "description": "List of IP Prefix strings to match against.", "title": "IP Prefix Match List", "x-displayname": "IP Prefix Match List.", "x-ves-proto-message": "ves.io.schema.policy.PrefixMatchList", "properties": { "invert_match": { "type": "boolean", "description": "Invert the match result.", "title": "invert_matcher", "format": "boolean", "x-displayname": "Invert Match Result.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_prefixes": { "type": "array", "description": "List of IPv4 prefix strings.", "title": "ip prefixes", "maxItems": 128, "items": { "type": "string" }, "x-displayname": "IPv4 Prefix List.", "x-ves-example": "192.0.2.0/24.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.items.string.not_empty": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.0/24", "x-validation-rules": { "ves.io.schema.rules.repeated.items.string.ipv4_prefix": "true", "ves.io.schema.rules.repeated.items.string.not_empty": "true", "ves.io.schema.rules.repeated.max_items": "128", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 128, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "List of IP Prefix strings to match against.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for policyPrefixMatchList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorType__ves_io_schema_tenant_management_child_tenant": { "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/ioschemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaHttpStatusCode": { "type": "string", "description": "HTTP response status codes\n\nEmptyStatusCode response codes means it is not specified\nContinue status code\nOK status code\nCreated status code\nAccepted status code\nNon Authoritative Information status code\nNo Content status code\nReset Content status code\nPartial Content status code\nMulti Status status code\nAlready Reported status code\nIm Used status code\nMultiple Choices status code\nMoved Permanently status code\nFound status code\nSee Other status code\nNot Modified status code\nUse Proxy status code\nTemporary Redirect status code\nPermanent Redirect status code\nBad Request status code\nUnauthorized status code\nPayment Required status code\nForbidden status code\nNot Found status code\nMethod Not Allowed status code\nNot Acceptable status code\nProxy Authentication Required status code\nRequest Timeout status code\nConflict status code\nGone status code\nLength Required status code\nPrecondition Failed status code\nPayload Too Large status code\nURI Too Long status code\nUnsupported Media Type status code\nRange Not Satisfiable status code\nExpectation Failed status code\nMisdirected Request status code\nUnprocessable Entity status code\nLocked status code\nFailed Dependency status code\nUpgrade Required status code\nPrecondition Required status code\nToo Many Requests status code\nRequest Header Fields Too Large status code\nInternal Server Error status code\nNot Implemented status code\nBad Gateway status code\nService Unavailable status code\nGateway Timeout status code\nHTTP Version Not Supported status code\nVariant Also Negotiates status code\nInsufficient Storage status code\nLoop Detected status code\nNot Extended status code\nNetwork Authentication Required status code.", "title": "HttpStatusCode", "enum": [ "EmptyStatusCode", "Continue", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "PayloadTooLarge", "URITooLong", "UnsupportedMediaType", "RangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HTTPVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "default": "EmptyStatusCode", "x-displayname": "HTTP Status Code.", "x-ves-proto-enum": "ves.io.schema.HttpStatusCode", "x-f5xc-description-short": "HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code...", "x-f5xc-description-medium": "HTTP response status codes EmptyStatusCode response codes means it is not specified Continue status code OK status code Created status code Accepted status code Non Authoritative Information status code No Content status code Reset Content status code Partial Content status code Multi Status...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaHttpStatusCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EmptyStatusCode\"", "example_yaml": "EmptyStatusCode\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaLabelSelectorType": { "type": "object", "description": "This type can be used to establish a 'selector reference' from one object(called selector) to\na set of other objects(called selectees) based on the value of expressions.\nA label selector is a label query over a set of resources. An empty label selector matches all objects.\nA null label selector matches no objects. Label selector is immutable.\nExpressions is a list of strings of label selection expression.\nEach string has \",\" separated values which are \"AND\" and all strings are logically \"OR\".\nBNF for expression string\n ::= | \",\" \n ::= [!] KEY [ | ]\n ::= \"\" | \n ::= | \n ::= \"notin\"\n ::= \"in\"\n ::= \"(\" \")\"\n ::= VALUE | VALUE \",\" \n ::= [\"=\"|\"==\"|\"!=\"] VALUE.", "title": "LabelSelectorType", "x-displayname": "Label Selector.", "x-ves-proto-message": "ves.io.schema.LabelSelectorType", "properties": { "expressions": { "type": "array", "description": "Expressions contains the Kubernetes style label expression for selections.", "title": "expressions", "maxItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "x-displayname": "Selector Expression.", "x-ves-example": "Region in (us-west1, us-west2),tier in (staging)", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.k8s_label_selector": "true", "ves.io.schema.rules.repeated.items.string.max_len": "4096", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-example": "region in (us-west1, us-west2),tier in (staging)", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.k8s_label_selector": "true", "ves.io.schema.rules.repeated.items.string.max_len": "4096", "ves.io.schema.rules.repeated.items.string.min_len": "1", "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "Expressions contains the Kubernetes style label expression for selections.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the...", "x-f5xc-description-medium": "Type can be used to establish a 'selector reference' from one object(called selector) to a set of other objects(called selectees) based on the value of expressions. A label selector is a label query over a set of resources. An empty label selector matches all objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaLabelSelectorType", "required_fields": [ "expressions" ], "mutually_exclusive_groups": [], "example_json": "{\n \"expressions\": [\n \"value\"\n ]\n}", "example_yaml": "expressions:\n- value" }, "x-f5xc-cli-domain": "label", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Label management is platform-level" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "schemaMetricValue": { "type": "object", "description": "Metric data contains timestamp and the value.", "title": "Metric Value", "x-displayname": "Metric Value.", "x-ves-proto-message": "ves.io.schema.MetricValue", "properties": { "timestamp": { "type": "number", "description": "Timestamp", "title": "Timestamp", "format": "double", "x-displayname": "Timestamp", "x-ves-example": "1570007981.", "x-f5xc-example": "1570007981", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trend_value": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendValue" } ], "x-f5xc-description-short": "Configuration parameter for trend value.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "15", "x-f5xc-example": "15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Metric data contains timestamp and the value.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaMetricValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaTrendSentiment": { "type": "string", "description": "Trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.", "title": "Trend Sentiment", "enum": [ "TREND_SENTIMENT_NONE", "TREND_SENTIMENT_POSITIVE", "TREND_SENTIMENT_NEGATIVE" ], "default": "TREND_SENTIMENT_NONE", "x-displayname": "Trend Sentiment.", "x-ves-proto-enum": "ves.io.schema.TrendSentiment", "x-f5xc-description-short": "Trend sentiment Indicates trend sentiment is positive Indicates trend sentiment is negative.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendSentiment", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"TREND_SENTIMENT_NONE\"", "example_yaml": "TREND_SENTIMENT_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaTrendValue": { "type": "object", "description": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "title": "Trend Value", "x-displayname": "Trend Value.", "x-ves-proto-message": "ves.io.schema.TrendValue", "properties": { "description": { "type": "string", "description": "Description of the method used to calculate trend.", "title": "Description", "x-displayname": "Description.", "x-ves-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval.", "x-f5xc-example": "Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval", "x-f5xc-description-short": "Description of the method used to calculate trend.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "previous_value": { "type": "string", "description": "Configuration parameter for previous value", "title": "Previous Value", "x-displayname": "Previous Value.", "x-ves-example": "200.00", "x-f5xc-example": "200.00", "x-f5xc-description-short": "Configuration parameter for previous value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "sentiment": { "allOf": [ { "$ref": "#/components/schemas/schemaTrendSentiment" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "-15", "x-f5xc-example": "-15", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-description-medium": "Trend value contains trend value, trend sentiment and trend calculation description and window size.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaTrendValue", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemadns_load_balancerCreateSpecType": { "type": "object", "description": "Create DNS Load Balancer in a given namespace. If one already exist it will give a error.", "title": "Create DNS Load Balancer", "x-displayname": "Create DNS Load Balancer.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.CreateSpecType", "properties": { "fallback_pool": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for fallback pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "dns_lb_pool", "field_path": "fallback_pool", "gated_by": null, "required": false, "cardinality": "single" } ] }, "record_type": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResourceRecordType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "response_cache": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResponseCache" } ], "x-f5xc-description-short": "Configuration parameter for response cache.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_list": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerLoadBalancingRuleList" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "rules.action_choice", "required": true, "reason": "Each rule requires action_choice oneOf: pool" }, { "field": "rules.client_choice", "required": true, "reason": "Each rule requires client_choice oneOf: geo_location_set, ip_prefix_list, asn_list, asn_matcher, geo_location_label_selector" } ] } }, "x-f5xc-description-short": "Create DNS Load Balancer in a given namespace. If one already exist it will give a error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerErrorCode": { "type": "string", "description": "All possible error-codes for DNS load balancer pool member health check failure\n\n- ERR_NIL: No error\n- ERR_UNDEFINED: Undefined error\n- ERR_RECEIVE_STRING_MISMATCH: Received string mismatch error\n- ERR_INTERNAL: Encountered internal error\n- ERR_MSG_SEND: Message send error\n- ERR_TIMEOUT: Waithing response timeout error\n- ERR_MSG_RECEIVE: Message receive error\n- ERR_MAX_RECEIVE_BYTES: Bytes limit exceeded error\n- ERR_ICMP_PING: ICMP ping failure\n- ERR_CONNECTION_REFUSED: Connection refused error\n- ERR_CONNECTION_ABORTED: Connection aborted error\n- ERR_CONNECTION_RESET: Connection reset error\n- ERR_NET_UN_REACHABLE: Network not reachable\n- ERR_HOST_UN_REACHABLE: Host not reachable\n- ERR_UNKNOWN: Unknown error\n- ERR_TLS_HANDSHAKE_FAILURE: TLS handshake failure\n- ERR_CONNECTION_TIMEDOUT: Connection timeout error.", "title": "ErrorCode", "enum": [ "ERR_NIL", "ERR_UNDEFINED", "ERR_RECEIVE_STRING_MISMATCH", "ERR_INTERNAL", "ERR_MSG_SEND", "ERR_TIMEOUT", "ERR_MSG_RECEIVE", "ERR_MAX_RECEIVE_BYTES", "ERR_ICMP_PING", "ERR_CONNECTION_REFUSED", "ERR_CONNECTION_ABORTED", "ERR_CONNECTION_RESET", "ERR_NET_UN_REACHABLE", "ERR_HOST_UN_REACHABLE", "ERR_UNKNOWN", "ERR_TLS_HANDSHAKE_FAILURE", "ERR_CONNECTION_TIMEDOUT" ], "default": "ERR_NIL", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.dns_load_balancer.ErrorCode", "x-f5xc-description-short": "All possible error-codes for DNS load balancer pool member health check failure - ERR_NIL: No error - ERR_UNDEFINED: Undefined error ...", "x-f5xc-description-medium": "All possible error-codes for DNS load balancer pool member health check failure - ERR_NIL: No error - ERR_UNDEFINED: Undefined error - ERR_RECEIVE_STRING_MISMATCH: Received string mismatch error - ERR_INTERNAL: Encountered internal error - ERR_MSG_SEND: Message send error - ERR_TIMEOUT: Waithing...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ERR_NIL\"", "example_yaml": "ERR_NIL\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerGetSpecType": { "type": "object", "description": "GET DNS Load Balancer details.", "title": "Get DNS Load Balancer", "x-displayname": "GET DNS Load Balancer.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.GetSpecType", "properties": { "dns_zones": { "type": "array", "description": "A list of DNS Zones associated with this load balancer.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "DNS Zones", "x-f5xc-description-short": "List of DNS Zones associated with this load balancer.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "fallback_pool": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for fallback pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "dns_lb_pool", "field_path": "fallback_pool", "gated_by": null, "required": false, "cardinality": "single" } ] }, "record_type": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResourceRecordType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "response_cache": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResponseCache" } ], "x-f5xc-description-short": "Configuration parameter for response cache.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_list": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerLoadBalancingRuleList" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "rules.action_choice", "required": true, "reason": "Each rule requires action_choice oneOf: pool" }, { "field": "rules.client_choice", "required": true, "reason": "Each rule requires client_choice oneOf: geo_location_set, ip_prefix_list, asn_list, asn_matcher, geo_location_label_selector" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerReplaceSpecType": { "type": "object", "description": "Replace DNS Load Balancer in a given namespace.", "title": "Replace DNS Load Balancer", "x-displayname": "Replace DNS Load Balancer.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.ReplaceSpecType", "properties": { "fallback_pool": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for fallback pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "dns_lb_pool", "field_path": "fallback_pool", "gated_by": null, "required": false, "cardinality": "single" } ] }, "record_type": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResourceRecordType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "response_cache": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerResponseCache" } ], "x-f5xc-description-short": "Configuration parameter for response cache.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rule_list": { "allOf": [ { "$ref": "#/components/schemas/dns_load_balancerLoadBalancingRuleList" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-requires": [ { "field": "rules.action_choice", "required": true, "reason": "Each rule requires action_choice oneOf: pool" }, { "field": "rules.client_choice", "required": true, "reason": "Each rule requires client_choice oneOf: geo_location_set, ip_prefix_list, asn_list, asn_matcher, geo_location_label_selector" } ] } }, "x-f5xc-description-short": "Replace DNS Load Balancer in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "DNS Load Balancer Status Object", "x-displayname": "DNS Load Balancer Status Object.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerSuggestValuesResp": { "type": "object", "description": "Response body of SuggestValues request.", "title": "SuggestValuesResp", "x-displayname": "Response for SuggestValues.", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.SuggestValuesResp", "properties": { "items": { "type": "array", "description": "List of suggested items.", "title": "item_lists", "items": { "$ref": "#/components/schemas/schemadns_load_balancerSuggestedItem" }, "x-displayname": "Suggested Items.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerSuggestValuesResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "schemadns_load_balancerSuggestedItem": { "type": "object", "description": "A tuple with a suggested value and it's description.", "title": "SuggestedItem", "x-displayname": "Suggested Item.", "x-ves-oneof-field-value_choice": "[\"ref_value\",\"str_value\"]", "x-ves-proto-message": "ves.io.schema.dns_load_balancer.SuggestedItem", "properties": { "description": { "type": "string", "description": "Optional description for the suggested value.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "Optional description for the suggested value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "inferred", "confidence": 0.8, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "ref_value": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "str_value" ], "x-f5xc-references": [ { "resource_kind": "virtual_site", "field_path": "ref_value", "gated_by": { "choice": "value_choice" }, "required": false, "cardinality": "single" } ] }, "str_value": { "type": "string", "description": "Exclusive with [ref_value]", "title": "str_value", "x-displayname": "String", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ref_value" ] } }, "x-f5xc-description-short": "Tuple with a suggested value and it's description.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemadns_load_balancerSuggestedItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS load balancing requires system namespace — API enforces restriction" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_lb_health_check", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.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/dns_lb_health_checkCreateSpecType" } ], "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 dns_lb_health_checkCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.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/dns_lb_health_checkGetSpecType" } ], "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 dns_lb_health_checkCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkCreateSpecType": { "type": "object", "description": "Create DNS Load Balancer Health Check in a given namespace. If one already exist it will give a error.", "title": "Create DNS Load Balancer Health Check", "x-displayname": "Create DNS Load Balancer Health Check.", "x-ves-oneof-field-health_check": "[\"http_health_check\",\"https_health_check\",\"icmp_health_check\",\"tcp_health_check\",\"tcp_hex_health_check\",\"udp_health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.CreateSpecType", "properties": { "http_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for http health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "https_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for https health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "icmp_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for icmp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_hex_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHexHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp hex health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "udp_health_check" ] }, "udp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkUdpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for udp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check" ] } }, "x-f5xc-description-short": "Create DNS Load Balancer Health Check in a given namespace. If one already exist it will give a error.", "x-f5xc-description-medium": "Create DNS Load Balancer Health Check in a given namespace. If one already exist it will give a error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_lb_health_check", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.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 dns_lb_health_checkDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_lb_health_check", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkCreateRequest" } ], "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/dns_lb_health_checkReplaceRequest" } ], "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/dns_lb_health_checkGetSpecType" } ], "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/dns_lb_health_checkStatusObject" }, "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 dns_lb_health_checkGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkGetSpecType": { "type": "object", "description": "GET DNS Load Balancer Health Check details.", "title": "Get DNS Load Balancer Health Check", "x-displayname": "GET DNS Load Balancer Health Check.", "x-ves-oneof-field-health_check": "[\"http_health_check\",\"https_health_check\",\"icmp_health_check\",\"tcp_health_check\",\"tcp_hex_health_check\",\"udp_health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.GetSpecType", "properties": { "dns_lb_pools": { "type": "array", "description": "A list of DNS Load balancer pools associated with this health check.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "DNS Load balancer pools.", "x-f5xc-description-short": "List of DNS Load balancer pools associated with this health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "http_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for http health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "https_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for https health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "icmp_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for icmp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_hex_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHexHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp hex health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "udp_health_check" ] }, "udp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkUdpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for udp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check" ] } }, "x-f5xc-description-short": "GET DNS Load Balancer Health Check details.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkHttpHealthCheck": { "type": "object", "title": "HTTP Health Check", "x-displayname": "HTTP Health Check.", "x-ves-displayorder": "1,2,3,4", "x-ves-oneof-field-virtual_host_choice": "[\"disable_virtual_host\",\"virtual_host\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.HttpHealthCheck", "properties": { "disable_virtual_host": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "virtual_host" ] }, "health_check_port": { "type": "integer", "description": "Port used for performing health check.", "title": "Health check port", "format": "int64", "x-displayname": "Health Check Port.", "x-ves-example": "80", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "health_check_secondary_port": { "type": "integer", "description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "title": "Health check secondary port", "format": "int64", "x-displayname": "Health Check Secondary Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-description-medium": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receive": { "type": "string", "description": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.", "title": "Receive String", "maxLength": 2048, "x-displayname": "Receive String.", "x-ves-example": "HTTP/1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "HTTP/1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Regular expression used to match against the response to the health check's request.", "x-f5xc-description-medium": "Regular expression used to match against the response to the health check's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "send": { "type": "string", "description": "HTTP payload to send to the target.", "title": "Send String", "maxLength": 2048, "x-displayname": "Send String.", "x-ves-example": "HEAD / HTTP/1.0.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "HEAD / HTTP/1.0", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "virtual_host": { "type": "string", "description": "Exclusive with [disable_virtual_host]\nName of the virtual host to use for SNI.", "title": "Enable Virtual Host", "maxLength": 2048, "x-displayname": "Enable Virtual Host.", "x-ves-example": "example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-description-short": "Exclusive with [disable_virtual_host] Name of the virtual host to use for SNI.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_virtual_host" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkHttpHealthCheck", "required_fields": [ "health_check_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"health_check_port\": 1\n}", "example_yaml": "health_check_port: 1" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_lb_health_check", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.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/dns_lb_health_checkListResponseItem" }, "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 dns_lb_health_checkListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkListResponseItem": { "type": "object", "description": "By default a summary of dns_lb_health_check 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 dns_lb_health_check", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_lb_health_check.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_lb_health_check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_lb_health_check.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this dns_lb_health_check.", "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 dns_lb_health_check is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_lb_health_check is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_lb_health_check.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_lb_health_check.", "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 dns_lb_health_check.", "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/dns_lb_health_checkStatusObject" }, "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 dns_lb_health_check.", "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 dns_lb_health_check.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 dns_lb_health_check 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 dns_lb_health_check 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 dns_lb_health_checkListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_lb_health_check", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.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/dns_lb_health_checkReplaceSpecType" } ], "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 dns_lb_health_checkReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkReplaceSpecType": { "type": "object", "description": "Replace DNS Load Balancer Health Check in a given namespace.", "title": "Replace DNS Load Balancer Health Check", "x-displayname": "Replace DNS Load Balancer Health Check.", "x-ves-oneof-field-health_check": "[\"http_health_check\",\"https_health_check\",\"icmp_health_check\",\"tcp_health_check\",\"tcp_hex_health_check\",\"udp_health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.ReplaceSpecType", "properties": { "http_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for http health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "https_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkHttpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for https health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "icmp_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for icmp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "tcp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_hex_health_check", "udp_health_check" ] }, "tcp_hex_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkTcpHexHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for tcp hex health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "udp_health_check" ] }, "udp_health_check": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_health_checkUdpHealthCheck" } ], "x-f5xc-description-short": "Configuration parameter for udp health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "http_health_check", "https_health_check", "icmp_health_check", "tcp_health_check", "tcp_hex_health_check" ] } }, "x-f5xc-description-short": "Replace DNS Load Balancer Health Check in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "DNS Load Balancer Health Check Status Object", "x-displayname": "DNS Load Balancer Health Check Status Object.", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkTcpHealthCheck": { "type": "object", "title": "TCP Health Check", "x-displayname": "TCP Health Check.", "x-ves-displayorder": "1,2,3,4", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.TcpHealthCheck", "properties": { "health_check_port": { "type": "integer", "description": "Port used for performing health check.", "title": "Health check port", "format": "int64", "x-displayname": "Health Check Port.", "x-ves-example": "80", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "health_check_secondary_port": { "type": "integer", "description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "title": "Health check secondary port", "format": "int64", "x-displayname": "Health Check Secondary Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-description-medium": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receive": { "type": "string", "description": "Regular expression used to match against the response to the monitor's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.", "title": "Receive String", "maxLength": 2048, "x-displayname": "Receive String.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "Regular expression used to match against the response to the monitor's request. Mark node up upon receipt of a successful regular expression match.", "x-f5xc-description-medium": "Regular expression used to match against the response to the monitor's request. Mark node up upon receipt of a successful regular expression match. Uses re2 regular expression syntax.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "send": { "type": "string", "description": "Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS)", "title": "Send String", "maxLength": 2048, "x-displayname": "Send String.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-description-short": "Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS)", "x-f5xc-description-medium": "Send this string to target (default empty. When send and receive are both empty, monitor just tests 3WHS).", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkTcpHealthCheck", "required_fields": [ "health_check_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"health_check_port\": 1\n}", "example_yaml": "health_check_port: 1" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkTcpHexHealthCheck": { "type": "object", "title": "TCP Hex Health Check", "x-displayname": "TCP Hex Health Check.", "x-ves-displayorder": "1,2,3,4", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.TcpHexHealthCheck", "properties": { "health_check_port": { "type": "integer", "description": "Port used for performing health check.", "title": "Health check port", "format": "int64", "x-displayname": "Health Check Port.", "x-ves-example": "80", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "health_check_secondary_port": { "type": "integer", "description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "title": "Health check secondary port", "format": "int64", "x-displayname": "Health Check Secondary Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-description-medium": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receive": { "type": "string", "description": "Hex encoded raw bytes expected in the response.", "title": "Receive Payload", "maxLength": 2048, "x-displayname": "Receive Payload.", "x-ves-example": "00000034", "x-ves-validation-rules": { "ves.io.schema.rules.string.hex": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "00000034", "x-validation-rules": { "ves.io.schema.rules.string.hex": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-description-short": "Hex encoded raw bytes expected in the response.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "format": "hex", "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 } }, "send": { "type": "string", "description": "Hex encoded raw bytes sent in the request. Empty payloads imply a connect-only health check.", "title": "Send Payload", "maxLength": 2048, "x-displayname": "Send Payload.", "x-ves-example": "000000FF", "x-ves-validation-rules": { "ves.io.schema.rules.string.hex": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-example": "000000FF", "x-validation-rules": { "ves.io.schema.rules.string.hex": "true", "ves.io.schema.rules.string.max_len": "2048" }, "x-f5xc-description-short": "Hex encoded raw bytes sent in the request. Empty payloads imply a connect-only health check.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 2048, "format": "hex", "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 dns_lb_health_checkTcpHexHealthCheck", "required_fields": [ "health_check_port" ], "mutually_exclusive_groups": [], "example_json": "{\n \"health_check_port\": 1\n}", "example_yaml": "health_check_port: 1" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_health_checkUdpHealthCheck": { "type": "object", "title": "UDP Health Check", "x-displayname": "UDP Health Check.", "x-ves-displayorder": "1,2,3,4", "x-ves-proto-message": "ves.io.schema.dns_lb_health_check.UdpHealthCheck", "properties": { "health_check_port": { "type": "integer", "description": "Port used for performing health check.", "title": "Health check port", "format": "int64", "x-displayname": "Health Check Port.", "x-ves-example": "80", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "80", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "health_check_secondary_port": { "type": "integer", "description": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "title": "Health check secondary port", "format": "int64", "x-displayname": "Health Check Secondary Port.", "x-ves-example": "443", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "443", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-description-medium": "Secondary port used for performing health check. If included, both ports must be healthy for the health check to pass.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "receive": { "type": "string", "description": "UDP response to be matched. It can be a regex.", "title": "Receive String", "minLength": 1, "maxLength": 2048, "x-displayname": "Receive String.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1", "ves.io.schema.rules.string.regex": "true" }, "x-f5xc-description-short": "UDP response to be matched. It can be a regex.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "send": { "type": "string", "description": "UDP payload.", "title": "Send String", "minLength": 1, "maxLength": 2048, "x-displayname": "Send String.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "\"\"", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "2048", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 2048, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_health_checkUdpHealthCheck", "required_fields": [ "health_check_port", "receive", "send" ], "mutually_exclusive_groups": [], "example_json": "{\n \"health_check_port\": 1,\n \"receive\": \"\\\"\\\"\",\n \"send\": \"\\\"\\\"\"\n}", "example_yaml": "health_check_port: 1\nreceive: '\"\"'\nsend: '\"\"'" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB health check is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolAAAAPool": { "type": "object", "title": "AAAA Pool", "x-displayname": "Pool for AAAA Record.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.AAAAPool", "properties": { "max_answers": { "type": "integer", "description": "Limit on number of Resource Records to be included in the response to query.", "title": "Maximum Answers", "format": "int64", "x-displayname": "Maximum Answers.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Limit on number of Resource Records to be included in the response to query.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "members": { "type": "array", "description": "Configuration parameter for members", "title": "Collection of AAAA record members", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/dns_lb_poolAddressMember" }, "x-displayname": "Pool Members.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolAAAAPool", "required_fields": [ "max_answers", "members" ], "mutually_exclusive_groups": [], "example_json": "{\n \"max_answers\": 1,\n \"members\": [\n {\n \"ip_endpoint\": \"192.0.2.132\"\n }\n ]\n}", "example_yaml": "max_answers: 1\nmembers:\n- ip_endpoint: 192.0.2.132" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolAPool": { "type": "object", "title": "A Pool", "x-displayname": "Pool for A Record.", "x-ves-oneof-field-health_check_choice": "[\"disable_health_check\",\"health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.APool", "properties": { "disable_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "health_check" ] }, "health_check": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Health check configuration for monitoring.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_health_check" ], "x-f5xc-references": [ { "resource_kind": "health_check", "field_path": "health_check", "gated_by": { "choice": "health_check_choice" }, "required": false, "cardinality": "single" } ] }, "max_answers": { "type": "integer", "description": "Limit on number of Resource Records to be included in the response to query.", "title": "Maximum Answers", "format": "int64", "x-displayname": "Maximum Answers.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Limit on number of Resource Records to be included in the response to query.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "members": { "type": "array", "description": "Configuration parameter for members", "title": "Collection of A record members", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/dns_lb_poolAddressMember" }, "x-displayname": "Pool Members.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolAPool", "required_fields": [ "max_answers", "members" ], "mutually_exclusive_groups": [], "example_json": "{\n \"max_answers\": 1,\n \"members\": [\n {\n \"ip_endpoint\": \"192.0.2.132\"\n }\n ]\n}", "example_yaml": "max_answers: 1\nmembers:\n- ip_endpoint: 192.0.2.132" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolAddressMember": { "type": "object", "description": "Public IP address which can be IPv4 or IPv6. This can be a member of only A/AAAA type Pool.", "title": "AddressMember", "x-displayname": "IP Endpoint.", "x-ves-displayorder": "1,8,5,6,7", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.AddressMember", "properties": { "disable": { "type": "boolean", "description": "A value of true will disable the pool-member.", "title": "Disable pool-member", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will disable the pool-member.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_endpoint": { "type": "string", "description": "Public IP address.", "title": "IP", "x-displayname": "Public IP", "x-ves-example": "192.0.2.132.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.132", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "name": { "type": "string", "description": "Pool member name.", "title": "Name", "maxLength": 256, "x-displayname": "Name", "x-ves-example": "Web server 1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "web server 1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "priority": { "type": "integer", "description": "Used if the pool’s load balancing mode is set to Priority.", "title": "Priority", "format": "int64", "x-displayname": "Load Balancing Priority.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Used if the pool’s load balancing mode is set to Priority.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ratio": { "type": "integer", "description": "Used if the pool’s load balancing mode is set to Ratio-Member.", "title": "Ratio", "format": "int64", "x-displayname": "Load Balancing Ratio.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-description-short": "Used if the pool’s load balancing mode is set to Ratio-Member.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Public IP address which can be IPv4 or IPv6. This can be a member of only A/AAAA type Pool.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolAddressMember", "required_fields": [ "ip_endpoint" ], "mutually_exclusive_groups": [], "example_json": "{\n \"ip_endpoint\": \"192.0.2.132\"\n}", "example_yaml": "ip_endpoint: 192.0.2.132" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolCNAMEMember": { "type": "object", "description": "CNAME Record which can be a member of a CNAME type pool.", "title": "CNAMEMember", "x-displayname": "CNAME member.", "x-ves-displayorder": "1,2,3,4,5", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.CNAMEMember", "properties": { "domain": { "type": "string", "description": "Specifies the fully qualified domain name.", "title": "FQDN", "x-displayname": "FQDN", "x-ves-example": "app.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "app.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-description-short": "Specifies the fully qualified domain name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "final_translation": { "type": "boolean", "description": "If this flag is true, the CNAME record will not be translated further.", "title": "Final Translation", "format": "boolean", "x-displayname": "Final Translation.", "x-f5xc-description-short": "If this flag is true, the CNAME record will not be translated further.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Pool member name.", "title": "Name", "maxLength": 256, "x-displayname": "Name", "x-ves-example": "Web server 1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "web server 1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "priority": { "type": "integer", "description": "Used if the pool’s load balancing mode is set to Priority. Determines the order in which traffic is routed to pool members. The lower the number, the higher the priority, making those members active while higher-numbered members act as backups.", "title": "Priority", "format": "int64", "x-displayname": "Load Balancing Priority.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Used if the pool’s load balancing mode is set to Priority. Determines the order in which traffic is routed to pool members.", "x-f5xc-description-medium": "Used if the pool’s load balancing mode is set to Priority. Determines the order in which traffic is routed to pool members. The lower the number, the higher the priority, making those members active while higher-numbered members act as backups.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ratio": { "type": "integer", "description": "Used if the pool’s load balancing mode is set to Ratio-Member.", "title": "Ratio", "format": "int64", "x-displayname": "Load Balancing Ratio.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-description-short": "Used if the pool’s load balancing mode is set to Ratio-Member.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "CNAME Record which can be a member of a CNAME type pool.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolCNAMEMember", "required_fields": [ "domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"app.example.com\"\n}", "example_yaml": "domain: app.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolCNAMEPool": { "type": "object", "title": "CNAME Pool", "x-displayname": "Pool for CNAME Record.", "x-ves-oneof-field-health_check_choice": "[\"disable_health_check\",\"health_check\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.CNAMEPool", "properties": { "disable_health_check": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable health check.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "health_check" ] }, "health_check": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Health check configuration for monitoring.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_health_check" ], "x-f5xc-references": [ { "resource_kind": "health_check", "field_path": "health_check", "gated_by": { "choice": "health_check_choice" }, "required": false, "cardinality": "single" } ] }, "members": { "type": "array", "description": "Configuration parameter for members", "title": "Collection of CNAME record members", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/dns_lb_poolCNAMEMember" }, "x-displayname": "Pool Members.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolCNAMEPool", "required_fields": [ "members" ], "mutually_exclusive_groups": [], "example_json": "{\n \"members\": [\n {\n \"domain\": \"app.example.com\"\n }\n ]\n}", "example_yaml": "members:\n- domain: app.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_lb_pool", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.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/dns_lb_poolCreateSpecType" } ], "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 dns_lb_poolCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.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/dns_lb_poolGetSpecType" } ], "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 dns_lb_poolCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolCreateSpecType": { "type": "object", "description": "Create DNS Load Balancer Pool in a given namespace. If one already exist it will give a error.", "title": "Create DNS Load Balancer Pool", "x-displayname": "Create DNS Load Balancer Pool.", "x-ves-oneof-field-pool_type_choice": "[\"a_pool\",\"aaaa_pool\",\"cname_pool\",\"mx_pool\",\"srv_pool\"]", "x-ves-oneof-field-ttl_choice": "[\"ttl\",\"use_rrset_ttl\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.CreateSpecType", "properties": { "a_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aaaa_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "aaaa_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAAAAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "cname_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolCNAMEPool" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "mx_pool", "srv_pool" ] }, "load_balancing_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolLoadBalancingMode" } ], "x-f5xc-description-short": "Configuration parameter for load balancing mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mx_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolMXPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "srv_pool" ] }, "srv_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolSRVPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "mx_pool" ] }, "ttl": { "type": "integer", "description": "Exclusive with [use_rrset_ttl]\nCustom TTL in seconds (default 30) for responses from this pool.", "format": "int64", "x-displayname": "TTL", "x-ves-example": "3600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-example": "3600", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-description-short": "Exclusive with [use_rrset_ttl] Custom TTL in seconds (default 30) for responses from this pool.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 2147483647, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_rrset_ttl" ] }, "use_rrset_ttl": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use rrset ttl.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ttl" ] } }, "x-f5xc-description-short": "Create DNS Load Balancer Pool in a given namespace. If one already exist it will give a error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_lb_pool", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.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 dns_lb_poolDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read dns_lb_pool", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolCreateRequest" } ], "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/dns_lb_poolReplaceRequest" } ], "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/dns_lb_poolGetSpecType" } ], "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/dns_lb_poolStatusObject" }, "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 dns_lb_poolGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolGetSpecType": { "type": "object", "description": "GET DNS Load Balancer Pool details.", "title": "Get DNS Load Balancer Pool", "x-displayname": "GET DNS Load Balancer Pool.", "x-ves-oneof-field-pool_type_choice": "[\"a_pool\",\"aaaa_pool\",\"cname_pool\",\"mx_pool\",\"srv_pool\"]", "x-ves-oneof-field-ttl_choice": "[\"ttl\",\"use_rrset_ttl\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.GetSpecType", "properties": { "a_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aaaa_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "aaaa_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAAAAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "cname_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolCNAMEPool" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "mx_pool", "srv_pool" ] }, "dns_load_balancers": { "type": "array", "description": "A list of Load balancers associated with this load balancer pool.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "DNS Load balancers.", "x-f5xc-description-short": "List of Load balancers associated with this load balancer pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "load_balancing_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolLoadBalancingMode" } ], "x-f5xc-description-short": "Configuration parameter for load balancing mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mx_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolMXPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "srv_pool" ] }, "srv_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolSRVPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "mx_pool" ] }, "ttl": { "type": "integer", "description": "Exclusive with [use_rrset_ttl]\nCustom TTL in seconds (default 30) for responses from this pool.", "format": "int64", "x-displayname": "TTL", "x-ves-example": "3600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-example": "3600", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-description-short": "Exclusive with [use_rrset_ttl] Custom TTL in seconds (default 30) for responses from this pool.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 2147483647, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_rrset_ttl" ] }, "use_rrset_ttl": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use rrset ttl.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ttl" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolGetSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of dns_lb_pool", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.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/dns_lb_poolListResponseItem" }, "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 dns_lb_poolListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolListResponseItem": { "type": "object", "description": "By default a summary of dns_lb_pool 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 dns_lb_pool", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this dns_lb_pool.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this dns_lb_pool.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this dns_lb_pool.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this dns_lb_pool.", "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 dns_lb_pool is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates dns_lb_pool is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this dns_lb_pool.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this dns_lb_pool.", "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 dns_lb_pool.", "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/dns_lb_poolStatusObject" }, "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 dns_lb_pool.", "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 dns_lb_pool 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 dns_lb_pool 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 dns_lb_poolListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolLoadBalancingMode": { "type": "string", "description": "- ROUND_ROBIN: Round-Robin\n\nRound Robin will ensure random equal distribution of requests among all pool members in a pool.\n- RATIO_MEMBER: Ratio-Member\n\nRatio-Member performs load balancing of requests across the pool members based on the ratio assigned to each pool member\n- STATIC_PERSIST: Static-Persist\n\nThe Static Persist load balancing method uses the persist mask, with the source IP address of the Local Domain Name Server (LDNS), in a deterministic algorithm to send requests to a specific pool member. If the DNS resolver passes ECS (EDNS-Client-Subnet) information, then a hash of it will be used, to send the client to the same pool member\n- PRIORITY: Priority\n\nThe Priority load balancing method returns all available endpoints in a pool with the highest priority. Pool Members have a priority value, starting from zero, where a lower value means a higher priority.", "title": "LoadBalancing Mode", "enum": [ "ROUND_ROBIN", "RATIO_MEMBER", "STATIC_PERSIST", "PRIORITY" ], "default": "ROUND_ROBIN", "x-displayname": "LoadBalancing Algorithm.", "x-ves-proto-enum": "ves.io.schema.dns_lb_pool.LoadBalancingMode", "x-f5xc-description-short": "- ROUND_ROBIN: Round-Robin Round Robin will ensure random equal distribution of requests among all pool members in a pool. - RATIO_MEMBER...", "x-f5xc-description-medium": "- ROUND_ROBIN: Round-Robin Round Robin will ensure random equal distribution of requests among all pool members in a pool. - RATIO_MEMBER: Ratio-Member Ratio-Member performs load balancing of requests across the pool members based on the ratio assigned to each pool member - STATIC_PERSIST...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolLoadBalancingMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ROUND_ROBIN\"", "example_yaml": "ROUND_ROBIN\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolMXMember": { "type": "object", "description": "MX Record which can be a member of a MX type pool.", "title": "MXMember", "x-displayname": "MX Record", "x-ves-displayorder": "1,4,2,3", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.MXMember", "properties": { "domain": { "type": "string", "description": "Domain name for routing and identification", "title": "Domain", "x-displayname": "Domain", "x-ves-example": "mail.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "mail.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-description-short": "Domain name for routing and identification.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "Pool member name.", "title": "Name", "maxLength": 256, "x-displayname": "Name", "x-ves-example": "Web server 1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "web server 1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "priority": { "type": "integer", "description": "MX Record priority.", "title": "Priority", "format": "int64", "x-displayname": "MX Record Priority.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ratio": { "type": "integer", "description": "Load Balancing Ratio.", "title": "Ratio", "format": "int64", "x-displayname": "Load Balancing Ratio.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "MX Record which can be a member of a MX type pool.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolMXMember", "required_fields": [ "domain" ], "mutually_exclusive_groups": [], "example_json": "{\n \"domain\": \"mail.example.com\"\n}", "example_yaml": "domain: mail.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolMXPool": { "type": "object", "title": "MX Pool", "x-displayname": "Pool for MX Record.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.MXPool", "properties": { "max_answers": { "type": "integer", "description": "Limit on number of Resource Records to be included in the response to query.", "title": "Maximum Answers", "format": "int64", "x-displayname": "Maximum Answers.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Limit on number of Resource Records to be included in the response to query.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "members": { "type": "array", "description": "Configuration parameter for members", "title": "Collection of MX record members", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/dns_lb_poolMXMember" }, "x-displayname": "Pool Members.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolMXPool", "required_fields": [ "max_answers", "members" ], "mutually_exclusive_groups": [], "example_json": "{\n \"max_answers\": 1,\n \"members\": [\n {\n \"domain\": \"mail.example.com\"\n }\n ]\n}", "example_yaml": "max_answers: 1\nmembers:\n- domain: mail.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a dns_lb_pool", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.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/dns_lb_poolReplaceSpecType" } ], "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 dns_lb_poolReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolReplaceSpecType": { "type": "object", "description": "Replace DNS Load Balancer Pool in a given namespace.", "title": "Replace DNS Load Balancer Pool", "x-displayname": "Replace DNS Load Balancer Pool.", "x-ves-oneof-field-pool_type_choice": "[\"a_pool\",\"aaaa_pool\",\"cname_pool\",\"mx_pool\",\"srv_pool\"]", "x-ves-oneof-field-ttl_choice": "[\"ttl\",\"use_rrset_ttl\"]", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.ReplaceSpecType", "properties": { "a_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "aaaa_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "aaaa_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolAAAAPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "cname_pool", "mx_pool", "srv_pool" ] }, "cname_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolCNAMEPool" } ], "x-f5xc-example": "example-resource", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "mx_pool", "srv_pool" ] }, "load_balancing_mode": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolLoadBalancingMode" } ], "x-f5xc-description-short": "Configuration parameter for load balancing mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mx_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolMXPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "srv_pool" ] }, "srv_pool": { "allOf": [ { "$ref": "#/components/schemas/dns_lb_poolSRVPool" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "a_pool", "aaaa_pool", "cname_pool", "mx_pool" ] }, "ttl": { "type": "integer", "description": "Exclusive with [use_rrset_ttl]\nCustom TTL in seconds (default 30) for responses from this pool.", "format": "int64", "x-displayname": "TTL", "x-ves-example": "3600", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-example": "3600", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-description-short": "Exclusive with [use_rrset_ttl] Custom TTL in seconds (default 30) for responses from this pool.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 2147483647, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "use_rrset_ttl" ] }, "use_rrset_ttl": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use rrset ttl.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "ttl" ] } }, "x-f5xc-description-short": "Replace DNS Load Balancer Pool in a given namespace.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolSRVMember": { "type": "object", "description": "SRV Record which can be a member of a SRV type pool.", "title": "SRVMember", "x-displayname": "SRV member.", "x-ves-displayorder": "1,5,2,3,4,7,6", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.SRVMember", "properties": { "final_translation": { "type": "boolean", "description": "If this flag is true, the SRV record will not be translated further.", "title": "Final Translation", "format": "boolean", "x-displayname": "Final Translation.", "x-f5xc-description-short": "If this flag is true, the SRV record will not be translated further.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Pool member name.", "title": "Name", "maxLength": 256, "x-displayname": "Name", "x-ves-example": "Web server 1.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "web server 1", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "port": { "type": "integer", "description": "Port on which the service can be found.", "title": "Port", "format": "int64", "x-displayname": "Port", "x-ves-example": "10", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "minimum": 1, "maximum": 65535, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "priority": { "type": "integer", "description": "Priority of the target. A lower number indicates a higher preference.", "title": "Priority", "format": "int64", "x-displayname": "Priority", "x-ves-example": "10", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Priority of the target. A lower number indicates a higher preference.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "ratio": { "type": "integer", "description": "Configuration parameter for ratio", "title": "Ratio", "format": "int64", "x-displayname": "Load Balancing Ratio.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "100" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 100, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "target": { "type": "string", "description": "Domain name of the machine providing the service.", "title": "Target", "x-displayname": "Target", "x-ves-example": "www.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^[.]$|^([a-zA-Z0-9]{1}[a-zA-Z0-9_-]{0,62})(\\\\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*?(\\\\.[a-zA-Z]{1}[a-zA-Z0-9]{0,62})\\\\.?$" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^[.]$|^([a-zA-Z0-9]{1}[a-zA-Z0-9_-]{0,62})(\\\\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*?(\\\\.[a-zA-Z]{1}[a-zA-Z0-9]{0,62})\\\\.?$" }, "x-f5xc-description-short": "Domain name of the machine providing the service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^[.]$|^([a-zA-Z0-9]{1}[a-zA-Z0-9_-]{0,62})(\\\\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*?(\\\\.[a-zA-Z]{1}[a-zA-Z0-9]{0,62})\\\\.?$", "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 } }, "weight": { "type": "integer", "description": "Weight of the target. A higher number indicates a higher preference.", "title": "Weight", "format": "int64", "x-displayname": "Weight", "x-ves-example": "10", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Weight of the target. A higher number indicates a higher preference.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "multipleOf": 1, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "SRV Record which can be a member of a SRV type pool.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolSRVMember", "required_fields": [ "port", "priority", "target", "weight" ], "mutually_exclusive_groups": [], "example_json": "{\n \"port\": 0,\n \"priority\": 0,\n \"target\": \"www.example.com\",\n \"weight\": 0\n}", "example_yaml": "port: 0\npriority: 0\ntarget: www.example.com\nweight: 0" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolSRVPool": { "type": "object", "title": "SRV Pool", "x-displayname": "Pool for SRV Record.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.SRVPool", "properties": { "max_answers": { "type": "integer", "description": "Limit on number of Resource Records to be included in the response to query.", "title": "Maximum Answers", "format": "int64", "x-displayname": "Maximum Answers.", "x-ves-example": "1", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-example": "1", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "32" }, "x-f5xc-description-short": "Limit on number of Resource Records to be included in the response to query.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 32, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "members": { "type": "array", "description": "Configuration parameter for members", "title": "Collection of SRV record members", "minItems": 1, "maxItems": 32, "items": { "$ref": "#/components/schemas/dns_lb_poolSRVMember" }, "x-displayname": "Pool Members.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "32", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 32, "uniqueItems": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolSRVPool", "required_fields": [ "max_answers", "members" ], "mutually_exclusive_groups": [], "example_json": "{\n \"max_answers\": 1,\n \"members\": [\n {\n \"port\": 0,\n \"priority\": 0,\n \"target\": \"www.example.com\",\n \"weight\": 0\n }\n ]\n}", "example_yaml": "max_answers: 1\nmembers:\n- port: 0\n priority: 0\n target: www.example.com\n weight: 0" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_lb_poolStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "DNS Load Balancer Pool Status Object", "x-displayname": "DNS Load Balancer Pool Status Object.", "x-ves-proto-message": "ves.io.schema.dns_lb_pool.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_lb_poolStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS LB pool is a DNS object — system namespace enforced by API" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneAFSDBRecordSubtype": { "type": "string", "description": "AFS Volume Location Server or DCE Authentication Server.\n\n- NONE: NONE\n\n- AFSVolumeLocationServer: AFS Volume Location Server\n\n- DCEAuthenticationServer: DCE Authentication Server.", "title": "AFSDB Record Subtype", "enum": [ "NONE", "AFSVolumeLocationServer", "DCEAuthenticationServer" ], "default": "NONE", "x-displayname": "AFSDB Record Subtype.", "x-ves-proto-enum": "ves.io.schema.dns_zone.AFSDBRecordSubtype", "x-f5xc-description-short": "AFS Volume Location Server or DCE Authentication Server. - NONE: NONE - AFSVolumeLocationServer: AFS Volume Location Server ...", "x-f5xc-description-medium": "AFS Volume Location Server or DCE Authentication Server. - NONE: NONE - AFSVolumeLocationServer: AFS Volume Location Server - DCEAuthenticationServer: DCE Authentication Server.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneAFSDBRecordSubtype", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"NONE\"", "example_yaml": "NONE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneAFSDBRecordValue": { "type": "object", "title": "AFSDBRecordValue", "x-displayname": "AFSDBRecordValue.", "x-ves-proto-message": "ves.io.schema.dns_zone.AFSDBRecordValue", "properties": { "hostname": { "type": "string", "description": "Server name of the AFS cell database server or the DCE name server.", "title": "Hostname", "x-displayname": "Hostname", "x-ves-example": "mail.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-example": "mail.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname": "true" }, "x-f5xc-description-short": "Server name of the AFS cell database server or the DCE name server.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "hostname", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "subtype": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneAFSDBRecordSubtype" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneAFSDBRecordValue", "required_fields": [ "hostname" ], "mutually_exclusive_groups": [], "example_json": "{\n \"hostname\": \"mail.example.com\"\n}", "example_yaml": "hostname: mail.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCERTAlgorithm": { "type": "string", "description": "CERT algorithm value must be compatible with the specified algorithm.\n\n- RESERVEDALGORITHM: RESERVEDALGORITHM\n\n- RSAMD5: RSAMD5\n\n- DH: DH\n\n- DSASHA1: DSASHA1\n\n- ECC: ECC\n\n- RSASHA1ALGORITHM: RSA-SHA1\n\n- INDIRECT: INDIRECT\n\n- PRIVATEDNS: PRIVATEDNS\n\n- PRIVATEOID: PRIVATEOID.", "title": "CERT Algorithm", "enum": [ "RESERVEDALGORITHM", "RSAMD5", "DH", "DSASHA1", "ECC", "RSASHA1ALGORITHM", "INDIRECT", "PRIVATEDNS", "PRIVATEOID" ], "default": "RESERVEDALGORITHM", "x-displayname": "CERT Algorithm.", "x-ves-proto-enum": "ves.io.schema.dns_zone.CERTAlgorithm", "x-f5xc-description-short": "CERT algorithm value must be compatible with the specified algorithm. - RESERVEDALGORITHM: RESERVEDALGORITHM - RSAMD5: RSAMD5 - DH: DH - DSASHA1...", "x-f5xc-description-medium": "CERT algorithm value must be compatible with the specified algorithm. - RESERVEDALGORITHM: RESERVEDALGORITHM - RSAMD5: RSAMD5 - DH: DH - DSASHA1: DSASHA1 - ECC: ECC - RSASHA1ALGORITHM: RSA-SHA1 - INDIRECT: INDIRECT - PRIVATEDNS: PRIVATEDNS - PRIVATEOID: PRIVATEOID.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCERTAlgorithm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"RESERVEDALGORITHM\"", "example_yaml": "RESERVEDALGORITHM\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCERTRecordValue": { "type": "object", "title": "CERTRecordValue", "x-displayname": "CERTRecordValue.", "x-ves-proto-message": "ves.io.schema.dns_zone.CERTRecordValue", "properties": { "algorithm": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneCERTAlgorithm" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "cert_key_tag": { "type": "integer", "description": "Tag for categorization and filtering", "title": "Key Tag", "format": "int64", "x-displayname": "Key Tag", "x-ves-example": "3", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "3", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "cert_type": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneCERTType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "certificate": { "type": "string", "description": "Certificate in base 64 format.", "title": "Certificate", "minLength": 1, "maxLength": 4096, "x-displayname": "Certificate.", "x-ves-example": "Ab100cFg", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "4096", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "Ab100cFg", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "4096", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 4096, "pattern": "^-----BEGIN CERTIFICATE-----\\n.*\\n-----END CERTIFICATE-----$", "format": "pem", "formatDescription": "PEM-encoded X.509 certificate, max 5MB", "byteLength": { "min": 100, "max": 5242880 }, "validation": { "standard": "PEM" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCERTRecordValue", "required_fields": [ "cert_key_tag", "certificate" ], "mutually_exclusive_groups": [], "example_json": "{\n \"cert_key_tag\": 0,\n \"certificate\": \"Ab100cFg\"\n}", "example_yaml": "cert_key_tag: 0\ncertificate: Ab100cFg" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCERTResourceRecord": { "type": "object", "description": "DNS CERT Record.", "title": "CERTResourceRecord", "x-displayname": "DNS CERT Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.CERTResourceRecord", "properties": { "name": { "type": "string", "description": "CERT Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "CERT Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "CERT Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "CERT Value", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneCERTRecordValue" }, "x-displayname": "CERT Value.", "x-ves-example": "Values", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "values", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneCERTResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"cert_key_tag\": 0,\n \"certificate\": \"Ab100cFg\"\n }\n ]\n}", "example_yaml": "values:\n- cert_key_tag: 0\n certificate: Ab100cFg" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCERTType": { "type": "string", "description": "CERT type value must be compatible with the specified types.\n\n- INVALIDCERTTYPE: INVALIDCERTTYPE\n\n- PKIX: PKIX\n\n- SPKI: SPKI\n\n- PGP: PGP\n\n- IPKIX: IPKIX\n\n- ISPKI: ISPKI\n\n- IPGP: IPGP\n\n- ACPKIX: ACPKIX\n\n- IACPKIX: IACPKIX\n\n- URI_: URI\n\n- OID: OID.", "title": "CERT Type", "enum": [ "INVALIDCERTTYPE", "PKIX", "SPKI", "PGP", "IPKIX", "ISPKI", "IPGP", "ACPKIX", "IACPKIX", "URI_", "OID" ], "default": "INVALIDCERTTYPE", "x-displayname": "CERT Type", "x-ves-proto-enum": "ves.io.schema.dns_zone.CERTType", "x-f5xc-description-short": "CERT type value must be compatible with the specified types. - INVALIDCERTTYPE: INVALIDCERTTYPE - PKIX: PKIX - SPKI: SPKI - PGP: PGP - IPKIX...", "x-f5xc-description-medium": "CERT type value must be compatible with the specified types. - INVALIDCERTTYPE: INVALIDCERTTYPE - PKIX: PKIX - SPKI: SPKI - PGP: PGP - IPKIX: IPKIX - ISPKI: ISPKI - IPGP: IPGP - ACPKIX: ACPKIX - IACPKIX: IACPKIX - URI_: URI - OID: OID.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCERTType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALIDCERTTYPE\"", "example_yaml": "INVALIDCERTTYPE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCertificationAuthorityAuthorization": { "type": "object", "title": "CertificationAuthorityAuthorization", "x-displayname": "CertificationAuthorityAuthorization.", "x-ves-proto-message": "ves.io.schema.dns_zone.CertificationAuthorityAuthorization", "properties": { "flags": { "type": "integer", "description": "This flag should be an integer between 0 and 255.", "title": "Certification authority authorization flags", "format": "int64", "x-displayname": "Flags", "x-ves-example": "0", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-example": "0", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "0", "ves.io.schema.rules.uint32.lte": "255" }, "x-f5xc-description-short": "Flag should be an integer between 0 and 255.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 0, "maximum": 255, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tag": { "type": "string", "description": "Tag for categorization and filtering", "title": "Certification authority authorization tag", "x-displayname": "Tag", "x-ves-example": "Issue", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"issue\\\", \\\"issuewild\\\", \\\"iodef\\\"]" }, "x-f5xc-example": "issue", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"issue\\\", \\\"issuewild\\\", \\\"iodef\\\"]" }, "maxLength": 1024, "enum": [ "issue", "issuewild", "iodef" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "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": "Configuration parameter for value", "title": "Certification authority authorization value", "minLength": 1, "maxLength": 1024, "x-displayname": "Value", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "1024", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "1024", "ves.io.schema.rules.string.min_len": "1" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 1024, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCertificationAuthorityAuthorization", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCloneReq": { "type": "object", "description": "Clone Request.", "title": "Clone Request", "x-displayname": "Clone Request.", "x-ves-proto-message": "ves.io.schema.dns_zone.CloneReq", "properties": { "tenant": { "type": "string", "description": "Tenant for which DNS domain cloned.", "title": "Tenant name", "x-displayname": "Tenant name.", "x-f5xc-example": "customer-123", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCloneReq", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCloneResp": { "type": "object", "description": "Clone Response.", "title": "Clone Response", "x-displayname": "Response", "x-ves-proto-message": "ves.io.schema.dns_zone.CloneResp", "properties": { "failed_zones": { "type": "array", "description": "Zones failed.", "title": "Zones failed", "items": { "type": "string" }, "x-displayname": "Zones Failed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "success_zones": { "type": "array", "description": "Zones succeeded.", "title": "Zones succeeded", "items": { "type": "string" }, "x-displayname": "Zones Succeeded.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCloneResp", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of dns_zone", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.dns_zone.CreateRequest", "properties": { "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectCreateMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "spec": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "DNS zone for domain management and record configuration", "required_fields": [ "metadata.name", "metadata.namespace" ], "mutually_exclusive_groups": [ { "name": "dns_type", "fields": [ "spec.primary", "spec.secondary" ], "reason": "Choose primary or secondary zone type (REQUIRED)" } ], "example_yaml": "metadata:\n name: example.com\n namespace: system\nspec:\n primary: {}\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example.com\",\n \"namespace\": \"system\"\n },\n \"spec\": {\n \"primary\": {}\n }\n}\n" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.dns_zone.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/dns_zoneGetSpecType" } ], "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 dns_zoneCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneCreateSpecType": { "type": "object", "description": "Create DNS Zone in a given namespace. If one already exist it will give a error.", "title": "Create DNS Zone", "x-displayname": "Create DNS Zone.", "x-ves-oneof-field-dns_type": "[\"primary\",\"secondary\"]", "x-ves-proto-message": "ves.io.schema.dns_zone.CreateSpecType", "properties": { "primary": { "allOf": [ { "$ref": "#/components/schemas/dns_zonePrimaryDNSCreateSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "secondary" ] }, "secondary": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneSecondaryDNSCreateSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "primary" ] } }, "x-f5xc-description-short": "Create DNS Zone in a given namespace. If one already exist it will give a error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneCreateSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSAAAAResourceRecord": { "type": "object", "description": "RecordSet for AAAA Records.", "title": "DNSAAAAResourceRecord", "x-displayname": "DNSAAAAResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSAAAAResourceRecord", "properties": { "name": { "type": "string", "description": "AAAA Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "AAAA Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "AAAA Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "A valid IPv6 address, for example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334.", "title": "IPv6 addresses", "minItems": 1, "maxItems": 100, "items": { "type": "string" }, "x-displayname": "IPv6 Addresses.", "x-ves-example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv6": "true", "ves.io.schema.rules.repeated.max_items": "100", "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": 100, "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 dns_zoneDNSAAAAResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSAFSDBRecord": { "type": "object", "description": "DNS AFSDB Record.", "title": "DNSAFSDBRecord", "x-displayname": "DNS AFSDB Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSAFSDBRecord", "properties": { "name": { "type": "string", "description": "AFSDB Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "AFSDB Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "AFSDB Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "AFSDB Value", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneAFSDBRecordValue" }, "x-displayname": "AFSDB Value.", "x-ves-example": "Values", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "values", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSAFSDBRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"hostname\": \"mail.example.com\"\n }\n ]\n}", "example_yaml": "values:\n- hostname: mail.example.com" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSAResourceRecord": { "type": "object", "description": "A Records", "title": "DNSAResourceRecord", "x-displayname": "DNSAResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSAResourceRecord", "properties": { "name": { "type": "string", "description": "A Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "A valid IPv4 address, for example: 192.0.2.242.", "title": "IPv4 addresses", "minItems": 1, "maxItems": 100, "items": { "type": "string" }, "x-displayname": "IPv4 Addresses.", "x-ves-example": "192.0.2.242.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "192.0.2.242", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.ipv4": "true", "ves.io.schema.rules.repeated.max_items": "100", "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": 100, "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 dns_zoneDNSAResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSAliasResourceRecord": { "type": "object", "title": "DNSAliasResourceRecord", "x-displayname": "DNSAliasResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSAliasResourceRecord", "properties": { "value": { "type": "string", "description": "A valid domain name, for example: example.com.", "title": "Domain", "maxLength": 255, "x-displayname": "Domain", "x-ves-example": "example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 255, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSAliasResourceRecord", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSCAAResourceRecord": { "type": "object", "title": "DNSCAAResourceRecord", "x-displayname": "DNSCAAResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSCAAResourceRecord", "properties": { "name": { "type": "string", "description": "CAA Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "CAA Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "CAA Record Value", "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneCertificationAuthorityAuthorization" }, "x-displayname": "CAA Record Value.", "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-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 } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSCAAResourceRecord", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSCDSRecord": { "type": "object", "description": "DNS CDS Record.", "title": "DNSCDSRecord", "x-displayname": "DNS CDS Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSCDSRecord", "properties": { "name": { "type": "string", "description": "CDS Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "CDS Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "DS Value", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneDSRecordValue" }, "x-displayname": "DS Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSCDSRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"key_tag\": 1\n }\n ]\n}", "example_yaml": "values:\n- key_tag: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSCNAMEResourceRecord": { "type": "object", "title": "DNSCNAMEResourceRecord", "x-displayname": "DNSCNAMEResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSCNAMEResourceRecord", "properties": { "name": { "type": "string", "description": "CName Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "CName Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "CName Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Domain", "maxLength": 255, "x-displayname": "Domain", "x-ves-example": "example.com.", "x-ves-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "example.com", "x-validation-rules": { "ves.io.schema.rules.string.hostname": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 255, "format": "hostname", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSCNAMEResourceRecord", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"www or mail or * or corp.web or *.b\"\n}", "example_yaml": "name: www or mail or * or corp.web or *.b" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSDSRecord": { "type": "object", "description": "DNS DS Record.", "title": "DNSDSRecord", "x-displayname": "DNS DS Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSDSRecord", "properties": { "name": { "type": "string", "description": "DS Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "DS Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "DS Value", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneDSRecordValue" }, "x-displayname": "DS Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSDSRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"key_tag\": 1\n }\n ]\n}", "example_yaml": "values:\n- key_tag: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSDeploymentStatus": { "type": "string", "description": "Deployment Status of DNS Zone\n\nDNS Zone is successfully deployed and active\nDeployment of DNS Zone is pending\nDNS Zone has been disabled.\nDNS Zone deployment encountered an error.", "title": "DNS Zone Deployment Status", "enum": [ "DNS_ZONE_ACTIVE", "DNS_ZONE_PENDING", "DNS_ZONE_DISABLED", "DNS_ZONE_FAILED" ], "default": "DNS_ZONE_ACTIVE", "x-displayname": "DNS Zone Deployment Status.", "x-ves-proto-enum": "ves.io.schema.dns_zone.DNSDeploymentStatus", "x-f5xc-description-short": "Deployment Status of DNS Zone DNS Zone is successfully deployed and active Deployment of DNS Zone is pending DNS Zone has been disabled.", "x-f5xc-description-medium": "Deployment Status of DNS Zone DNS Zone is successfully deployed and active Deployment of DNS Zone is pending DNS Zone has been disabled. DNS Zone deployment encountered an error.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSDeploymentStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DNS_ZONE_ACTIVE\"", "example_yaml": "DNS_ZONE_ACTIVE\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSEUI48ResourceRecord": { "type": "object", "description": "DNS EUI48 Record.", "title": "DNSEUI48ResourceRecord", "x-displayname": "DNS EUI48 Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSEUI48ResourceRecord", "properties": { "name": { "type": "string", "description": "EUI48 Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "EUI48 Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "EUI48 Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "value": { "type": "string", "description": "A valid eui48 identifier, for example: 01-23-45-67-89-ab.", "title": "EUI48 Identifier", "minLength": 17, "maxLength": 17, "x-displayname": "EUI48 Identifier.", "x-ves-example": "01-23-45-67-89-ab.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "17", "ves.io.schema.rules.string.pattern": "^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$" }, "x-f5xc-example": "01-23-45-67-89-ab", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "17", "ves.io.schema.rules.string.min_len": "17", "ves.io.schema.rules.string.pattern": "^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 17, "maxLength": 17, "pattern": "^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$", "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 dns_zoneDNSEUI48ResourceRecord", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"01-23-45-67-89-ab\"\n}", "example_yaml": "value: 01-23-45-67-89-ab" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSEUI64ResourceRecord": { "type": "object", "description": "DNS EUI64 Record.", "title": "DNSEUI64ResourceRecord", "x-displayname": "DNS EUI64 Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSEUI64ResourceRecord", "properties": { "name": { "type": "string", "description": "EUI64 Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "EUI64 Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "EUI64 Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "value": { "type": "string", "description": "A valid EUI64 identifier, for example: 01-23-45-67-89-ab-cd-ef.", "title": "EUI64 Identifier", "minLength": 23, "maxLength": 23, "x-displayname": "EUI64 Identifier.", "x-ves-example": "01-23-45-67-89-ab-cd-ef.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "23", "ves.io.schema.rules.string.min_len": "23", "ves.io.schema.rules.string.pattern": "^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$" }, "x-f5xc-example": "01-23-45-67-89-ab-cd-ef", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_len": "23", "ves.io.schema.rules.string.min_len": "23", "ves.io.schema.rules.string.pattern": "^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 23, "maxLength": 23, "pattern": "^([0-9A-Fa-f]{2}-){7}([0-9A-Fa-f]{2})$", "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 dns_zoneDNSEUI64ResourceRecord", "required_fields": [ "value" ], "mutually_exclusive_groups": [], "example_json": "{\n \"value\": \"01-23-45-67-89-ab-cd-ef\"\n}", "example_yaml": "value: 01-23-45-67-89-ab-cd-ef" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSLBResourceRecord": { "type": "object", "description": "DNS Load Balancer Record.", "title": "DNSLBResourcerecord", "x-displayname": "DNS Load Balancer Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSLBResourceRecord", "properties": { "name": { "type": "string", "description": "Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.", "title": "Record Name", "maxLength": 255, "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-description-short": "Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.", "x-f5xc-description-medium": "Load Balancer record name (except for SRV DNS Load balancer record) should be a simple record name and not a subdomain of a subdomain.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 255, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "value": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "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-references": [ { "resource_kind": null, "field_path": "value", "gated_by": null, "required": false, "cardinality": "single" } ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSLBResourceRecord", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSLOCResourceRecord": { "type": "object", "description": "DNS LOC Record.", "title": "DNSLOCResourceRecord", "x-displayname": "DNS LOC Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSLOCResourceRecord", "properties": { "name": { "type": "string", "description": "LOC Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "LOC Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "LOC Values", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneLOCValue" }, "x-displayname": "LOC Value", "x-ves-example": "32 7 19 S 116 2 25 E 10m.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "32 7 19 S 116 2 25 E 10m", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSLOCResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"altitude\": -100000.0,\n \"latitude_degree\": 0,\n \"longitude_degree\": 0\n }\n ]\n}", "example_yaml": "values:\n- altitude: -100000.0\n latitude_degree: 0\n longitude_degree: 0" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSMXResourceRecord": { "type": "object", "title": "DNSMXResourceRecord", "x-displayname": "DNSMXResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSMXResourceRecord", "properties": { "name": { "type": "string", "description": "MX Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "MX Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "Value", "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneMailExchanger" }, "x-displayname": "MX Record Value.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100" }, "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": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSMXResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {}\n ]\n}", "example_yaml": "values:\n- {}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSNAPTRResourceRecord": { "type": "object", "description": "DNS NAPTR Record.", "title": "DNSNAPTRResourceRecord", "x-displayname": "DNS NAPTR Record.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSNAPTRResourceRecord", "properties": { "name": { "type": "string", "description": "NAPTR Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or ww* or *ab.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-example": "www or mail or * or ww* or *ab", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "x-f5xc-description-short": "NAPTR Record name, please provide only the specific subdomain or record name without the base domain.", "x-f5xc-description-medium": "NAPTR Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([a-zA-Z0-9*?]|([a-zA-Z0-9?*]+-[a-zA-Z0-9*?]+)){0,253}" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "NAPTR Values", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneNAPTRValue" }, "x-displayname": "NAPTR Value.", "x-ves-example": "Values", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "values", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSNAPTRResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n {\n \"flags\": \"\\\"\\\"\",\n \"order\": 0,\n \"preference\": 0\n }\n ]\n}", "example_yaml": "values:\n- flags: '\"\"'\n order: 0\n preference: 0" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSNSResourceRecord": { "type": "object", "title": "DNSNSResourceRecord", "x-displayname": "DNSNSResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSNSResourceRecord", "properties": { "name": { "type": "string", "description": "NS Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.we\" or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "\"www or mail or * or corp.we\" or *.b\"", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "NS Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "Name-servers", "minItems": 1, "maxItems": 100, "items": { "type": "string" }, "x-displayname": "Name Servers.", "x-ves-example": "ns1.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "ns1.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.max_items": "100", "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": 100, "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 dns_zoneDNSNSResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSPTRResourceRecord": { "type": "object", "title": "DNSPTRResourceRecord", "x-displayname": "DNSPTRResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSPTRResourceRecord", "properties": { "name": { "type": "string", "description": "PTR Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "PTR Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "Domain names", "minItems": 1, "maxItems": 100, "items": { "type": "string" }, "x-displayname": "Domain Name.", "x-ves-example": "www.example.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "www.example.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.hostname": "true", "ves.io.schema.rules.repeated.max_items": "100", "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": 100, "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 dns_zoneDNSPTRResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSSECMode": { "type": "object", "title": "DNSSEC Mode Disable", "x-displayname": "Disable", "x-ves-oneof-field-mode": "[\"disable\",\"enable\"]", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSSECMode", "properties": { "disable": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "enable" ] }, "enable": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneDNSSECModeEnable" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSSECMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSSECModeEnable": { "type": "object", "description": "DNSSEC enable.", "title": "Enable", "x-displayname": "Enable", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSSECModeEnable", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSSECModeEnable", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSSECStatus": { "type": "object", "description": "DNSSEC details.", "title": "DNSSEC", "x-displayname": "DNSSEC", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSSECStatus", "properties": { "ds_records": { "type": "array", "title": "DNSSEC DS Records", "items": { "$ref": "#/components/schemas/dns_zoneDSRecord" }, "x-displayname": "DS Records.", "description": "Configuration parameter for ds records", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "mode": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneDNSSECMode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSSECStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSSRVResourceRecord": { "type": "object", "title": "DNSSRVResourceRecord", "x-displayname": "DNSSRVResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSSRVResourceRecord", "properties": { "name": { "type": "string", "description": "SRV Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$" }, "x-f5xc-description-short": "SRV Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^([*]|[a-zA-Z0-9-_]{1,63})([.][a-zA-Z0-9-_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "SRV Value", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/dns_zoneSRVService" }, "x-displayname": "SRV Value", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 100, "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 dns_zoneDNSSRVResourceRecord", "required_fields": [ "name", "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"www or mail or * or corp.web or *.b\",\n \"values\": [\n {}\n ]\n}", "example_yaml": "name: www or mail or * or corp.web or *.b\nvalues:\n- {}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSTXTResourceRecord": { "type": "object", "title": "DNSTXTResourceRecord", "x-displayname": "DNSTXTResourceRecord.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSTXTResourceRecord", "properties": { "name": { "type": "string", "description": "TXT Record name, please provide only the specific subdomain or record name without the base domain.", "title": "Record Name", "x-displayname": "Record Name (Excluding Domain name)", "x-ves-example": "Www or mail or * or corp.web or *.b.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-example": "www or mail or * or corp.web or *.b", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "x-f5xc-description-short": "TXT Record name, please provide only the specific subdomain or record name without the base domain.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^$|^([*]|[a-zA-Z0-9-/_]{1,63})([.][a-zA-Z0-9-/_]{1,63})*$" }, "values": { "type": "array", "description": "Configuration parameter for values", "title": "Text", "minItems": 1, "maxItems": 100, "items": { "type": "string", "maxLength": 4000 }, "x-displayname": "Text", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "4000", "ves.io.schema.rules.repeated.max_items": "100", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.repeated.items.string.max_len": "4000", "ves.io.schema.rules.repeated.max_items": "100", "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": 100, "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 dns_zoneDNSTXTResourceRecord", "required_fields": [ "values" ], "mutually_exclusive_groups": [], "example_json": "{\n \"values\": [\n \"value\"\n ]\n}", "example_yaml": "values:\n- value" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDNSZoneStatus": { "type": "object", "description": "Status DNS Zone.", "title": "DNS Zone Status", "x-displayname": "DNS Zone Status.", "x-ves-proto-message": "ves.io.schema.dns_zone.DNSZoneStatus", "properties": { "deployment_status": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneDNSDeploymentStatus" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "dnssec": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneDNSSECStatus" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "volterra_nameservers": { "type": "array", "description": "Status of DNS domain verification process.", "title": "F5XC Nameservers", "items": { "type": "string" }, "x-displayname": "F5XC Nameservers.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Status of DNS domain verification process.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDNSZoneStatus", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDSKeyAlgorithm": { "type": "string", "description": "DS key value must be compatible with the specified algorithm.\n\n- UNSPECIFIED: UNSPECIFIED\n\n- RSASHA1: RSASHA1\n\n- RSASHA1NSEC3SHA1: RSASHA1-NSEC3-SHA1\n\n- RSASHA256: RSASHA256\n\n- RSASHA512: RSASHA512\n\n- ECDSAP256SHA256: ECDSAP256SHA256\n\n- ECDSAP384SHA384: ECDSAP384SHA384\n\n- ED25519: ED25519\n\n- ED448: ED448.", "title": "DS Key Algorithm", "enum": [ "UNSPECIFIED", "RSASHA1", "RSASHA1NSEC3SHA1", "RSASHA256", "RSASHA512", "ECDSAP256SHA256", "ECDSAP384SHA384", "ED25519", "ED448" ], "default": "UNSPECIFIED", "x-displayname": "DS Key algorithm.", "x-ves-proto-enum": "ves.io.schema.dns_zone.DSKeyAlgorithm", "x-f5xc-description-short": "DS key value must be compatible with the specified algorithm. - UNSPECIFIED: UNSPECIFIED - RSASHA1: RSASHA1 - RSASHA1NSEC3SHA1: RSASHA1-NSEC3-SHA1...", "x-f5xc-description-medium": "DS key value must be compatible with the specified algorithm. - UNSPECIFIED: UNSPECIFIED - RSASHA1: RSASHA1 - RSASHA1NSEC3SHA1: RSASHA1-NSEC3-SHA1 - RSASHA256: RSASHA256 - RSASHA512: RSASHA512 - ECDSAP256SHA256: ECDSAP256SHA256 - ECDSAP384SHA384: ECDSAP384SHA384 - ED25519: ED25519 - ED448: ED448.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDSKeyAlgorithm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNSPECIFIED\"", "example_yaml": "UNSPECIFIED\n..." }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDSRecord": { "type": "object", "description": "DNSSEC Record details.", "title": "DS Record", "x-displayname": "DS Record", "x-ves-proto-message": "ves.io.schema.dns_zone.DSRecord", "properties": { "algorithm": { "type": "string", "description": "DNSSEC Algorithm\nhttps://datatracker.ietf.org/doc/HTML/rfc2535#section-3.2.", "title": "DNSSEC Algorithm", "x-displayname": "DNSSEC Algorithm.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "DNSSEC Algorithm https://datatracker.ietf.org/doc/HTML/rfc2535#section-3.2.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "digest": { "type": "string", "description": "DNSSEC Digest https://datatracker.ietf.org/doc/HTML/rfc4034#section-5.1.4.", "title": "DNSSEC Digest", "x-displayname": "DNSSEC Digest.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "DNSSEC Digest https://datatracker.ietf.org/doc/HTML/rfc4034#section-5.1.4.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "digest_type": { "type": "string", "description": "DNSSEC Digest Type\nhttps://datatracker.ietf.org/doc/HTML/rfc4034#appendix-A.2.", "title": "DNSSEC Digest Type", "x-displayname": "DNSSEC Digest Type.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "DNSSEC Digest Type https://datatracker.ietf.org/doc/HTML/rfc4034#appendix-A.2.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "flags": { "type": "integer", "description": "DNSSEC Flags https://datatracker.ietf.org/doc/HTML/rfc4034#section-2.1.1.", "title": "DNSSEC Flags", "format": "int64", "x-displayname": "DNSSEC Flags.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "DNSSEC Flags https://datatracker.ietf.org/doc/HTML/rfc4034#section-2.1.1.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "key_tag": { "type": "integer", "description": "DNSSEC Key Tag https://datatracker.ietf.org/doc/HTML/rfc2535#section-3.2.", "title": "DNSSEC Key Tag", "format": "int64", "x-displayname": "DNSSEC Key Tag.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "DNSSEC Key Tag https://datatracker.ietf.org/doc/HTML/rfc2535#section-3.2.", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "public_key": { "type": "string", "description": "DNSSEC Public Key https://datatracker.ietf.org/doc/HTML/rfc4034#section-2.", "title": "DNSSEC Public Key", "x-displayname": "DNSSEC Public Key.", "x-f5xc-description-short": "DNSSEC Public Key https://datatracker.ietf.org/doc/HTML/rfc4034#section-2.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "crypto", "maxLength": 1024, "minLength": 100, "pattern": "^-----BEGIN (RSA |EC |)?(PRIVATE |PUBLIC )?KEY-----\\n.*\\n-----END (RSA |EC |)?(PRIVATE |PUBLIC )?KEY-----$", "format": "pem", "byteLength": { "min": 100, "max": 5242880 }, "validation": { "standard": "PEM" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ttl": { "type": "integer", "description": "DNSSEC TTL https://datatracker.ietf.org/doc/HTML/rfc4034#section-5.1.4.", "title": "DNSSEC TTL", "format": "int64", "x-displayname": "DNSSEC TTL.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.lte": "2147483647" }, "x-f5xc-example": "300", "x-f5xc-description-short": "DNSSEC TTL https://datatracker.ietf.org/doc/HTML/rfc4034#section-5.1.4.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "maximum": 2147483647, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDSRecord", "required_fields": [ "algorithm", "digest", "digest_type", "flags", "key_tag", "ttl" ], "mutually_exclusive_groups": [], "example_json": "{\n \"algorithm\": \"value\",\n \"digest\": \"value\",\n \"digest_type\": \"value\",\n \"flags\": 0,\n \"key_tag\": 0,\n \"ttl\": 0\n}", "example_yaml": "algorithm: value\ndigest: value\ndigest_type: value\nflags: 0\nkey_tag: 0\nttl: 0" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDSRecordValue": { "type": "object", "title": "DSRecordValue", "x-displayname": "DSRecordValue.", "x-ves-oneof-field-digest_choice": "[\"sha1_digest\",\"sha256_digest\",\"sha384_digest\"]", "x-ves-proto-message": "ves.io.schema.dns_zone.DSRecordValue", "properties": { "ds_key_algorithm": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneDSKeyAlgorithm" } ], "x-f5xc-description-short": "Configuration parameter for ds key algorithm.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "key_tag": { "type": "integer", "description": "A short numeric value which can help quickly identify the referenced DNSKEY-record.", "title": "Key Tag", "format": "int64", "x-displayname": "Key Tag", "x-ves-example": "15228", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-example": "15228", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "65535" }, "x-f5xc-description-short": "Short numeric value which can help quickly identify the referenced DNSKEY-record.", "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 65535, "deterministic": true, "metadata": { "source": "api-probed", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "sha1_digest": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneSHA1Digest" } ], "x-f5xc-description-short": "Configuration parameter for sha1 digest.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sha256_digest", "sha384_digest" ] }, "sha256_digest": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneSHA256Digest" } ], "x-f5xc-description-short": "Configuration parameter for sha256 digest.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sha1_digest", "sha384_digest" ] }, "sha384_digest": { "allOf": [ { "$ref": "#/components/schemas/dns_zoneSHA384Digest" } ], "x-f5xc-description-short": "Configuration parameter for sha384 digest.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "sha1_digest", "sha256_digest" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for dns_zoneDSRecordValue", "required_fields": [ "key_tag" ], "mutually_exclusive_groups": [], "example_json": "{\n \"key_tag\": 1\n}", "example_yaml": "key_tag: 1" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a dns_zone", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.dns_zone.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 dns_zoneDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "dns", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": true }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "DNS zone management requires platform-level access" }, "classification": { "category": "networking", "multi_tenant_pattern": "none" } } }, "dns_zoneDnsZoneMetricsRequest": { "type": "object", "title": "Dns Zone Metrics Request", "x-displayname": "DNS Zone Metrics Request.", "x-ves-proto-message": "ves.io.schema.dns_zone.DnsZoneMetricsRequest", "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 } }, "filter": { "type": "string", "description": "Filter is used to specify the list of matchers\nsyntax for filter := {[]}\n :=